Skip to content

CLI Reference

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

pip install simulo
simulo <command> [options]
Command What it does
simulo run Submit a Simulo app: run its @app.entrypoint (or, without one, map the flags onto the job’s own signature; –job NAME chooses among several), writing the package to disk.
simulo prepare Check a Simulo app against the platform BEFORE submitting it — builds the manifest and asks the platform whether it would work (pip version conflicts, invalid job timeouts, and more). Imports your app file, same as simulo run. Never uploads anything and never creates a job.
simulo create Scaffold a new Simulo app folder from a starter template shipped inside this wheel (writes app.py + .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 the CLI via browser (PKCE loopback or manual fallback).
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: the most recent job); –follow streams until it finishes.
simulo result Print the result JSON of a successfully completed job (default: the most recent job).
simulo recordings Download a job’s MCAP recording(s) (GET /v1/jobs/{id}/recordings).
simulo models List or download a job’s trained models (best.pt / latest.pt) (GET /v1/jobs/{id}/models). No NAME: list; NAME: digest-verified download.
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 a trained policy to a portable ONNX bundle — Simulo converts it, checks it against the source PyTorch policy, and this downloads and unpacks it ready to verify on your own machine (POST /v1/jobs/{id}/exports). No arguments: the latest job’s best checkpoint.
simulo outputs List or download a job’s published models 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: the most recent job).
simulo cancel Request cancellation of a queued or running job (POST /v1/jobs/{id}/cancel; default: the most recent job — confirmed before acting, see –yes).