// Command reference
simforge factory
Generated from the CLI's own help (CLI 0.2.0-rc.6). Global flags and exit codes are on the reference index.
simforge factory batch
Submit every row of a JSON or YAML file as its own run, priced and confirmed once; running the same file again submits nothing new
simforge factory batch [OPTIONS] <FILE>
| Argument / flag | Notes | What |
|---|---|---|
| <file> | required | The rows: a JSON or YAML list (or an object with rows), each a scenario clip run or a raw generation |
| --yes | Start without asking (the total is still shown); needed when nothing can prompt | |
| --wait | Wait until every row's clips are done |
simforge factory clip cancel
Cancel a Factory run or raw generation; clips already accepted stay charged
simforge factory clip cancel [OPTIONS] <ID>
| Argument / flag | Notes | What |
|---|---|---|
| <id> | required | The run id (run_...) of a Factory run or a raw generation |
simforge factory clip create
Make clips of scenarios (--scenario or --dataset, with --look or --prompt), or one raw generation from your own control videos (--raw); priced and confirmed first
simforge factory clip create [OPTIONS]
| Argument / flag | Notes | What |
|---|---|---|
| --scenario ID | repeatable | A scenario to make clips of (repeatable) |
| --dataset ID | Every scenario of this dataset of yours | |
| --look ID | repeatable | A look from simforge factory looks (repeatable). Exactly one of --look and --prompt |
| --prompt TEXT | Your own conditions in place of a look, sent as written; with --raw, the request's overall prompt | |
| --camera-prompt CAMERA=TEXT | repeatable | One camera's whole prompt, as CAMERA=TEXT (repeatable). A raw generation needs one for every camera |
| --camera CAMERA | repeatable | A camera to generate (repeatable): any of the 4-camera rig for scenario clips (default all four), or with --raw each camera you give a control video, in your order |
| --seed N | repeatable | The generator's seed (repeatable for scenario clips: a clip per seed; one with --raw). Default: derived from the request, so the same request makes the same clip |
| --seeds-per-look N | Clips per scenario and look, each on its own seed (default 1). Not with --seed | |
| --mode MODE | one of positions, simulator | positions: the generator sees the layout and the prompts; simulator: also each camera's first frame, so the clip keeps its lighting |
| --steps N | Denoising steps (fixed at 4 by the model) | |
| --guidance SCALE | Guidance scale (fixed at 1 by the model) | |
| --frames N | Frames per camera (a scenario clip is fixed at 601 generated, 600 kept: 20 s at 30 fps; with --raw, default the server's own) | |
| --fps FPS | Frame rate (a scenario clip is fixed at 30 fps) | |
| --resolution BUCKET | The generator's resolution bucket (fixed at 480 by the model) | |
| --aspect W,H | The output's aspect bucket, as W,H (16,9 is 832x480; a scenario clip is fixed at 16,9; with --raw, default the bucket closest to the first control video) | |
| --condition-video-as-image BOOL | one of true, false | Whether a vision image conditions as one image (fixed at true by the model) |
| --negative-prompt TEXT | A negative prompt (the model takes none) | |
| --model MODEL | The model variant (one is deployed: simforge factory params names it) | |
| --raw | One raw generation from your own control videos: no scenario, no labels, no check, charged whatever it shows | |
| --control CAMERA=FILE | repeatable | With --raw: a camera's control (layout) video, as CAMERA=FILE.mp4 (repeatable, one per camera) |
| --vision CAMERA=FILE | repeatable | With --raw in simulator mode: a camera's first frame, as CAMERA=FILE.png or .jpg (repeatable, one per camera) |
| --from-request FILE | With --raw: a request.json used with a local Sim-Auto server (or one a generation delivered), sent as it is; its files are read beside it | |
| --max-cost-cents CENTS | The most this may charge, in cents. Default: its quote | |
| --yes | Start without asking (the quote is still shown); needed when nothing can prompt | |
| --wait | Wait until every clip is done, as simforge factory clip wait |
simforge factory clip download
Download a run's delivered clips or a raw generation's files, with a manifest of signed links (sha256-checked, resumable)
simforge factory clip download [OPTIONS] <ID>
| Argument / flag | Notes | What |
|---|---|---|
| <id> | required | The run id (run_...) of a Factory run or a raw generation |
| --out OUT | default . | The folder to download into: the files go under OUT/<id>/. Default: the current folder |
| --links-only | Write only OUT/<id>/manifest.json, the signed link, sha256 and size of every file, and download nothing |
simforge factory clip get
One Factory run or raw generation: each clip's status, verdict, prompt, waiting message, warnings and cost
simforge factory clip get [OPTIONS] <ID>
| Argument / flag | Notes | What |
|---|---|---|
| <id> | required | The run id (run_...) of a Factory run or a raw generation |
simforge factory clip list
Your Factory runs and raw generations, newest first, with their clip counts and status
simforge factory clip list [OPTIONS]
| Argument / flag | Notes | What |
|---|---|---|
| --limit LIMIT | default 20 | At most this many, newest first |
simforge factory clip retry
Make a run's failed, cancelled or flagged clips again, or a failed or cancelled raw generation; priced and confirmed first
simforge factory clip retry [OPTIONS] <ID>
| Argument / flag | Notes | What |
|---|---|---|
| <id> | required | The run id (run_...) of a Factory run or a raw generation |
| --flagged | Retry the run's flagged clips, on new seeds | |
| --failed | Retry the run's failed clips, on their own seeds | |
| --cancelled | Retry the run's cancelled clips, on their own seeds | |
| --max-cost-cents CENTS | The most the retry may charge, in cents. Default: its quote | |
| --yes | Start without asking (the quote is still shown); needed when nothing can prompt |
simforge factory clip wait
Wait until every clip of a run (or a raw generation) is done, showing what each waits for; exits non-zero when any failed
simforge factory clip wait [OPTIONS] <ID>
| Argument / flag | Notes | What |
|---|---|---|
| <id> | required | The run id (run_...) of a Factory run or a raw generation |
simforge factory looks
The looks a scenario clip can be made with (an experimental look may not apply well)
simforge factory looks [OPTIONS]
simforge factory params
Every generator parameter: what a scenario clip and a raw generation may set, what is fixed and why, and what one raw generation costs
simforge factory params [OPTIONS]