CLI overview
Install the orbyte CLI and configure catalog deployments.
The orbyte CLI deploys credits, features, and plans from orbyte.config.ts. It ships with @orbytelabs/credit and requires Node.js 24+ and ESM.
pnpm add @orbytelabs/credit
pnpm exec orbyte --helpFollow the quickstart to create your first catalog. Set ORBYTE_API_KEY in your environment or in .env.local beside the config file. Keep that file out of version control.
ORBYTE_API_KEY=cr_secret_your_keyThe CLI connects to https://api.orbytelabs.com automatically. Your key selects the application and environment. Existing environment variables take precedence over .env.local.
Use a key with the catalog permissions described in authentication.
Commands
| Command | Behavior |
|---|---|
deploy | Create or update declared credits, features, and plans, then generate typed keys. |
dev | Deploy immediately, then watch the config and its local imports for changes. |
Options
| Option | Behavior |
|---|---|
--config path/to/orbyte.config.ts | Read a different config file. Defaults to orbyte.config.ts in the current directory. |
--dry-run | Read the application and catalog and show planned changes without writing or generating keys. |
--help | Show the available commands and options. |
Both commands accept these options. The generated types guide explains the _orbyte.ts file they produce.