For AI agents: the complete documentation index is available at /runlab/llms.txt, the full documentation bundle is available at /runlab/llms-full.txt, and this page is available as Markdown at /runlab/reference/cli.md.

CLI Reference

Use the running binary as the exact command source:

runlab --help
runlab COMMAND --help
runlab COMMAND SUBCOMMAND --help

The public command families are:

CommandResponsibility
docsRead version-matched Markdown without opening State.
vmManage the fixed macOS Linux VM.
imageImport, inspect, list, and export OCI Images.
filesystemRead paths or changes from an Image or Final Environment.
execExecute synchronously without creating a persistent Run.
runGenerate configuration and create, inspect, cancel, reconcile, or delete persistent Runs.
observationRegister immutable Observation Types and append, correct, or retract terminal-Run Observations.
schemaDiscover public SQL Relations and their columns.
queryExecute one bounded read-only SQL statement.
storageInspect State usage and explicitly check or apply safe pruning.

Read commands do not execute, synchronize, repair, reconcile, or mutate State. Commands that permanently delete Run assets or reclaim storage use explicit check/apply workflows.

On macOS, vm config get returns the normalized complete share declaration. vm config check --document FILE validates it and reports derived Guest paths, warnings, required changes, and whether the stopped VM can accept it. vm config apply --document FILE replaces the declaration only while the VM is stopped. Each input share contains only name and a macOS directory host_path; the output derives guest_path, type: "virtiofs", and read_only: true.