CLI reference
Every Poyesis command, flag, and environment variable.
The Poyesis CLI drives the entire platform from your terminal. Install it with npm, Homebrew, or the install script.
npm install -g @poyesis/cliGlobal flags#
| Flag | Description |
|---|---|
--project, -p | Target a project by slug |
--json | Output machine-readable JSON |
--no-color | Disable ANSI colors |
--token | Auth token (overrides stored credentials) |
Commands#
poyesis login#
Authorize the CLI against your account.
poyesis loginpoyesis init#
Detect your stack and scaffold a poyesis.yaml.
poyesis init --template node-servicepoyesis run#
Run the current pipeline and stream logs.
poyesis run --stage build,testpoyesis deploy#
Deploy to an environment.
poyesis deploy --env production --strategy canarypoyesis rollback#
Restore a previous release.
poyesis rollback --env production --to release_8f21c4Environment variables#
| Variable | Description |
|---|---|
POYESIS_TOKEN | Auth token for non-interactive / CI usage |
POYESIS_PROJECT | Default project slug |
POYESIS_NO_TELEMETRY | Set to 1 to disable anonymous usage metrics |
In CI, set POYESIS_TOKEN from an encrypted secret. Never echo it to logs — Poyesis
masks known token formats, but custom logging can leak them.
Exit codes#
| Code | Meaning |
|---|---|
0 | Success |
1 | Pipeline or command failed |
2 | Invalid usage / bad flags |
4 | Authentication required |
Scripting Poyesis? Combine --json with jq to extract any field — for example
poyesis run --json | jq '.stages[] | select(.state=="failed")'.