Command line

Every command group in puni, the flags they share, how remote commands name their origin, and where the exit codes are.

Preview

The command line is a preview for Puni's own team. It builds from Puni's private repository and is not published to npm, so you can run it only with access to that repository. An agent reaches your library without it through Connect Puni.

puni prints a readable answer by default. With --json, commands return one JSON envelope except agent serve, which streams lifecycle records before its final envelope. Start with the Quickstart if this is your first session, or Setup for requirements, credentials and exit codes.

#Find a command

puni --help

Group	Reference
Local scenes	scene, checkpoint, interface, studies, contract
Drawing and making	render, renderer, sculpt
Your library	auth, project, search, runtime
Agents	agent
Mono	mono

#Common flags

puni project list --base-url https://puni.design
puni project list --base-url https://puni.design --json

--json gives one { "data", "meta" } object on success or one { "error" } object on failure. agent serve --json is the exception: parse stdout one line at a time as NDJSON, with raw lifecycle records followed by the final envelope. See Agent commands. --help prints the whole command list. File inputs accept - for standard input, once per command.

#Remote commands

Every command that talks to your library takes --base-url https://puni.design. Writes name the revision they expect with --revision N and are refused if the library moved on. Tokens come from puni auth login, PUNI_AUTH_TOKEN, or --auth-file.

#Files

Commands that write a file take --output. Replacing an existing file needs --overwrite. Writes are prepared and checked before the file is published, so a failure never leaves a half-written scene.

Read Setup for the exit codes.

Auth commandsPreviewSign a machine in to your library and keep its token.Scene commandsPreviewMake, inspect, edit, evaluate and validate a scene as a file.Project commandsPreviewYour library: list, pull, push, rename, archive, checkpoints, covers and links.Render commandsPreviewDraw a scene file with the studio's own renderer: a PNG, a GLB, a USDZ, or a film.Renderer commandsPreviewTalk to the local renderer: Cycles stills from a GLB, and film jobs.Search commandsPreviewFind scenes by name and description, and manage what semantic search knows.Checkpoint commandsPreviewKeep and restore a scene file with its assets and checksums.Agent commandsPreviewDeliver a turn to a connected runner, host its turns on your own machine, and read what each turn saved.Interface commandsPreviewTurn a Paper layout into an interface object.Studies commandsPreviewThe starting scenes `scene create` can begin from.Runtime commandsPreviewCheck that this build of the command line matches the studio.Contract commandsPreviewPrint the command and type contract a scene is made of.Sculpt commandsPreviewSculpt from consistent reference views, retain the provider master, and derive a scene-ready mesh.Mono commandsPreviewPuni's own agent runtime, embedded in the command line: a session that can look at a scene before it answers.

Was this useful?