Appearance
CLI Reference
The OS entry point is culsma-os. The independent language entry point is culsma. Use culsma-os COMMAND --help for the installed command syntax.
| Command | Purpose |
|---|---|
run INPUT... | Execute through the OS in the foreground and exit. Default driver: opentrons-simulator. |
serve | Start a persistent local host with one worker. |
submit SOURCE | Admit a program to an existing host and return its run ID. |
runs | List saved queue entries and their current run states. |
status RUN_ID | Inspect one saved run. |
pause RUN_ID, resume RUN_ID, cancel RUN_ID | Request execution control. |
host-status | Inspect host readiness and blocking information. |
device-status | Inspect recorded device and station state. |
host-stop | Request resident shutdown. |
driver-run INPUT... | Direct driver diagnostic path; default driver is stub. It is not the full OS execution path. |
Run and Serve Options
| Option | Applies to | Meaning |
|---|---|---|
--driver | run, serve | Select an installed external plugin. |
--driver-config PATH | run, serve | Fixed device/deck configuration. |
--workspace-config PATH | run, serve | Per-program binding and routing profiles. |
--station-id ID | run, serve | Stable station identity. |
--host-db PATH | run, serve | Persistent run database; required for serve. |
--artifacts-dir PATH | run, serve | Artifact root; run defaults to run-artifacts. |
--socket PATH | serve | Required local Unix-domain socket. |
--material-state PATH | run, submit | Initial material-state input. |
--library-root PATH | run, submit | Additional import root; may be repeated. |
--inventory-check PATH | run | Inventory input for the language pipeline. |
run accepts multiple input paths. submit accepts one source path and requires --socket. Its optional --request-id permits an explicit submission identity; reusing it for a different request is a conflict, not another run.
Control Targets
status, pause, resume and cancel require exactly one of --socket PATH or --host-db PATH. Resident controls use the socket. A one-shot controller may also need the original driver, configuration, artifact root and station identity.
runs, host-status, device-status and host-stop require --socket. They return JSON. Control acceptance and protocol completion are separate outcomes.
Exit Status
Foreground run returns 0 when output.ok is true and 1 otherwise. Command/configuration errors commonly return 2. Successful resident requests return 0 even when the returned run state is not completed; inspect the JSON status.