Skip to content

CLI Reference

Simulo thin client — submit an app to the Simulo cloud and observe its runs (simulo systems / jobs / logs / result / policy / recordings / outputs / export / view / cancel).

pip install simulo
simulo <command> [options]
Command What it does
simulo run Submit the file’s one typed job to Simulo, or write a local package without a cloud target.
simulo prepare Check a Simulo app against the platform BEFORE submitting it. Builds the manifest and, when signed in, resolves its catalog asset references before asking whether it would work (pip version conflicts, invalid job timeouts, and more). Signed-out or unreachable asset checks are reported and skipped. Imports your app file, same as simulo run. Never uploads anything and never creates a job.
simulo policy List, inspect and download training policies.
simulo create Scaffold a new Simulo app folder from a starter template shipped inside this wheel (writes task.py, preview.py, train.py, eval.py, play.py, and .simuloignore; no network, no auth).
simulo install Install a curated local collection of Simulo samples.
simulo asset Publish, validate, browse, and manage robot, world, and prop asset packages in your organization’s catalog; browse the Simulo global catalog (USD or URDF).
simulo login Authenticate via browser; set SIMULO_CREDENTIALS_FILE to save a separate actor session.
simulo logout Clear the local session and revoke the refresh token server-side.
simulo whoami Show the current authenticated identity.
simulo org Manage the active organization used by authenticated CLI requests.
simulo jobs List your submitted jobs and their status (talks HTTP to the Simulo cloud jobs API).
simulo logs Print a job’s logs from the jobs API (default: your most recent job you submitted (train, play, preview or eval)); –follow streams until it finishes.
simulo result Print the result JSON of a successfully completed job (default: your most recent job you submitted (train, play, preview or eval)).
simulo recordings Download MCAP recording(s); preview and eval also save ready Lichtblick/Foxglove layouts.
simulo systems List the published GPU system tiers @app.job(system=...) accepts — table or –json. Reads only the in-package catalog: no network call.
simulo export Export an explicit policy checkpoint to a portable ONNX bundle.
simulo outputs List or download a job’s published checkpoints and recordings in one view. No NAME/OUTPUT_ID: list; NAME/OUTPUT_ID: download.
simulo view Open the browser onto a running –viewstream job’s live 3D scene (POST /v1/jobs/{id}/view-session; default: your most recent job you submitted (train, play, preview or eval)).
simulo cancel Request cancellation of a queued or running job (POST /v1/jobs/{id}/cancel; default: your most recent job you submitted (train, play, preview or eval) — confirmed before acting, see –yes).