Renderer commands
Talk to the local renderer: Cycles stills from a GLB, and film jobs.
These commands talk to the local renderer on your own machine. Read Rendering for setting it up.
puni rendererTalk to the local renderer: Cycles stills from a GLB, and film jobs.
| Command | What it does |
|---|---|
puni renderer health | Ask the local renderer whether it is running and what it has. |
puni renderer submit | Queue a Cycles still of an existing GLB. Success means admitted, not finished. |
puni renderer status | Read a job's state. |
puni renderer cancel | Cancel a queued or running job. |
puni renderer retry | Retry a failed or cancelled still as a new job. |
puni renderer download | Download a finished job's file after checking the receipt's checksum. |
#renderer health
Ask the local renderer whether it is running and what it has.
puni renderer health
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--bridge-url | string | http://127.0.0.1:4317 | The local renderer's loopback origin. | |
--timeout | number | 120000 | Deadline for the whole operation in milliseconds, 1 to 1800000. | |
--json | boolean | false | Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope. | |
--help -h | boolean | Print the command list. |
#Run renderer health
puni renderer health --json#renderer submit
Queue a Cycles still of an existing GLB. Success means admitted, not finished.
puni renderer submit --file model.glb --settings settings.json
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--file required | string | A GLB of 20 bytes to 64 MB with no external references. | ||
--settings required | string | Render settings JSON; unitScale is required. | ||
--bridge-url | string | http://127.0.0.1:4317 | The local renderer's loopback origin. | |
--timeout | number | 120000 | Deadline for the whole operation in milliseconds, 1 to 1800000. | |
--json | boolean | false | Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope. | |
--help -h | boolean | Print the command list. |
#Run renderer submit
puni renderer submit --file model.glb --settings settings.json --json#renderer status
Read a job's state.
puni renderer status JOB_ID [--kind film]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--kind | string | film | Read a film job instead of a still. | |
--bridge-url | string | http://127.0.0.1:4317 | The local renderer's loopback origin. | |
--timeout | number | 120000 | Deadline for the whole operation in milliseconds, 1 to 1800000. | |
--json | boolean | false | Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope. | |
--help -h | boolean | Print the command list. |
#Run renderer status
puni renderer status 6f1c… --json#renderer cancel
Cancel a queued or running job.
puni renderer cancel JOB_ID [--kind film]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--kind | string | film | Cancel a film job instead of a still. | |
--bridge-url | string | http://127.0.0.1:4317 | The local renderer's loopback origin. | |
--timeout | number | 120000 | Deadline for the whole operation in milliseconds, 1 to 1800000. | |
--json | boolean | false | Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope. | |
--help -h | boolean | Print the command list. |
#Run renderer cancel
puni renderer cancel 6f1c… --json#renderer retry
Retry a failed or cancelled still as a new job.
puni renderer retry JOB_ID
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--bridge-url | string | http://127.0.0.1:4317 | The local renderer's loopback origin. | |
--timeout | number | 120000 | Deadline for the whole operation in milliseconds, 1 to 1800000. | |
--json | boolean | false | Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope. | |
--help -h | boolean | Print the command list. |
#Run renderer retry
puni renderer retry 6f1c… --json#renderer download
Download a finished job's file after checking the receipt's checksum.
puni renderer download JOB_ID --artifact output.png --output still.png [--kind film]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--artifact | string | output.png, output.blend, output.mp4 or frame-NNNNNN.png from the receipt; with --kind film only output.mp4. Defaults to output.png, or output.mp4 for a film. | ||
--output required | string | Where to write the file. | ||
--kind | string | film | Download a film instead of a still. | |
--bridge-url | string | http://127.0.0.1:4317 | The local renderer's loopback origin. | |
--timeout | number | 120000 | Deadline for the whole operation in milliseconds, 1 to 1800000. | |
--overwrite | boolean | false | Replace the output file if it already exists. | |
--json | boolean | false | Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope. | |
--help -h | boolean | Print the command list. |
#Run renderer download
puni renderer download 6f1c… --artifact output.png --output still.png --jsonBack to the command line index for every group.
Was this useful?