open source

CLI reference

The understudy CLI is the scriptable face of the control plane: a login flow, health checks, and shortcuts for workloads, routes, captures, and gateway probes. Anything it does, you can also do with raw HTTP — the CLI adds auth handling and sane output.

Orientation commands

command	does
`understudy spine`	Prints the public workflow — the capture → evaluate → optimize loop — and points agents at the orchestrator skill.
`understudy skills --list / --search <term>`	Browse the installed skill library.
`understudy doctor [--hosted]`	Environment health check; --hosted also verifies authentication and reachability of the hosted gateway.

Authentication

command	does
`understudy login --email you@company.com`	Email-code sign-in against the same identity the dashboard uses. Stores the credential locally; subsequent commands inject it.

Resource commands

command	control-plane equivalent
`understudy workloads list`	GET .../workloads
`understudy workloads create <name> --capture`	POST .../workloads with capture_enabled: true
`understudy routes set <workload> --project <slug> --model-id <id> --traffic-pct <n>`	PUT .../workloads/:id/route
`understudy routes show <workload> --project <slug>`	Read the workload's current route state.
`understudy routes clear <workload> --project <slug>`	PUT .../route with model_id: null — back to passthrough.
`understudy captures list --project <slug> --workload <name>`	GET .../captures
`understudy gateway probe --provider <p> --project <slug> --workload <name>`	Sends a real smoke request through the proxy and reports the legibility headers — the CLI version of the quickstart's curl.

The first hosted journey

End to end — sign in, declare a call site, probe it, watch the capture land, route a slice, roll back:

copy-paste journey

understudy login --email you@company.com
understudy doctor --hosted
understudy workloads list
understudy workloads create classify --capture
understudy gateway probe --provider anthropic --project rehearsal --workload classify
understudy captures list --project rehearsal --workload classify
understudy routes set classify --project rehearsal --model-id glm-5.1 --traffic-pct 10
understudy routes show classify --project rehearsal
understudy routes clear classify --project rehearsal

Which is the replace-a-model tutorial compressed into nine commands.