CLI

One binary. No YAML archaeology.

The ByteRoast CLI wraps the same API as the console. Create servers, take snapshots, manage DNS and SSH into machines without opening a browser.

Join the waitlist API reference

Preview

The CLI ships to early-access members as a signed binary for macOS, Linux and Windows, with install instructions by email. The command surface below is final; flags may still change.

Authenticate

br login

This opens a browser to approve the device, then stores a scoped token in your system keychain. For CI, set BR_TOKEN instead:

export BR_TOKEN="br_live_..."

Servers

br servers list
br servers create web-1 --region ruh1 --plan growth --image ubuntu-24.04
br servers get web-1
br ssh web-1
br servers power-off web-1
br servers destroy web-1

br ssh resolves the IP, picks the right key and opens an SSH session. No copy-pasting addresses.

Snapshots

br snapshots create api-prod --label "pre-release"
br snapshots list api-prod
br snapshots restore api-prod --snapshot snap_8fk2 --target new

DNS

br dns records example.com
br dns add example.com A www 203.0.113.10 --ttl 300
br dns rm example.com A www

Scripting

Every command accepts --json for machine-readable output, and --yes to skip confirmation prompts in CI.

br servers list --json | jq -r '.[] | select(.status=="running") | .name'

Commands at a glance

Command	Description
`br login`	Authenticate this device
`br servers`	List, create and manage servers
`br ssh`	Open an SSH session
`br snapshots`	Create, list and restore snapshots
`br dns`	Manage domains and records
`br regions`	List regions and plans
`br billing`	Show the current cycle and invoices

Exit codes

0 success
1 general error
2 usage error
3 authentication required
4 resource not found

Help

br <command> --help prints the full flag list. If a command behaves differently from this page, email support@byteroast.com and we will fix the docs or the binary.

Early access

Automate the boring part.

Early-access members get the CLI, API tokens and a direct line to the engineers building it.

Join the waitlist Talk to an engineer