Skip to content

CLI Reference

The rigs CLI manages local servers, workflows, pipelines, and network connections.

Tip: run rigs --help or rigs <group> --help to see all options.

Server Commands

rigs server add --name "My GPU" --url http://127.0.0.1:8188 --api-key "" --default
rigs server list
rigs server test <server-id>
rigs server upload <server-id> /path/to/file --subfolder audio

Workflow Commands

rigs workflow import /path/to/workflow_api.json --server <server-id> --title "My Workflow" --emoji "🖼️"
rigs workflow list
rigs workflow inspect <workflow-id>
rigs workflow set-primary <workflow-id> <node-id>
rigs workflow run <workflow-id> --input "13.text:prompt" --wait
rigs workflow status <workflow-id> <prompt-id>
rigs workflow publish <workflow-id>
rigs workflow unpublish <workflow-id>

Template Commands

rigs template save --name "cinematic" --workflow <workflow-id> --input "13.text:neon"
rigs template list --workflow <workflow-id>
rigs template run <template-id> --wait

Pipeline Commands

rigs pipeline save demo --steps "<wf-id>:13.text=storm" --steps "<wf-id2>:7.seed=42"
rigs pipeline run --steps "<wf-id>:13.text=storm" --wait
rigs pipeline list

rigs gallery list --workflow <workflow-id> --limit 10
rigs gallery download <output-id> --output ./result.png
rigs gallery delete <output-id>

Network Commands

rigs network connect --gateway https://rigs.run --key ccn_sk_...

Gateway (Self‑Host)

rigs gateway start --host 0.0.0.0 --port 8788
rigs gateway key create --label "admin"
rigs gateway key list