// CLI REFERENCE
CLI reference
BetaThe segal CLI is a thin wrapper over the REST API. Commands follow segal <service> <verb> and map one-to-one to endpoints in the API reference.
Beta — roadmap tool
The command surface below is generated from the spec to show the intended shape. Install instructions and a pinned version will land here once the CLI is published.
Install
bash
npm install -g @segal/cli
# or: brew install segal/tap/segalAuthenticate
The CLI reads SEGAL_API_KEY from the environment, or you can log in interactively. Keys are scoped per project — see API keys.
bash
export SEGAL_API_KEY=sk_segal_...
# or
segal auth loginOutput
Every command prints a table by default and JSON with --json, so output pipes cleanly into jq and scripts.
Commands
segal domains
API →segal domains listList domains
segal domains create [flags]Register a domain
segal dns
API →segal dns listList DNS zones
segal dns create [flags]Create a DNS zone
segal sites
API →segal sites listList sites
segal sites create [flags]Create a site
segal databases
API →segal databases listList databases
segal databases create [flags]Create a database
segal vpn
API →segal vpn listList VPN networks
segal vpn create [flags]Create a VPN network