OrbitLab CLI

Deploy apps and manage domains, DNS, databases, organizations and billing on OrbitLab from your terminal or CI.

npm install -g @orbitlab/cli
orbitlab login

Requires Node.js 18.17 or later. No runtime dependencies.

Quick start

orbitlab services ls                 # your apps, WordPress sites and VPS
cd my-app && orbitlab link my-app    # commands in this directory now target my-app
orbitlab env set API_URL=https://api.example.com
orbitlab deploy --wait               # build, stream the log, exit non-zero on failure
orbitlab logs --since 1h
orbitlab domains add www.example.com

Run orbitlab help for every command and orbitlab <command> --help for details.

Authentication

• orbitlab login opens the browser to approve the device and stores a token in ~/.config/orbitlab/config.json (mode 0600).
• In CI, create a token in Dashboard → Settings → API tokens and set ORBITLAB_TOKEN.
• Select an organization with --org, ORBITLAB_ORG, orbitlab orgs switch or a linked directory.

Scripting

• --json prints machine-readable output on stdout; progress messages go to stderr.
• Destructive commands ask for confirmation; pass --yes in scripts.
• Exit codes: 0 success, 1 error (API, network, failed deploy), 2 invalid usage.
• orbitlab api <path> calls any endpoint of the REST API with your credentials.

Full documentation: https://docs.orbitlab.dev/cli

Development

npm run build      # compile to dist/
npm test           # run the test suite
npm run typecheck  # type-check sources and tests

Release

1. Bump the version in package.json and src/version.ts (a test checks they match).
2. Merge, then push a tag with the same version: git tag cli-v0.2.0 && git push origin cli-v0.2.0.
3. The CLI GitHub Actions workflow tests the package and publishes it to npm (needs the NPM_TOKEN secret).