CLI Reference
The shipd CLI is the primary interface for config-as-code workflows. Every
command works non-interactively (for CI) and supports --json output.
Commands
Section titled “Commands”shipd auth
Section titled “shipd auth”Authenticate with the service.
| Command | Description |
|---|---|
shipd auth login |
Browser-based login (device flow) |
shipd auth logout |
Clear stored credentials |
shipd pull
Section titled “shipd pull”Regenerate shipd.config.ts from the current server state.
shipd push
Section titled “shipd push”Plan and apply local flag definitions to the server. Always shows a plan before applying; fails on conflicts with dashboard edits since your last pull.
shipd diff
Section titled “shipd diff”Show drift between local definitions and server state without applying.
shipd typegen
Section titled “shipd typegen”Generate TypeScript types for the runtime SDK from server state.
Configuration
Section titled “Configuration”Precedence (highest wins):
- CLI flags
- Environment variables
- Project config file
- Global config file
Exit Codes
Section titled “Exit Codes”| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Conflict (stale base on push) |