Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
CLICommands

orl deploy

Create a GPU VM with a guided or scripted flow, part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing.

orl deploy <name> [flags]

Picks a GPU shape from live availability and creates a VM. Interactive when run in a terminal without --gpu-model; fully scriptable with flags and --json. Use --dry-run to print the request without sending it.

Flags

FlagTypeRequired
--connectboolnowait, then open an SSH session
--disk-gbintnodisk size in GB (omit for the default: 100 GB per GPU)
--dry-runboolnoprint the request body and exit without creating
--gpu-countintnonumber of GPUs
--gpu-modelstringnoGPU model id (omit in a terminal to choose from availability)
--guest-mem-mbintnoguest RAM in MiB (auto when 0: the tightest node's per-GPU share)
--idempotency-keystringnoa key for this create (1 to 512 bytes): a repeat with the same key and flags returns the VM it made instead of creating another
--imagestringnocontainer image URL
--resource-sizestringnoCPU-only machine size instead of a GPU VM (explicit opt-in; required without --gpu-model off a terminal)
--ssh-keystringSlicenoorg SSH key id to attach (repeatable, at least one required)
--waitboolnowait until the VM is ready
--yesboolnoskip the confirmation prompt

This wraps the createVm API operation.

On this page