Command Line
Workflows
The signature orl commands for deploying and connecting to GPU VMs, plus how to script orl in CI.
Every REST endpoint has an orl command (you will see it on each
API Reference page). These are the ones you reach for
most.
Deploy a VM
orl deploy <name> picks a GPU shape from live availability and creates a VM.
It is interactive in a terminal and fully scriptable with flags.
# Guided: choose the GPU from what has capacity
orl deploy trainer
# Scripted: pick the shape yourself
orl deploy trainer --gpu-model h100 --gpu-count 2 --disk-gb 200
# Wait for it to boot, then open an SSH session
orl deploy trainer --gpu-model h100 --gpu-count 1 --connect
# Print the request without creating anything
orl deploy trainer --gpu-model h100 --gpu-count 1 --dry-run| Flag | What it does |
|---|---|
--gpu-model, --gpu-count | GPU model id and count (omit --gpu-model in a terminal to choose) |
--disk-gb, --image | Disk size and container image |
--ssh-key | Attach an org SSH key by id (repeatable) |
--wait | Wait until the VM is ready, then print it |
--connect | Wait, then open an SSH session |
--dry-run | Print the request body and exit |
--yes | Skip the confirmation prompt |
Connect and manage
orl vms list # your VMs
orl vms ssh <vm-id> # SSH over the data plane
orl vms ssh <vm-id> --print # print the ssh command instead of running it
orl vms stop <vm-id> # stop the meter, keep the disk
orl vms terminate <vm-id> # destroy it (asks first; --force to skip)Watch spend
orl balance # balance and current-month spend
orl catalog pricing get # live GPU and CPU rates
orl usage current get # current-month usage breakdownScripting
orl is built for pipelines. Every command takes global flags:
--jsonprints the raw API response so you can pipe it tojq.--quietsuppresses progress and advisory notes.--no-colordisables ANSI color (also honored viaNO_COLOR).
# The id of your most recent VM
orl vms list --json | jq -r '.items[0].id'Exit codes
orl returns stable exit codes so scripts can branch on the failure kind. Run
orl exit-codes for the full list.
| Code | Meaning |
|---|---|
0 | success |
1 | unexpected or network error |
2 | usage error, or a 400 from the API |
3 | authentication failed (401): run orl auth login |
4 | forbidden (403): the key lacks a scope, or the org is wrong |
5 | not found (404) |
6 | conflict (409): the resource state blocks the action |
7 | server error (5xx) |
Discover any command's flags with orl <command> --help, for example
orl deploy --help or orl vms --help.