CLI overview - Clayzo

clayzo <command> [input] [output] [options]

Command	What it does	Sign in
`init`	Install the Clayzo packages and agent skills in a project	No
`preview`	Serve a browser page that plays a document and exports on the GPU	Yes
`render-frame`	Render one frame, a labelled sheet of frames, or the loop seam	Yes
`review`	Write a revision-bound review packet	Yes
`package`	Build a portable `.clayzo` bundle	Yes
`export`	Export MP4, MOV, GIF, WebM, WebP or a PNG sequence	Yes
`doctor`	Show what’s installed, sign in, and what is behind	No
`update`	Update the CLI, the project’s packages and the skills together	No
`login`	Authorize this device through the browser	—
`logout`	Revoke and remove locally stored credentials	—
`token create`	Create a revocable CI token, printed once	Yes
`token list`	List CI token names, prefixes and status	Yes
`token revoke`	Revoke a CI token by id	Yes

Conventions

Help. clayzo <command> --help prints that command’s usage without reading, fetching or authenticating anything. clayzo --version prints the version.
Input first, output second. The document path comes first; the output path, where there is one, second; options after.
Ticks. Every time option is in ticks, the document’s own time base. At the conventional 240 ticks per second and 30 fps, one frame is 8 ticks.
Structured output. Commands print a JSON result on stdout. Progress and notices go to stderr, prefixed [clayzo], so stdout stays parseable. Errors are JSON objects with a code such as CLAYZO_AUTH_REQUIRED.
Exit codes. 0 on success, 1 on an error, 2 when the CLI version is below the minimum the service supports or an update is required.
Sizes. --max-dimension <px> bounds the longer side of a render; --full-resolution renders at the document’s size. The two conflict.

Environment variables

Variable	Effect
`CLAYZO_TOKEN`	A CI token; used instead of stored credentials when set
`CLAYZO_CONFIG_DIR`	Where credentials are stored
`NO_UPDATE_NOTIFIER`	Turns off update notices and the offer to update

Updates

Every command prints a one-line notice on stderr when the CLI, the project’s packages or the skills are behind the current release. clayzo update updates them together. See doctor and update.

​Conventions

​Environment variables

​Updates

Conventions

Environment variables

Updates