3.4 KiB
3.4 KiB
CLI reference
Run ./scripts/uh COMMAND --help or the installed uh COMMAND --help. All paths are explicit;
run/output directories must be new where the command creates an artifact. This table lists every
public command and its named options (excluding automatic --help). Layout tests compare it to
the actual argparse parser; change the table with the interface.
| Command | Named options | Purpose / positional inputs |
|---|---|---|
list |
— | Registered task metadata |
doctor |
— | Installed backend, locked core versions and CUDA |
verify-vendor |
— | Checked-in source/asset inventory |
check-robot |
--config --output --steps --spec |
Robot interface/mechanics/contact gate |
assets |
— | Discover explicitly configured optional external assets |
inspect-asset |
— | Native MJCF compile; positional model path |
plan |
--config |
Resolve experiment metadata without simulation |
rewards |
--config |
Resolve reward functions/weights/parameters |
smoke |
--config --steps --num-envs |
Bounded zero-action GPU probe |
train |
--config --resume --iterations --background --output |
PPO or additional updates from a committed checkpoint |
pipeline |
--config --output --eval-steps --eval-envs |
Bounded train/evaluate/export sequence |
evaluate |
--checkpoint --output --steps --num-envs --command --video --seed --profile --measure |
Fixed-command evaluation with optional measurement/video |
play |
--checkpoint --viewer --measure --steps --seed --profile --command --video |
Interactive viewer, or bounded headless measured replay |
status |
— | Positional run directory; progress and process state |
stop |
— | Positional background run directory; guarded graceful stop |
checkpoints |
— | Positional run directory; committed checkpoint inventory |
curves |
--output --match --window |
Positional run directory; TensorBoard JSON/CSV/SVG |
benchmark |
--checkpoints --output --seeds --profiles --steps --num-envs |
Checkpoint × evaluation-seed × command × profile matrix |
select-checkpoint |
--output --metric |
Positional completed matrix summary; explicit-metric ranking |
export |
--checkpoint --evaluation --output |
Research-only ONNX bundle |
verify-bundle |
--inference |
Positional bundle; integrity and optional inference parity |
compare |
— | Positional baseline/candidate reports or single-checkpoint matrix summaries |
Important semantics
doctor,verify-vendorandcheck-robotfailures give a nonzero exit. A failed robot gate writes its JSON report; a model construction failure cannot provide downstream dynamic checks.--iterationson resume is additional updates; it is not the target total update index.benchmark --seedssets evaluation randomness, not independent training runs.play --measureselects bounded headless replay. Its seed/profile/command/steps/video options describe that mode; ordinaryplay --vieweris the interactive viewer path.- Default evaluation profile is randomized; stress adds configured observation noise and velocity kicks. Nominal fixed replicas do not become independent samples merely by increasing worlds.
- Backend diagnostics may accompany JSON on stdout. Read generated JSON artifacts for automation.
References: Setup, Robot checks, Training operations, Bundle contract. Hardware approval is not a CLI operation.