CLI Reference
Complete reference for the septiembre CLI. All commands output JSON by default. Use --output table for human-readable terminal output.
Global flags
Section titled “Global flags”| Flag | Values | Default | Description |
|---|---|---|---|
--output | json|table | json | Output format |
--org <slug> | string | — | Organization slug; overrides SEPTIEMBRE_ORG and config file |
--config <path> | path | — | Alternate config file path |
--json | — | — | Only valid with --help; emits machine-readable command tree JSON |
Commands
Section titled “Commands”version
Section titled “version”septiembre version# orseptiembre --versionReturns version information as JSON:
{ "version": "0.x.y", "commit": "...", "built_at": "..." }auth whoami
Section titled “auth whoami”septiembre auth whoamiShows the user identity (email / user ID) for the current token.
auth token create
Section titled “auth token create”septiembre auth token create [--name <string>] --expires-at <RFC3339>Creates a personal access token. The raw token value (sapi_<hex>) is shown exactly once and cannot be retrieved again.
| Flag | Required | Description |
|---|---|---|
--name | No | Human-readable label for the token; defaults to cli-token if omitted |
--expires-at | Yes | Expiry in RFC 3339 format, e.g. 2026-12-31T00:00:00Z |
auth token list
Section titled “auth token list”septiembre auth token listLists all personal access tokens for the authenticated user. The raw token value is never shown in list output.
auth token revoke
Section titled “auth token revoke”septiembre auth token revoke <id>Revokes the token with the given ID.
orgs list
Section titled “orgs list”septiembre orgs listLists all organizations the authenticated user belongs to.
teams list
Section titled “teams list”septiembre teams list --org <slug>Lists all teams in the resolved organization.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
apps list
Section titled “apps list”septiembre apps list [--org <slug>]Lists apps. Without --org, returns a flat cross-organization list. With --org, scopes results to that organization.
| Flag | Required | Description |
|---|---|---|
--org | No | Organization slug |
Each app includes a composed url field (https://{subdomain}.septiembre.co) when domain_status is active. The url field is absent until the domain is active (typically after the first successful deploy).
apps get
Section titled “apps get”septiembre apps get <app-id> --org <slug>Returns full details for a single app.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
The response includes a composed url field (https://{subdomain}.septiembre.co). The url field is absent (omitempty) until domain_status reaches active. Default host suffix is septiembre.co; override with SEPTIEMBRE_DOMAIN_SUFFIX or the domain_suffix config key.
apps create
Section titled “apps create”septiembre apps create --name <string> --type <type> --region <region> --org <slug> [options]Creates a new application.
| Flag | Required | Description |
|---|---|---|
--name | Yes | Application name / slug |
--type | Yes | web | web-ssr | api | sse |
--region | Yes | us-east-1 | us-east-2 | sa-east-1 |
--runtime | Required when --type is not web | nodejs24 | python314 | go126 |
--team | No | Team slug or ID (auto-selects when org has exactly one team) |
--wait | No | Wait for domain to become active before returning |
--wait-interval | No | Polling interval (default 5s) |
--wait-timeout | No | Maximum wait time (default 10m) |
apps delete
Section titled “apps delete”septiembre apps delete <app-id> --org <slug> --yesInitiates async teardown of an application.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
--yes | Yes | Confirm deletion (required to prevent accidental deletion in scripts) |
env get
Section titled “env get”septiembre env get <app-id> --org <slug> [--reveal]Reads app environment variables. Values are masked (***) by default.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
--reveal | No | Show unmasked values |
env set
Section titled “env set”septiembre env set <app-id> --org <slug> KEY=VALUE [KEY=VALUE...]Replaces all environment variables for the app (full PUT replacement). Any key not included in the command is deleted.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
deploys trigger
Section titled “deploys trigger”septiembre deploys trigger <app-id> --org <slug> [--tag <release-tag>] [--env-id <id>] [--wait]Triggers a new deployment.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
--tag | Required for API and SSE app types; optional for web apps | Release tag to deploy |
--env-id | No | Target environment ID (defaults to the app’s default environment) |
--wait | No | Wait for deployment to reach a terminal state before returning |
--wait-interval | No | Polling interval (default 5s) |
--wait-timeout | No | Maximum wait time (default 15m) |
deploys list
Section titled “deploys list”septiembre deploys list <app-id> --org <slug>Lists recent deployments for the app.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
deploys status
Section titled “deploys status”septiembre deploys status <app-id> <deploy-id> --org <slug>Returns the status and details of a single deployment.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
septiembre logs <app-id> --org <slug> [--env-id <id>]Fetches a non-streaming log snapshot. Automatically resolves the default environment when --env-id is omitted.
| Flag | Required | Description |
|---|---|---|
--org | Yes | Organization slug |
--env-id | No | Environment ID (defaults to app’s default environment) |
Exit codes
Section titled “Exit codes”| Exit code | Meaning |
|---|---|
0 | Success |
1 | General error / API error |
2 | Auth error (401 / 403 / missing token) |
3 | Not found (404) |
4 | Validation / bad input (400 / 422) |
5 | Network error |
Use exit codes in scripts and agents to handle failures without parsing error text. See Agent usage for scripting patterns.