Temps CLI Reference

Auto-generated documentation for the Temps CLI.

Generated on: 2026-02-18

Installation

# Or use with bunx
bunx @temps-sdk/cli [command]

Authentication

Before using most commands, you need to authenticate:

# Login with API key
bunx @temps-sdk/cli login

# Or configure with wizard
bunx @temps-sdk/cli configure

Global Options

FlagDescription
-v, --versionDisplay version number
--no-colorDisable colored output
--debugEnable debug output
-h, --helpDisplay help for command

Commands

login

Authenticate with the current Temps instance

Options:

FlagDescriptionDefaultRequired
-k, --api-key <key>API key (will prompt if not provided)-Yes
--email [email]Login with email and password-No
--magic [email]Login via magic link (email-based)-No

logout

Log out and clear credentials

whoami

Display current authenticated user

Options:

FlagDescriptionDefaultRequired
--jsonOutput as JSON-No

configure

Configure CLI settings (AWS-style wizard)

Options:

FlagDescriptionDefaultRequired
--api-url <url>API URL-Yes
--api-token <token>API token for authentication-Yes
--output-format <format>Output format (table, json, minimal)-Yes
--enable-colorsEnable colored output in config-No
--disable-colorsDisable colored output in config-No
-i, --interactiveForce interactive mode even in non-TTY-No
-y, --no-interactiveNon-interactive mode (uses defaults for unspecified options)-No

Subcommands:

  • get - Get a configuration value
  • set - Set a configuration value
  • list - List all configuration values
  • show - Show current configuration and authentication status
  • reset - Reset configuration to defaults

configure get

Get a configuration value

configure set

Set a configuration value

configure list

List all configuration values

configure show

Show current configuration and authentication status

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

configure reset

Reset configuration to defaults

projects (alias: project, p)

Manage projects

Subcommands:

  • list (ls) - List all projects
  • create (new) - Create a new project
  • show (get) - Show project details
  • update (edit) - Update project name and description
  • settings - Update project settings (slug, attack mode, preview environments)
  • git - Update git repository settings
  • config - Update deployment configuration (resources, replicas)
  • delete (rm) - Delete a project

projects list (alias: ls)

List all projects

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No
--page <n>Page number-Yes
--per-page <n>Items per page-Yes

projects create (alias: new)

Create a new project

Options:

FlagDescriptionDefaultRequired
-n, --name <name>Project name-Yes
-d, --description <description>Project description-Yes
--repo <repository>Git repository URL-Yes

projects show (alias: get)

Show project details

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--jsonOutput in JSON format-No

projects update (alias: edit)

Update project name and description

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-n, --name <name>New project name-Yes
-d, --description <description>New project description-Yes
--jsonOutput in JSON format-No
-y, --yesSkip prompts, use provided values (for automation)-No

projects settings

Update project settings (slug, attack mode, preview environments)

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--slug <slug>Project URL slug-Yes
--attack-modeEnable attack mode (CAPTCHA protection)-No
--no-attack-modeDisable attack mode-No
--preview-envsEnable preview environments-No
--no-preview-envsDisable preview environments-No
--jsonOutput in JSON format-No
-y, --yesSkip prompts (for automation)-No

projects git

Update git repository settings

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--owner <owner>Repository owner-Yes
--repo <repo>Repository name-Yes
--branch <branch>Main branch-Yes
--directory <directory>App directory path-Yes
--preset <preset>Build preset (auto, nextjs, nodejs, static, docker, rust, go, python)-Yes
--jsonOutput in JSON format-No
-y, --yesSkip prompts, use provided/existing values (for automation)-No

projects config

Update deployment configuration (resources, replicas)

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--replicas <n>Number of container replicas-Yes
--cpu-limit <limit>CPU limit in cores (e.g., 0.5, 1, 2)-Yes
--memory-limit <limit>Memory limit in MB-Yes
--auto-deployEnable automatic deployments-No
--no-auto-deployDisable automatic deployments-No
--jsonOutput in JSON format-No
-y, --yesSkip prompts (for automation)-No

projects delete (alias: rm)

Delete a project

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation (alias for --force)-No

deploy

Deploy a project from git

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Target environment name-Yes
--environment-id <id>Target environment ID-Yes
-b, --branch <branch>Git branch to deploy-Yes
-c, --commit <sha>Specific commit SHA to deploy-Yes
--no-waitDo not wait for deployment to complete-No
-y, --yesSkip confirmation prompts (for automation)-No

deploy:static (alias: deploy-static)

Deploy static files (tar.gz, zip, or directory)

Options:

FlagDescriptionDefaultRequired
--path <path>Path to static files archive or directory-Yes
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Target environment nameproductionYes
--environment-id <id>Target environment ID-Yes
--no-waitDo not wait for deployment to complete-No
-y, --yesSkip confirmation prompts (for automation)-No
--metadata <json>Additional metadata (JSON format)-Yes
--timeout <seconds>Timeout in seconds for --wait300Yes

deploy:image (alias: deploy-image)

Deploy a pre-built Docker image

Options:

FlagDescriptionDefaultRequired
--image <image>Docker image reference (e.g., ghcr.io/org/app:v1.0)-Yes
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Target environment nameproductionYes
--environment-id <id>Target environment ID-Yes
--no-waitDo not wait for deployment to complete-No
-y, --yesSkip confirmation prompts (for automation)-No
--metadata <json>Additional metadata (JSON format)-Yes
--timeout <seconds>Timeout in seconds for --wait300Yes

deploy:local-image (alias: deploy-local-image)

Build and deploy a local Docker image (or deploy existing image with --image)

Options:

FlagDescriptionDefaultRequired
--image <image>Use existing local image instead of building (skips build)-Yes
-f, --dockerfile <path>Path to DockerfileDockerfileYes
-c, --context <path>Build context directory.Yes
--build-arg <arg...>Build arguments (can be specified multiple times)-Yes
--no-buildSkip building, requires --image-No
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Target environment nameproductionYes
--environment-id <id>Target environment ID-Yes
-t, --tag <tag>Tag for the built/uploaded image-Yes
--no-waitDo not wait for deployment to complete-No
-y, --yesSkip confirmation prompts (for automation)-No
--metadata <json>Additional metadata (JSON format)-Yes
--timeout <seconds>Timeout in seconds for --wait600Yes

deployments (alias: deploys)

Manage deployments

Subcommands:

  • list (ls) - List deployments
  • status - Show deployment status
  • rollback - Rollback to previous deployment
  • cancel - Cancel a running deployment
  • pause - Pause a deployment
  • resume - Resume a paused deployment
  • teardown - Teardown a deployment and remove all resources
  • logs - Show deployment build logs

deployments list (alias: ls)

List deployments

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Filter by environment name (client-side)-Yes
--environment-id <id>Filter by environment ID (server-side)-Yes
-n, --limit <number>Limit results10Yes
--page <n>Page number-Yes
--per-page <n>Items per page-Yes
--jsonOutput in JSON format-No

deployments status

Show deployment status

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID (required)-Yes
-d, --deployment-id <id>Deployment ID (required)-Yes
--jsonOutput in JSON format-No

deployments rollback

Rollback to previous deployment

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID (required)-Yes
-e, --environment <env>Target environmentproductionYes
--to <deployment>Rollback to specific deployment ID-Yes

deployments cancel

Cancel a running deployment

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-d, --deployment-id <id>Deployment ID-Yes
-f, --forceSkip confirmation-No

deployments pause

Pause a deployment

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-d, --deployment-id <id>Deployment ID-Yes

deployments resume

Resume a paused deployment

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-d, --deployment-id <id>Deployment ID-Yes

deployments teardown

Teardown a deployment and remove all resources

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-d, --deployment-id <id>Deployment ID-Yes
-f, --forceSkip confirmation-No

deployments logs

Show deployment build logs

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>EnvironmentproductionYes
-f, --followFollow log output-No
-n, --lines <number>Number of lines to show100Yes
-d, --deployment <id>Specific deployment ID-Yes

domains (alias: domain)

Manage custom domains

Subcommands:

  • list (ls) - List domains
  • add - Add a custom domain
  • verify - Verify domain and provision SSL certificate
  • remove (rm) - Remove a domain
  • ssl - Manage SSL certificate
  • status - Check domain status
  • orders (order) - Manage ACME orders for SSL certificate provisioning
  • dns-challenge - Setup DNS challenge records automatically using a DNS provider
  • http-debug - Debug HTTP-01 challenge for a domain

domains list (alias: ls)

List domains

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

domains add

Add a custom domain

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name-Yes
-c, --challenge <type>Challenge type (http-01 or dns-01)http-01Yes
-y, --yesSkip confirmation prompts-No

domains verify

Verify domain and provision SSL certificate

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name-Yes

domains remove (alias: rm)

Remove a domain

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

domains ssl

Manage SSL certificate

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name-Yes
--renewForce certificate renewal-No

domains status

Check domain status

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name-Yes

domains orders (alias: order)

Manage ACME orders for SSL certificate provisioning

Subcommands:

  • list (ls) - List all ACME orders
  • show - Show ACME order for a domain
  • create - Create or recreate an ACME order for a domain
  • finalize - Finalize an ACME order (complete challenge validation)
  • cancel - Cancel an ACME order for a domain

domains orders list (alias: ls)

List all ACME orders

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

domains orders show

Show ACME order for a domain

Options:

FlagDescriptionDefaultRequired
--domain-id <id>Domain ID-Yes
--jsonOutput in JSON format-No

domains orders create

Create or recreate an ACME order for a domain

Options:

FlagDescriptionDefaultRequired
--domain-id <id>Domain ID-Yes

domains orders finalize

Finalize an ACME order (complete challenge validation)

Options:

FlagDescriptionDefaultRequired
--domain-id <id>Domain ID-Yes

domains orders cancel

Cancel an ACME order for a domain

Options:

FlagDescriptionDefaultRequired
--domain-id <id>Domain ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

domains dns-challenge

Setup DNS challenge records automatically using a DNS provider

Options:

FlagDescriptionDefaultRequired
--domain-id <id>Domain ID-Yes
--provider-id <id>DNS provider ID-Yes

domains http-debug

Debug HTTP-01 challenge for a domain

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name-Yes
--jsonOutput in JSON format-No

environments (alias: envs, env)

Manage environments and environment variables

Subcommands:

  • list (ls) - List environments for a project
  • create - Create a new environment
  • delete (rm) - Delete an environment
  • vars - Manage environment variables
  • resources - View or set CPU/memory resources for an environment
  • scale - View or set the number of replicas for an environment
  • crons - Manage cron jobs

environments list (alias: ls)

List environments for a project

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--jsonOutput in JSON format-No

environments create

Create a new environment

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-n, --name <name>Environment name-Yes
-b, --branch <branch>Git branch-Yes
--previewSet as preview environment-No

environments delete (alias: rm)

Delete an environment

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-f, --forceSkip confirmation-No

environments vars

Manage environment variables

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes

Subcommands:

  • list (ls) - List environment variables
  • get - Get a specific environment variable
  • set - Set an environment variable
  • delete (rm, unset) - Delete an environment variable
  • import - Import environment variables from a .env file
  • export - Export environment variables to .env format

environments vars list (alias: ls)

List environment variables

Options:

FlagDescriptionDefaultRequired
-e, --environment <name>Filter by environment name-Yes
--show-valuesShow actual values (hidden by default)-No
--jsonOutput in JSON format-No

environments vars get

Get a specific environment variable

Options:

FlagDescriptionDefaultRequired
-e, --environment <name>Specify environment (if variable exists in multiple)-Yes

environments vars set

Set an environment variable

Options:

FlagDescriptionDefaultRequired
-e, --environments <names>Comma-separated environment names (interactive if not provided)-Yes
--no-previewExclude from preview environments-No
--updateUpdate existing variable instead of creating new-No

environments vars delete (alias: rm, unset)

Delete an environment variable

Options:

FlagDescriptionDefaultRequired
-e, --environment <name>Delete only from specific environment-Yes
-f, --forceSkip confirmation-No

environments vars import

Import environment variables from a .env file

Options:

FlagDescriptionDefaultRequired
-e, --environments <names>Comma-separated environment names-Yes
--overwriteOverwrite existing variables-No

environments vars export

Export environment variables to .env format

Options:

FlagDescriptionDefaultRequired
-e, --environment <name>Export from specific environment-Yes
-o, --output <file>Write to file instead of stdout-Yes

environments resources

View or set CPU/memory resources for an environment

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--cpu <millicores>CPU limit in millicores (e.g., 500 = 0.5 CPU)-Yes
--memory <mb>Memory limit in MB (e.g., 512)-Yes
--cpu-request <millicores>CPU request in millicores (guaranteed minimum)-Yes
--memory-request <mb>Memory request in MB (guaranteed minimum)-Yes
--jsonOutput in JSON format-No

environments scale

View or set the number of replicas for an environment

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Environment name or slugproductionYes
-r, --replicas <count>Number of replicas to set-Yes
--jsonOutput in JSON format-No

environments crons

Manage cron jobs

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Environment name or slug-Yes

Subcommands:

  • list (ls) - List cron jobs for an environment
  • show - Show cron job details
  • executions (execs) - Show cron job execution history

environments crons list (alias: ls)

List cron jobs for an environment

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

environments crons show

Show cron job details

Options:

FlagDescriptionDefaultRequired
--id <id>Cron job ID-Yes
--jsonOutput in JSON format-No

environments crons executions (alias: execs)

Show cron job execution history

Options:

FlagDescriptionDefaultRequired
--id <id>Cron job ID-Yes
--page <page>Page number1Yes
--per-page <count>Items per page20Yes
--jsonOutput in JSON format-No

providers (alias: provider)

Manage Git providers

Subcommands:

  • list (ls) - List configured Git providers
  • add - Add a new Git provider
  • remove (rm) - Remove a Git provider
  • show - Show Git provider details
  • activate - Activate a Git provider
  • deactivate - Deactivate a Git provider
  • safe-delete - Safely delete a Git provider (checks dependencies first)
  • deletion-check - Check if a Git provider can be safely deleted
  • git - Manage Git providers
  • connections (conn) - Manage Git provider connections

providers list (alias: ls)

List configured Git providers

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

providers add

Add a new Git provider

Options:

FlagDescriptionDefaultRequired
-p, --provider <provider>Provider type (github, gitlab)-Yes
-n, --name <name>Provider name-Yes
-t, --token <token>Personal access token-Yes
--base-url <url>GitLab base URL (for self-hosted GitLab)-Yes
-y, --yesSkip confirmation prompts (for automation)-No

providers remove (alias: rm)

Remove a Git provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

providers show

Show Git provider details

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

providers activate

Activate a Git provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes

providers deactivate

Deactivate a Git provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes

providers safe-delete

Safely delete a Git provider (checks dependencies first)

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

providers deletion-check

Check if a Git provider can be safely deleted

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

providers git

Manage Git providers

Subcommands:

  • connect - Connect a Git provider (github, gitlab)
  • repos - List available repositories

providers git connect

Connect a Git provider (github, gitlab)

Options:

FlagDescriptionDefaultRequired
-p, --provider <provider>Provider type (github, gitlab)-Yes
-n, --name <name>Provider name-Yes
-t, --token <token>Personal access token-Yes
--base-url <url>GitLab base URL (for self-hosted GitLab)-Yes
-y, --yesSkip confirmation prompts (for automation)-No

providers git repos

List available repositories

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID (optional, lists all if not provided)-Yes
--jsonOutput in JSON format-No
--search <term>Search repositories by name-Yes
--page <n>Page number-Yes
--per-page <n>Items per page (max: 100)-Yes
--sort <field>Sort by field (name, created_at, updated_at, stars)-Yes
--direction <dir>Sort direction: asc or desc-Yes
--language <lang>Filter by programming language-Yes
--owner <owner>Filter by repository owner-Yes

providers connections (alias: conn)

Manage Git provider connections

Subcommands:

  • list (ls) - List all Git connections
  • show - Show connection details for a provider
  • delete (rm) - Delete a Git connection
  • activate - Activate a Git connection
  • deactivate - Deactivate a Git connection
  • sync - Sync repositories for a Git connection
  • update-token - Update access token for a Git connection
  • validate - Validate a Git connection

providers connections list (alias: ls)

List all Git connections

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No
--page <n>Page number-Yes
--per-page <n>Items per page (default: 30, max: 100)-Yes
--sort <field>Sort by field (created_at, updated_at, account_name)-Yes
--direction <dir>Sort direction: asc or desc (default: desc)-Yes

providers connections show

Show connection details for a provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

providers connections delete (alias: rm)

Delete a Git connection

Options:

FlagDescriptionDefaultRequired
--id <id>Connection ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

providers connections activate

Activate a Git connection

Options:

FlagDescriptionDefaultRequired
--id <id>Connection ID-Yes

providers connections deactivate

Deactivate a Git connection

Options:

FlagDescriptionDefaultRequired
--id <id>Connection ID-Yes

providers connections sync

Sync repositories for a Git connection

Options:

FlagDescriptionDefaultRequired
--id <id>Connection ID-Yes

providers connections update-token

Update access token for a Git connection

Options:

FlagDescriptionDefaultRequired
--id <id>Connection ID-Yes
-t, --token <token>New access token-Yes

providers connections validate

Validate a Git connection

Options:

FlagDescriptionDefaultRequired
--id <id>Connection ID-Yes
--jsonOutput in JSON format-No

backups (alias: backup)

Manage backup schedules and backups

Subcommands:

  • schedules (schedule) - Manage backup schedules
  • sources (source) - Manage S3 backup sources
  • list (ls) - List backups for a schedule
  • show - Show backup details
  • run-service - Run a backup for an external service

backups schedules (alias: schedule)

Manage backup schedules

Subcommands:

  • list (ls) - List backup schedules
  • create - Create a backup schedule
  • show - Show backup schedule details
  • enable - Enable a backup schedule
  • disable - Disable a backup schedule
  • delete (rm) - Delete a backup schedule

backups schedules list (alias: ls)

List backup schedules

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

backups schedules create

Create a backup schedule

Options:

FlagDescriptionDefaultRequired
-n, --name <name>Schedule name-Yes
-t, --type <type>Backup type (full, incremental)-Yes
-s, --schedule <cron>Schedule expression (cron format)-Yes
-r, --retention <days>Retention period in days-Yes
-d, --description <desc>Description-Yes
--s3-source-id <id>S3 Source ID-Yes
-y, --yesSkip confirmation prompts (for automation)-No

backups schedules show

Show backup schedule details

Options:

FlagDescriptionDefaultRequired
--id <id>Schedule ID-Yes
--jsonOutput in JSON format-No

backups schedules enable

Enable a backup schedule

Options:

FlagDescriptionDefaultRequired
--id <id>Schedule ID-Yes

backups schedules disable

Disable a backup schedule

Options:

FlagDescriptionDefaultRequired
--id <id>Schedule ID-Yes

backups schedules delete (alias: rm)

Delete a backup schedule

Options:

FlagDescriptionDefaultRequired
--id <id>Schedule ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

backups sources (alias: source)

Manage S3 backup sources

Subcommands:

  • list (ls) - List S3 sources
  • create - Create an S3 source
  • show - Show S3 source details
  • update - Update an S3 source
  • remove (rm) - Delete an S3 source
  • backups - List backups for an S3 source
  • run - Trigger a backup for an S3 source

backups sources list (alias: ls)

List S3 sources

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

backups sources create

Create an S3 source

Options:

FlagDescriptionDefaultRequired
-n, --name <name>Source name-Yes
--bucket <bucket>S3 bucket name-Yes
--region <region>S3 region-Yes
--endpoint <endpoint>S3 endpoint (for S3-compatible services)-Yes
--access-key <key>Access key ID-Yes
--secret-key <key>Secret access key-Yes
--prefix <prefix>Bucket path/prefix-Yes
-y, --yesSkip confirmation prompts (for automation)-No

backups sources show

Show S3 source details

Options:

FlagDescriptionDefaultRequired
--id <id>S3 source ID-Yes
--jsonOutput in JSON format-No

backups sources update

Update an S3 source

Options:

FlagDescriptionDefaultRequired
--id <id>S3 source ID-Yes
-n, --name <name>New source name-Yes
--bucket <bucket>New S3 bucket name-Yes
--region <region>New S3 region-Yes
--endpoint <endpoint>New S3 endpoint-Yes
--access-key <key>New access key ID-Yes
--secret-key <key>New secret access key-Yes
--prefix <prefix>New bucket path/prefix-Yes

backups sources remove (alias: rm)

Delete an S3 source

Options:

FlagDescriptionDefaultRequired
--id <id>S3 source ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

backups sources backups

List backups for an S3 source

Options:

FlagDescriptionDefaultRequired
--id <id>S3 source ID-Yes
--jsonOutput in JSON format-No

backups sources run

Trigger a backup for an S3 source

Options:

FlagDescriptionDefaultRequired
--id <id>S3 source ID-Yes

backups list (alias: ls)

List backups for a schedule

Options:

FlagDescriptionDefaultRequired
--schedule-id <id>Schedule ID-Yes
--jsonOutput in JSON format-No

backups show

Show backup details

Options:

FlagDescriptionDefaultRequired
--id <id>Backup ID-Yes
--jsonOutput in JSON format-No

backups run-service

Run a backup for an external service

Options:

FlagDescriptionDefaultRequired
--id <id>External service ID-Yes
--s3-source-id <id>S3 source ID to store the backup-Yes
-t, --type <type>Backup type (e.g., full, incremental)-Yes

runtime-logs (alias: rlogs)

View runtime container logs (use -f to follow in real-time)

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Environment nameproductionYes
-c, --container <id>Container ID (partial match supported)-Yes
-n, --tail <lines>Number of lines to tail1000Yes
-t, --timestampsShow timestamps-No
-f, --followFollow log output (stream in real-time)-No

notifications (alias: notify)

Manage notification providers (Slack, Email, Webhook, etc.)

Subcommands:

  • list (ls) - List configured notification providers
  • add - Add a new notification provider
  • update - Update a notification provider
  • enable - Enable a notification provider
  • disable - Disable a notification provider
  • show - Show notification provider details
  • remove (rm) - Remove a notification provider
  • test - Send a test notification

notifications list (alias: ls)

List configured notification providers

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

notifications add

Add a new notification provider

Options:

FlagDescriptionDefaultRequired
-t, --type <type>Provider type (slack, email, webhook)-Yes
-n, --name <name>Provider name-Yes
-w, --webhook-url <url>Webhook URL (for slack)-Yes
-c, --channel <channel>Channel name (for slack, optional)-Yes
--smtp-host <host>SMTP host (for email)-Yes
--smtp-port <port>SMTP port (for email)-Yes
--username <username>SMTP username (for email)-Yes
--password <password>SMTP password (for email)-Yes
--from-address <address>From email address (for email)-Yes
--from-name <name>From display name (for email, optional)-Yes
--to-addresses <addresses>Comma-separated recipient addresses (for email)-Yes
--url <url>Webhook URL (for webhook)-Yes
--method <method>HTTP method: POST, PUT, PATCH (for webhook, default: POST)-Yes
-y, --yesSkip confirmation prompts (for automation)-No

notifications update

Update a notification provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-n, --name <name>New provider name-Yes
--enabled <enabled>Enable or disable (true/false)-Yes
-w, --webhook-url <url>Webhook URL (for slack)-Yes
-c, --channel <channel>Channel name (for slack)-Yes
--smtp-host <host>SMTP host (for email)-Yes
--smtp-port <port>SMTP port (for email)-Yes
--username <username>SMTP username (for email)-Yes
--password <password>SMTP password (for email)-Yes
--from-address <address>From email address (for email)-Yes
--from-name <name>From display name (for email)-Yes
--to-addresses <addresses>Comma-separated recipient addresses (for email)-Yes
--url <url>Webhook URL (for webhook)-Yes
--method <method>HTTP method: POST, PUT, PATCH (for webhook)-Yes
--jsonOutput in JSON format-No
-y, --yesSkip confirmation prompts-No

notifications enable

Enable a notification provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

notifications disable

Disable a notification provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

notifications show

Show notification provider details

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

notifications remove (alias: rm)

Remove a notification provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

notifications test

Send a test notification

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes

dns

Manage DNS providers for automated domain verification

Subcommands:

  • list (ls) - List configured DNS providers
  • add - Add a new DNS provider
  • show - Show DNS provider details
  • remove (rm) - Remove a DNS provider
  • test - Test DNS provider connection
  • zones - List available zones in a DNS provider

dns list (alias: ls)

List configured DNS providers

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

dns add

Add a new DNS provider

Options:

FlagDescriptionDefaultRequired
-t, --type <type>Provider type (cloudflare, route53, digitalocean, namecheap, gcp, azure, manual)-Yes
-n, --name <name>Provider name-Yes
-d, --description <description>Provider description-Yes
--api-token <token>Cloudflare API token-Yes
--account-id <id>Cloudflare account ID (optional)-Yes
--access-key-id <key>AWS access key ID-Yes
--secret-access-key <secret>AWS secret access key-Yes
--region <region>AWS region-Yes
--api-user <user>Namecheap API user-Yes
--api-key <key>Namecheap API key-Yes
--username <username>Namecheap username-Yes
--client-ip <ip>Namecheap whitelisted client IP-Yes
--project-id <id>GCP project ID-Yes
--service-account-email <email>GCP service account email-Yes
--private-key-id <id>GCP private key ID-Yes
--private-key <key>GCP private key-Yes
--tenant-id <id>Azure tenant ID-Yes
--client-id <id>Azure client ID-Yes
--client-secret <secret>Azure client secret-Yes
--subscription-id <id>Azure subscription ID-Yes
--resource-group <name>Azure resource group-Yes
-y, --yesSkip confirmation prompts (for automation)-No

dns show

Show DNS provider details

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

dns remove (alias: rm)

Remove a DNS provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation (alias for --force)-No

dns test

Test DNS provider connection

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes

dns zones

List available zones in a DNS provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

services (alias: svc)

Manage external services (databases, caches, storage)

Subcommands:

  • list (ls) - List all external services
  • create (add) - Create a new external service
  • show - Show service details
  • remove (rm) - Remove a service
  • start - Start a stopped service
  • stop - Stop a running service
  • types - List available service types
  • projects - List projects linked to a service
  • update - Update a service
  • upgrade - Upgrade a service to a newer version
  • import - Import an existing external service
  • link - Link a service to a project
  • unlink - Unlink a service from a project
  • env - Show environment variables for a linked service
  • env-var - Get a specific environment variable

services list (alias: ls)

List all external services

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

services create (alias: add)

Create a new external service

Options:

FlagDescriptionDefaultRequired
-t, --type <type>Service type (postgres, mongodb, redis, s3)-Yes
-n, --name <name>Service name-Yes
-s, --set <key=value>Set a parameter (repeatable)``Yes
-y, --yesSkip confirmation prompts (for automation)-No

services show

Show service details

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
--jsonOutput in JSON format-No

services remove (alias: rm)

Remove a service

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

services start

Start a stopped service

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes

services stop

Stop a running service

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes

services types

List available service types

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

Subcommands:

  • info - Show parameters schema for a service type (useful for automation)

services types info

Show parameters schema for a service type (useful for automation)

Options:

FlagDescriptionDefaultRequired
--jsonOutput as raw JSON schema (default)-No

services projects

List projects linked to a service

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
--jsonOutput in JSON format-No

services update

Update a service

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
-n, --name <name>Docker image name (e.g., postgres:18-alpine)-Yes
-s, --set <key=value>Set a parameter (repeatable)``Yes

services upgrade

Upgrade a service to a newer version

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
-v, --version <version>Docker image to upgrade to (e.g., postgres:18-alpine)-Yes

services import

Import an existing external service

Options:

FlagDescriptionDefaultRequired
-t, --type <type>Service type (postgres, mongodb, redis, s3)-Yes
-n, --name <name>Service name-Yes
--container-id <id>Container ID or name to import-Yes
-s, --set <key=value>Set a parameter (repeatable)``Yes
--version <version>Optional version override-Yes
-y, --yesSkip confirmation prompts (for automation)-No

services link

Link a service to a project

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
-p, --project <slug>Project slug (auto-detected from .temps/config.json)-Yes

services unlink

Unlink a service from a project

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
-p, --project <slug>Project slug (auto-detected from .temps/config.json)-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

services env

Show environment variables for a linked service

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
-p, --project <slug>Project slug (auto-detected from .temps/config.json)-Yes
--jsonOutput in JSON format-No

services env-var

Get a specific environment variable

Options:

FlagDescriptionDefaultRequired
--id <id>Service ID-Yes
-p, --project <slug>Project slug (auto-detected from .temps/config.json)-Yes
--var <name>Environment variable name-Yes
--jsonOutput in JSON format-No

settings

Manage platform settings

Subcommands:

  • show (get) - Show current platform settings
  • update (set) - Update platform settings
  • set-external-url - Set the external URL for the platform
  • set-preview-domain - Set the preview domain pattern

settings show (alias: get)

Show current platform settings

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

settings update (alias: set)

Update platform settings

Options:

FlagDescriptionDefaultRequired
-s, --setting <setting>Setting to update (external_url, preview_domain, letsencrypt, rate_limiting, security_headers, screenshots)-Yes
-v, --value <value>Value for the setting-Yes
--external-url <url>External URL for the platform-Yes
--preview-domain <domain>Preview domain pattern-Yes
--letsencrypt-email <email>Let's Encrypt email-Yes
--letsencrypt-mode <mode>Let's Encrypt mode (staging, production)-Yes
--rate-limiting-enabled <enabled>Enable rate limiting (true/false)-Yes
--rate-limiting-rpm <rpm>Requests per minute-Yes
--screenshots-enabled <enabled>Enable screenshots (true/false)-Yes
-y, --yesSkip confirmation prompts (for automation)-No

settings set-external-url

Set the external URL for the platform

Options:

FlagDescriptionDefaultRequired
--url <url>External URL-Yes

settings set-preview-domain

Set the preview domain pattern

Options:

FlagDescriptionDefaultRequired
--domain <domain>Preview domain pattern-Yes

users

Manage platform users

Subcommands:

  • list (ls) - List all users
  • create (add) - Create a new user
  • me - Show current user info
  • remove (rm) - Remove a user
  • restore - Restore a deleted user
  • role - Manage user roles

users list (alias: ls)

List all users

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

users create (alias: add)

Create a new user

Options:

FlagDescriptionDefaultRequired
-u, --username <username>Username-Yes
-e, --email <email>Email address-Yes
-p, --password <password>Password (if not provided, invite email will be sent)-Yes
-r, --roles <roles>Comma-separated roles (admin, developer, viewer)-Yes
-y, --yesSkip confirmation prompts (for automation)-No

users me

Show current user info

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

users remove (alias: rm)

Remove a user

Options:

FlagDescriptionDefaultRequired
--id <id>User ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

users restore

Restore a deleted user

Options:

FlagDescriptionDefaultRequired
--id <id>User ID-Yes

users role

Manage user roles

Options:

FlagDescriptionDefaultRequired
--id <id>User ID-Yes
--add <role>Add a role to user-Yes
--remove <role>Remove a role from user-Yes

apikeys (alias: keys)

Manage API keys for programmatic access

Subcommands:

  • list (ls) - List all API keys
  • create (add) - Create a new API key
  • show - Show API key details
  • remove (rm) - Delete an API key
  • activate - Activate a deactivated API key
  • deactivate - Deactivate an API key
  • permissions - List available API key permissions

apikeys list (alias: ls)

List all API keys

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

apikeys create (alias: add)

Create a new API key

Options:

FlagDescriptionDefaultRequired
-n, --name <name>API key name-Yes
-r, --role <role>Role type (admin, developer, viewer, readonly)-Yes
-e, --expires-in <days>Expires in N days (7, 30, 90, 365)-Yes
-p, --permissions <permissions>Comma-separated list of permissions-Yes
-y, --yesSkip confirmation prompts (for automation)-No

apikeys show

Show API key details

Options:

FlagDescriptionDefaultRequired
--id <id>API key ID-Yes
--jsonOutput in JSON format-No

apikeys remove (alias: rm)

Delete an API key

Options:

FlagDescriptionDefaultRequired
--id <id>API key ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

apikeys activate

Activate a deactivated API key

Options:

FlagDescriptionDefaultRequired
--id <id>API key ID-Yes

apikeys deactivate

Deactivate an API key

Options:

FlagDescriptionDefaultRequired
--id <id>API key ID-Yes

apikeys permissions

List available API key permissions

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

monitors

Manage uptime monitors for status pages

Subcommands:

  • list (ls) - List all monitors for a project
  • create (add) - Create a new monitor for a project
  • show - Show monitor details and current status
  • remove (rm) - Delete a monitor
  • status - Get current monitor status
  • history - Get monitor uptime history

monitors list (alias: ls)

List all monitors for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

monitors create (alias: add)

Create a new monitor for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
-n, --name <name>Monitor name-Yes
-t, --type <type>Monitor type (http, tcp, ping)-Yes
-i, --interval <seconds>Check interval in seconds (60, 300, 600, 900, 1800)-Yes
--environment-id <id>Environment ID (default: 0 for production)-Yes
-y, --yesSkip confirmation prompts (for automation)-No

monitors show

Show monitor details and current status

Options:

FlagDescriptionDefaultRequired
--id <id>Monitor ID-Yes
--jsonOutput in JSON format-No

monitors remove (alias: rm)

Delete a monitor

Options:

FlagDescriptionDefaultRequired
--id <id>Monitor ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

monitors status

Get current monitor status

Options:

FlagDescriptionDefaultRequired
--id <id>Monitor ID-Yes
--jsonOutput in JSON format-No

monitors history

Get monitor uptime history

Options:

FlagDescriptionDefaultRequired
--id <id>Monitor ID-Yes
--jsonOutput in JSON format-No
--days <days>Number of days to show7Yes

webhooks (alias: hooks)

Manage webhooks for project events

Subcommands:

  • list (ls) - List all webhooks for a project
  • create (add) - Create a new webhook for a project
  • show - Show webhook details
  • update - Update a webhook
  • remove (rm) - Delete a webhook
  • enable - Enable a webhook
  • disable - Disable a webhook
  • events - List available webhook event types
  • deliveries - Manage webhook deliveries

webhooks list (alias: ls)

List all webhooks for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

webhooks create (alias: add)

Create a new webhook for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
-u, --url <url>Webhook URL-Yes
-e, --events <events>Comma-separated event types (or "all" for all events)-Yes
-s, --secret <secret>Webhook secret for signature verification-Yes
-y, --yesSkip confirmation prompts (for automation)-No

webhooks show

Show webhook details

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--webhook-id <id>Webhook ID-Yes
--jsonOutput in JSON format-No

webhooks update

Update a webhook

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--webhook-id <id>Webhook ID-Yes
-u, --url <url>New webhook URL-Yes
-e, --events <events>Comma-separated event types (or "all" for all events)-Yes
-s, --secret <secret>New webhook secret for signature verification-Yes

webhooks remove (alias: rm)

Delete a webhook

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--webhook-id <id>Webhook ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

webhooks enable

Enable a webhook

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--webhook-id <id>Webhook ID-Yes

webhooks disable

Disable a webhook

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--webhook-id <id>Webhook ID-Yes

webhooks events

List available webhook event types

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

webhooks deliveries

Manage webhook deliveries

Subcommands:

  • list (ls) - List deliveries for a webhook
  • show - Show delivery details
  • retry - Retry a failed delivery

webhooks deliveries list (alias: ls)

List deliveries for a webhook

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--webhook-id <id>Webhook ID-Yes
--limit <n>Number of deliveries to return (default: 50)-Yes
--jsonOutput in JSON format-No

webhooks deliveries show

Show delivery details

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--webhook-id <id>Webhook ID-Yes
--delivery-id <id>Delivery ID-Yes
--jsonOutput in JSON format-No

webhooks deliveries retry

Retry a failed delivery

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--webhook-id <id>Webhook ID-Yes
--delivery-id <id>Delivery ID-Yes

containers (alias: cts)

Manage project containers in environments

Subcommands:

  • list (ls) - List all containers in an environment
  • show - Show container details
  • start - Start a stopped container
  • stop - Stop a running container
  • restart - Restart a container
  • metrics - Get container resource metrics (all containers if no container ID specified)

containers list (alias: ls)

List all containers in an environment

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-e, --environment-id <id>Environment ID-Yes
--jsonOutput in JSON format-No

containers show

Show container details

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-e, --environment-id <id>Environment ID-Yes
-c, --container-id <id>Container ID-Yes
--jsonOutput in JSON format-No

containers start

Start a stopped container

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-e, --environment-id <id>Environment ID-Yes
-c, --container-id <id>Container ID-Yes

containers stop

Stop a running container

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-e, --environment-id <id>Environment ID-Yes
-c, --container-id <id>Container ID-Yes
-f, --forceSkip confirmation-No

containers restart

Restart a container

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-e, --environment-id <id>Environment ID-Yes
-c, --container-id <id>Container ID-Yes

containers metrics

Get container resource metrics (all containers if no container ID specified)

Options:

FlagDescriptionDefaultRequired
-p, --project-id <id>Project ID-Yes
-e, --environment-id <id>Environment ID-Yes
-c, --container-id <id>Container ID (optional - shows all if not specified)-Yes
--jsonOutput in JSON format-No
-w, --watchWatch mode - continuously update metrics-No
-i, --interval <seconds>Refresh interval in seconds (default: 2)2Yes

tokens (alias: token)

Manage deployment tokens for project API access (KV, Blob, etc.)

Subcommands:

  • list (ls) - List deployment tokens for a project
  • create (add) - Create a new deployment token
  • show (get) - Show deployment token details
  • delete (rm) - Delete a deployment token
  • permissions - List available deployment token permissions

tokens list (alias: ls)

List deployment tokens for a project

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--jsonOutput in JSON format-No

tokens create (alias: add)

Create a new deployment token

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-n, --name <name>Token name-Yes
--permissions <permissions>Comma-separated permissions (e.g., "visitors:enrich,emails:send" or "*" for full access)-Yes
-e, --expires-in <days>Expires in N days (7, 30, 90, 365, or "never")-Yes
-y, --yesSkip confirmation prompts (for automation)-No

tokens show (alias: get)

Show deployment token details

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--id <id>Token ID-Yes
--jsonOutput in JSON format-No

tokens delete (alias: rm)

Delete a deployment token

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
--id <id>Token ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation (alias for --force)-No

tokens permissions

List available deployment token permissions

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

errors (alias: error)

Manage error tracking and error groups

Subcommands:

  • list (ls) - List error groups for a project
  • show - Show error group details
  • update - Update error group status
  • events - List events in an error group
  • event - Show a specific error event
  • stats - Get error statistics for a project
  • timeline - Get error time series data
  • dashboard - Get error dashboard statistics

errors list (alias: ls)

List error groups for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--status <status>Filter by status (unresolved, resolved, ignored)-Yes
--page <page>Page number-Yes
--page-size <size>Page size-Yes
--environment-id <id>Filter by environment ID-Yes
--start-date <date>Filter by start date (ISO 8601)-Yes
--end-date <date>Filter by end date (ISO 8601)-Yes
--sort-by <field>Sort by field (e.g., total_count, last_seen, first_seen)-Yes
--sort-order <order>Sort order: asc or desc-Yes
--jsonOutput in JSON format-No

errors show

Show error group details

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--group-id <id>Error group ID-Yes
--jsonOutput in JSON format-No

errors update

Update error group status

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--group-id <id>Error group ID-Yes
--status <status>New status (unresolved, resolved, ignored)-Yes
--assigned-to <user>Assign to user-Yes

errors events

List events in an error group

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--group-id <id>Error group ID-Yes
--page <page>Page number-Yes
--page-size <size>Page size-Yes
--jsonOutput in JSON format-No

errors event

Show a specific error event

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--group-id <id>Error group ID-Yes
--event-id <id>Error event ID-Yes
--jsonOutput in JSON format-No

errors stats

Get error statistics for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

errors timeline

Get error time series data

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--days <days>Number of days to show7Yes
--bucket <bucket>Time bucket size (e.g., "1h", "15m", "1d")1hYes
--jsonOutput in JSON format-No

errors dashboard

Get error dashboard statistics

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--days <days>Number of days to show7Yes
--compareCompare to previous period-No
--jsonOutput in JSON format-No

kv

KV store commands (coming soon)

Subcommands:

  • get - Get a value by key
  • set - Set a key-value pair
  • del (delete) - Delete a key
  • keys (ls) - List keys
  • ttl - Get the TTL (time-to-live) for a key
  • expire - Set expiry on an existing key
  • incr - Increment a numeric value
  • enable - Enable KV store for a project
  • disable - Disable KV store for a project
  • status - Get KV store status for a project

kv get

Get a value by key

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Key to retrieve-Yes

kv set

Set a key-value pair

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Key to set-Yes
--value <value>Value to set-Yes
--ttl <seconds>Time-to-live in seconds-Yes

kv del (alias: delete)

Delete a key

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Key to delete-Yes

kv keys (alias: ls)

List keys

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--pattern <pattern>Key pattern to filter by (e.g., "user:*")-Yes
--jsonOutput in JSON format-No

kv ttl

Get the TTL (time-to-live) for a key

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Key to check-Yes

kv expire

Set expiry on an existing key

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Key to set expiry on-Yes
--ttl <seconds>Time-to-live in seconds-Yes

kv incr

Increment a numeric value

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Key to increment-Yes

kv enable

Enable KV store for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes

kv disable

Disable KV store for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes

kv status

Get KV store status for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

blob

Blob storage commands (coming soon)

Subcommands:

  • list (ls) - List blobs in a project
  • upload (put) - Upload a file as a blob
  • delete (rm) - Delete a blob
  • copy (cp) - Copy a blob to a new key
  • download (get) - Download a blob to a local file
  • head - Get blob metadata (size, content type, etc.)
  • enable - Enable blob storage for a project
  • disable - Disable blob storage for a project
  • status - Get blob storage status for a project

blob list (alias: ls)

List blobs in a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--prefix <prefix>Filter by key prefix-Yes
--jsonOutput in JSON format-No

blob upload (alias: put)

Upload a file as a blob

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Blob key (path)-Yes
--file <path>Local file path to upload-Yes

blob delete (alias: rm)

Delete a blob

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Blob key to delete-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation (alias for --force)-No

blob copy (alias: cp)

Copy a blob to a new key

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--source <key>Source blob key-Yes
--dest <key>Destination blob key-Yes

blob download (alias: get)

Download a blob to a local file

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Blob key to download-Yes
--output <path>Local file path to save to-Yes

blob head

Get blob metadata (size, content type, etc.)

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--key <key>Blob key-Yes
--jsonOutput in JSON format-No

blob enable

Enable blob storage for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes

blob disable

Disable blob storage for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes

blob status

Get blob storage status for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

dsn

Manage Data Source Names (DSNs) for error tracking and analytics

Subcommands:

  • list (ls) - List all DSNs for a project
  • create (add) - Create a new DSN for a project
  • get-or-create - Get an existing DSN or create one if none exists
  • regenerate - Regenerate DSN keys (rotate keys)
  • revoke - Revoke (deactivate) a DSN

dsn list (alias: ls)

List all DSNs for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

dsn create (alias: add)

Create a new DSN for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
-n, --name <name>DSN name-Yes
--environment-id <id>Environment ID-Yes
--deployment-id <id>Deployment ID-Yes
--base-url <url>Base URL for the DSN-Yes
-y, --yesSkip confirmation prompts (for automation)-No

dsn get-or-create

Get an existing DSN or create one if none exists

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--environment-id <id>Environment ID-Yes
--deployment-id <id>Deployment ID-Yes
--base-url <url>Base URL for the DSN-Yes
--jsonOutput in JSON format-No

dsn regenerate

Regenerate DSN keys (rotate keys)

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--dsn-id <id>DSN ID-Yes
--base-url <url>New base URL for the DSN-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation (alias for --force)-No

dsn revoke

Revoke (deactivate) a DSN

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--dsn-id <id>DSN ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation (alias for --force)-No

scans (alias: scan)

Manage vulnerability scans

Subcommands:

  • list (ls) - List vulnerability scans for a project
  • trigger - Trigger a new vulnerability scan
  • latest - Get the latest scan for a project
  • environments (envs) - Get latest scans per environment
  • show - Show scan details
  • vulnerabilities (vulns) - List vulnerabilities found in a scan
  • remove (rm) - Delete a vulnerability scan
  • by-deployment - Get the scan for a specific deployment

scans list (alias: ls)

List vulnerability scans for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--page <n>Page number-Yes
--page-size <n>Items per page (default: 20, max: 100)-Yes
--jsonOutput in JSON format-No

scans trigger

Trigger a new vulnerability scan

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--environment-id <id>Environment ID to scan-Yes

scans latest

Get the latest scan for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--environment-id <id>Filter by environment ID-Yes
--jsonOutput in JSON format-No

scans environments (alias: envs)

Get latest scans per environment

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

scans show

Show scan details

Options:

FlagDescriptionDefaultRequired
--id <id>Scan ID-Yes
--jsonOutput in JSON format-No

scans vulnerabilities (alias: vulns)

List vulnerabilities found in a scan

Options:

FlagDescriptionDefaultRequired
--id <id>Scan ID-Yes
--severity <level>Filter by severity (CRITICAL, HIGH, MEDIUM, LOW)-Yes
--jsonOutput in JSON format-No

scans remove (alias: rm)

Delete a vulnerability scan

Options:

FlagDescriptionDefaultRequired
--id <id>Scan ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

scans by-deployment

Get the scan for a specific deployment

Options:

FlagDescriptionDefaultRequired
--deployment-id <id>Deployment ID-Yes
--jsonOutput in JSON format-No

custom-domains (alias: cdom)

Manage project custom domains

Subcommands:

  • list (ls) - List custom domains for a project
  • create (add) - Create a custom domain for a project
  • show - Show custom domain details
  • update - Update a custom domain
  • remove (rm) - Remove a custom domain
  • link-cert - Link a custom domain to a certificate

custom-domains list (alias: ls)

List custom domains for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

custom-domains create (alias: add)

Create a custom domain for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
-d, --domain <domain>Domain name-Yes
--environment-id <id>Environment ID0Yes
--branch <branch>Branch name-Yes
--redirect-to <url>Redirect target URL-Yes
--status-code <code>HTTP status code for redirects-Yes
-y, --yesSkip confirmation prompts (for automation)-No

custom-domains show

Show custom domain details

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--domain-id <id>Custom domain ID-Yes
--jsonOutput in JSON format-No

custom-domains update

Update a custom domain

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--domain-id <id>Custom domain ID-Yes
-d, --domain <domain>New domain name-Yes
--environment-id <id>New environment ID-Yes
--branch <branch>New branch name-Yes
--redirect-to <url>New redirect target URL-Yes
--status-code <code>New HTTP status code for redirects-Yes

custom-domains remove (alias: rm)

Remove a custom domain

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--domain-id <id>Custom domain ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation (alias for --force)-No

custom-domains link-cert

Link a custom domain to a certificate

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--domain-id <id>Custom domain ID-Yes
--certificate-id <id>Certificate ID-Yes

dns-provider (alias: dnsp)

Manage DNS providers and managed domains

Subcommands:

  • list (ls) - List all DNS providers
  • create (add) - Create a new DNS provider
  • show - Show DNS provider details
  • update - Update a DNS provider
  • remove (rm) - Delete a DNS provider
  • test - Test DNS provider connection
  • zones - List DNS zones for a provider
  • domains - Manage domains associated with a DNS provider
  • lookup - Lookup DNS A records for a domain

dns-provider list (alias: ls)

List all DNS providers

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

dns-provider create (alias: add)

Create a new DNS provider

Options:

FlagDescriptionDefaultRequired
-n, --name <name>Provider name-Yes
-t, --type <type>Provider type (cloudflare, route53, digitalocean, namecheap, gcp, azure, manual)-Yes
-d, --description <description>Provider description-Yes
--api-token <token>API token (Cloudflare, DigitalOcean)-Yes
--account-id <id>Cloudflare account ID (optional)-Yes
--access-key-id <key>AWS access key ID-Yes
--secret-access-key <secret>AWS secret access key-Yes
--region <region>AWS region-Yes
--api-user <user>Namecheap API user-Yes
--api-key <key>Namecheap API key-Yes
--username <username>Namecheap username-Yes
--client-ip <ip>Namecheap whitelisted client IP-Yes
--project-id <id>GCP project ID-Yes
--service-account-email <email>GCP service account email-Yes
--private-key-id <id>GCP private key ID-Yes
--private-key <key>GCP private key-Yes
--tenant-id <id>Azure tenant ID-Yes
--client-id <id>Azure client ID-Yes
--client-secret <secret>Azure client secret-Yes
--subscription-id <id>Azure subscription ID-Yes
--resource-group <name>Azure resource group-Yes
-y, --yesSkip confirmation prompts (for automation)-No

dns-provider show

Show DNS provider details

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

dns-provider update

Update a DNS provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-n, --name <name>New provider name-Yes
-d, --description <description>New description-Yes
--api-key <key>New API key/token-Yes
--active <boolean>Set active status (true/false)-Yes

dns-provider remove (alias: rm)

Delete a DNS provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

dns-provider test

Test DNS provider connection

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes

dns-provider zones

List DNS zones for a provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

dns-provider domains

Manage domains associated with a DNS provider

Subcommands:

  • list (ls) - List managed domains for a provider
  • add - Add a managed domain to a provider
  • remove (rm) - Remove a managed domain from a provider
  • verify - Verify a managed domain

dns-provider domains list (alias: ls)

List managed domains for a provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

dns-provider domains add

Add a managed domain to a provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-d, --domain <domain>Domain name-Yes
--auto-manageEnable auto-management for DNS records-No

dns-provider domains remove (alias: rm)

Remove a managed domain from a provider

Options:

FlagDescriptionDefaultRequired
--provider-id <id>Provider ID-Yes
-d, --domain <domain>Domain name-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

dns-provider domains verify

Verify a managed domain

Options:

FlagDescriptionDefaultRequired
--provider-id <id>Provider ID-Yes
-d, --domain <domain>Domain name-Yes

dns-provider lookup

Lookup DNS A records for a domain

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name to lookup-Yes
--jsonOutput in JSON format-No

ip-access (alias: ipa)

Manage IP access control rules

Subcommands:

  • list (ls) - List all IP access control rules
  • create (add) - Create a new IP access control rule
  • show - Show IP access control rule details
  • update - Update an IP access control rule
  • remove (rm) - Delete an IP access control rule
  • check - Check if an IP address is blocked

ip-access list (alias: ls)

List all IP access control rules

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

ip-access create (alias: add)

Create a new IP access control rule

Options:

FlagDescriptionDefaultRequired
--ip <ip_or_cidr>IP address or CIDR range (e.g., "192.168.1.1" or "10.0.0.0/24")-Yes
--action <action>Action to take: "allow" or "deny"-Yes
--description <desc>Optional description/reason for the rule-Yes
-y, --yesSkip confirmation prompts (for automation)-No

ip-access show

Show IP access control rule details

Options:

FlagDescriptionDefaultRequired
--id <id>Rule ID-Yes
--jsonOutput in JSON format-No

ip-access update

Update an IP access control rule

Options:

FlagDescriptionDefaultRequired
--id <id>Rule ID-Yes
--ip <ip>New IP address or CIDR range-Yes
--action <action>New action: "allow" or "deny"-Yes
--description <desc>New description/reason-Yes

ip-access remove (alias: rm)

Delete an IP access control rule

Options:

FlagDescriptionDefaultRequired
--id <id>Rule ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

ip-access check

Check if an IP address is blocked

Options:

FlagDescriptionDefaultRequired
--ip <ip>IP address to check-Yes
--jsonOutput in JSON format-No

audit

View audit logs

Subcommands:

  • list (ls) - List audit logs
  • show - Show audit log details

audit list (alias: ls)

List audit logs

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No
--limit <n>Maximum number of logs to return50Yes
--offset <n>Number of logs to skip-Yes
--operation-type <type>Filter by operation type-Yes
--user-id <id>Filter by user ID-Yes
--from <timestamp>Start timestamp (ISO 8601 or epoch ms)-Yes
--to <timestamp>End timestamp (ISO 8601 or epoch ms)-Yes

audit show

Show audit log details

Options:

FlagDescriptionDefaultRequired
--id <id>Audit log ID-Yes
--jsonOutput in JSON format-No

proxy-logs (alias: plogs)

View proxy request logs and statistics

Subcommands:

  • list (ls) - List proxy logs
  • show - Show proxy log details
  • by-request - Get proxy log by request ID
  • stats - Get time bucket statistics (last 24 hours)
  • today - Get today's request statistics

proxy-logs list (alias: ls)

List proxy logs

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No
--limit <n>Items per page (default: 20, max: 100)-Yes
--page <n>Page number-Yes
--project-id <id>Filter by project ID-Yes
--environment-id <id>Filter by environment ID-Yes
--method <method>Filter by HTTP method (GET, POST, etc.)-Yes
--status-code <code>Filter by HTTP status code-Yes
--host <host>Filter by host-Yes
--path <path>Filter by path (partial match)-Yes
--start-date <date>Start date (ISO 8601)-Yes
--end-date <date>End date (ISO 8601)-Yes
--sort-by <field>Sort by field (default: timestamp)-Yes
--sort-order <order>Sort order: asc or desc (default: desc)-Yes
--is-botFilter for bot requests only-No
--has-errorFilter for requests with errors only-No

proxy-logs show

Show proxy log details

Options:

FlagDescriptionDefaultRequired
--id <id>Proxy log ID-Yes
--jsonOutput in JSON format-No

proxy-logs by-request

Get proxy log by request ID

Options:

FlagDescriptionDefaultRequired
--request-id <id>Request ID-Yes
--jsonOutput in JSON format-No

proxy-logs stats

Get time bucket statistics (last 24 hours)

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

proxy-logs today

Get today's request statistics

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

email-domains (alias: edom)

Manage email domains for transactional email

Subcommands:

  • list (ls) - List all email domains
  • create (add) - Create a new email domain
  • show - Show email domain details
  • remove (rm) - Remove an email domain
  • by-name - Look up an email domain by domain name
  • dns-records - Get DNS records for an email domain
  • setup-dns - Setup DNS records using a configured DNS provider
  • verify - Verify an email domain DNS configuration

email-domains list (alias: ls)

List all email domains

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

email-domains create (alias: add)

Create a new email domain

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name (e.g., mail.example.com)-Yes
--provider-id <id>Email provider ID-Yes
-y, --yesSkip confirmation prompts (for automation)-No

email-domains show

Show email domain details

Options:

FlagDescriptionDefaultRequired
--id <id>Email domain ID-Yes
--jsonOutput in JSON format-No

email-domains remove (alias: rm)

Remove an email domain

Options:

FlagDescriptionDefaultRequired
--id <id>Email domain ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

email-domains by-name

Look up an email domain by domain name

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain name-Yes
--jsonOutput in JSON format-No

email-domains dns-records

Get DNS records for an email domain

Options:

FlagDescriptionDefaultRequired
--id <id>Email domain ID-Yes
--jsonOutput in JSON format-No

email-domains setup-dns

Setup DNS records using a configured DNS provider

Options:

FlagDescriptionDefaultRequired
--id <id>Email domain ID-Yes
--dns-provider-id <id>DNS provider ID to use-Yes

email-domains verify

Verify an email domain DNS configuration

Options:

FlagDescriptionDefaultRequired
--id <id>Email domain ID-Yes

email-providers (alias: eprov)

Manage email providers (SES, Scaleway) for transactional email

Subcommands:

  • list (ls) - List all email providers
  • create (add) - Create a new email provider
  • show - Show email provider details
  • remove (rm) - Remove an email provider
  • test - Test an email provider by sending a test email

email-providers list (alias: ls)

List all email providers

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

email-providers create (alias: add)

Create a new email provider

Options:

FlagDescriptionDefaultRequired
-n, --name <name>Provider name-Yes
-t, --type <type>Provider type (ses, scaleway)-Yes
-r, --region <region>Cloud region-Yes
--access-key-id <key>AWS access key ID (for SES)-Yes
--secret-access-key <secret>AWS secret access key (for SES)-Yes
--api-key <key>Scaleway API key-Yes
--project-id <id>Scaleway project ID-Yes
-y, --yesSkip confirmation prompts (for automation)-No

email-providers show

Show email provider details

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--jsonOutput in JSON format-No

email-providers remove (alias: rm)

Remove an email provider

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

email-providers test

Test an email provider by sending a test email

Options:

FlagDescriptionDefaultRequired
--id <id>Provider ID-Yes
--from <email>Sender email address (must be verified)-Yes
--from-name <name>Sender display name-Yes

incidents (alias: incident)

Manage incidents for status pages and monitoring

Subcommands:

  • list (ls) - List incidents for a project
  • create (add) - Create a new incident
  • show - Show incident details
  • update-status - Update an incident status
  • updates - List status updates for an incident
  • bucketed - Get bucketed incident data for a project

incidents list (alias: ls)

List incidents for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--status <status>Filter by status (investigating, identified, monitoring, resolved)-Yes
--environment-id <id>Filter by environment ID-Yes
--page <n>Page number-Yes
--page-size <n>Items per page-Yes
--jsonOutput in JSON format-No

incidents create (alias: add)

Create a new incident

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
-t, --title <title>Incident title-Yes
-d, --description <description>Incident description-Yes
-s, --severity <severity>Severity level (critical, major, minor)-Yes
-y, --yesSkip confirmation prompts (for automation)-No

incidents show

Show incident details

Options:

FlagDescriptionDefaultRequired
--id <id>Incident ID-Yes
--jsonOutput in JSON format-No

incidents update-status

Update an incident status

Options:

FlagDescriptionDefaultRequired
--id <id>Incident ID-Yes
-s, --status <status>New status (investigating, identified, monitoring, resolved)-Yes
-m, --message <message>Status update message-Yes

incidents updates

List status updates for an incident

Options:

FlagDescriptionDefaultRequired
--id <id>Incident ID-Yes
--jsonOutput in JSON format-No

incidents bucketed

Get bucketed incident data for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
-i, --interval <interval>Bucket interval: 5min, hourly, daily (default: hourly)-Yes
--start-time <time>Start time (ISO 8601)-Yes
--end-time <time>End time (ISO 8601)-Yes
--environment-id <id>Filter by environment ID-Yes
--jsonOutput in JSON format-No

emails (alias: email)

Manage and send emails

Subcommands:

  • list (ls) - List sent emails
  • send - Send an email
  • show - Show email details
  • stats - Get email statistics
  • validate - Validate an email address

emails list (alias: ls)

List sent emails

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No
--page <n>Page number-Yes
--page-size <n>Items per page-Yes
--status <status>Filter by status (sent, delivered, failed)-Yes
--domain-id <id>Filter by domain ID-Yes
--project-id <id>Filter by project ID-Yes
--from-address <email>Filter by sender address-Yes

emails send

Send an email

Options:

FlagDescriptionDefaultRequired
--to <email>Recipient email address-Yes
--subject <subject>Email subject-Yes
--body <body>Email body-Yes
--from <email>Sender email address-Yes
-y, --yesSkip confirmation prompts (for automation)-No

emails show

Show email details

Options:

FlagDescriptionDefaultRequired
--id <id>Email ID-Yes
--jsonOutput in JSON format-No

emails stats

Get email statistics

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

emails validate

Validate an email address

Options:

FlagDescriptionDefaultRequired
--email <email>Email address to validate-Yes
--jsonOutput in JSON format-No

load-balancer (alias: lb)

Manage load balancer routes

Subcommands:

  • list (ls) - List load balancer routes
  • create (add) - Create a load balancer route
  • show - Show route details
  • update - Update a load balancer route
  • remove (rm) - Delete a load balancer route

load-balancer list (alias: ls)

List load balancer routes

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

load-balancer create (alias: add)

Create a load balancer route

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain for the route-Yes
-t, --target <target>Target upstream URL-Yes
-y, --yesSkip confirmation prompts (for automation)-No

load-balancer show

Show route details

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain of the route-Yes
--jsonOutput in JSON format-No

load-balancer update

Update a load balancer route

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain of the route-Yes
-t, --target <target>New target upstream URL-Yes

load-balancer remove (alias: rm)

Delete a load balancer route

Options:

FlagDescriptionDefaultRequired
-d, --domain <domain>Domain of the route-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

imports (alias: import)

Import workloads from external sources

Subcommands:

  • sources (ls) - List available import sources
  • discover - Discover workloads from a source
  • plan - Create an import plan
  • execute - Execute an import
  • status - Get import status

imports sources (alias: ls)

List available import sources

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

imports discover

Discover workloads from a source

Options:

FlagDescriptionDefaultRequired
-s, --source <source>Import source-Yes
--jsonOutput in JSON format-No

imports plan

Create an import plan

Options:

FlagDescriptionDefaultRequired
-s, --source <source>Import source-Yes
-w, --workload <workload>Workload ID to import-Yes

imports execute

Execute an import

Options:

FlagDescriptionDefaultRequired
-s, --source <source>Import source-Yes
-w, --workload <workload>Workload ID to import-Yes
-y, --yesSkip confirmation prompts (for automation)-No

imports status

Get import status

Options:

FlagDescriptionDefaultRequired
--session-id <id>Import session ID-Yes
--jsonOutput in JSON format-No

migrate

Migrate projects from other platforms (Vercel, Coolify, Dokploy)

Subcommands:

  • run - Run the full interactive migration wizard
  • discover - Discover projects on a source platform
  • plan - Generate a migration plan for a project

migrate run

Run the full interactive migration wizard

Options:

FlagDescriptionDefaultRequired
--from <platform>Source platform (vercel, coolify, dokploy)-Yes

migrate discover

Discover projects on a source platform

Options:

FlagDescriptionDefaultRequired
--from <platform>Source platform (vercel, coolify, dokploy)-Yes
--jsonOutput in JSON format-No

migrate plan

Generate a migration plan for a project

Options:

FlagDescriptionDefaultRequired
--from <platform>Source platform (vercel, coolify, dokploy)-Yes
--project <id>Source project ID-Yes

templates (alias: tpl)

Browse deployment templates

Subcommands:

  • list (ls) - List available templates

templates list (alias: ls)

List available templates

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No
--type <type>Filter by project type (server, static)-Yes

platform (alias: plat)

View platform and server information

Subcommands:

  • info - Get platform information
  • access - Get access and networking information
  • private-ip - Get the server private IP address
  • public-ip - Get the server public IP address

platform info

Get platform information

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

platform access

Get access and networking information

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

platform private-ip

Get the server private IP address

platform public-ip

Get the server public IP address

presets (alias: preset)

Browse available build presets

Subcommands:

  • list (ls) - List available presets
  • show (get) - Show details for a specific preset

presets list (alias: ls)

List available presets

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No
--type <type>Filter by project type (server, static)-Yes

presets show (alias: get)

Show details for a specific preset

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

funnels (alias: funnel)

Manage analytics funnels for projects

Subcommands:

  • list (ls) - List all funnels for a project
  • create (add) - Create a new funnel for a project
  • update - Update a funnel
  • remove (rm) - Delete a funnel
  • metrics - Get funnel metrics
  • preview - Preview funnel metrics without saving

funnels list (alias: ls)

List all funnels for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--jsonOutput in JSON format-No

funnels create (alias: add)

Create a new funnel for a project

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
-n, --name <name>Funnel name-Yes
-s, --steps <json>Funnel steps as JSON array (e.g. '[{"event_name":"page_view"},{"event_name":"signup"}]')-Yes
-y, --yesSkip confirmation prompts (for automation)-No

funnels update

Update a funnel

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--funnel-id <id>Funnel ID-Yes
-n, --name <name>New funnel name-Yes
-s, --steps <json>New funnel steps as JSON array-Yes

funnels remove (alias: rm)

Delete a funnel

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--funnel-id <id>Funnel ID-Yes
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

funnels metrics

Get funnel metrics

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
--funnel-id <id>Funnel ID-Yes
--jsonOutput in JSON format-No

funnels preview

Preview funnel metrics without saving

Options:

FlagDescriptionDefaultRequired
--project-id <id>Project ID-Yes
-s, --steps <json>Funnel steps as JSON array-Yes
--jsonOutput in JSON format-No

notification-preferences (alias: notif-prefs)

Manage notification preferences

Subcommands:

  • show (get) - Show current notification preferences
  • update (set) - Update a notification preference
  • reset - Reset notification preferences to defaults

notification-preferences show (alias: get)

Show current notification preferences

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

notification-preferences update (alias: set)

Update a notification preference

Options:

FlagDescriptionDefaultRequired
-k, --key <key>Preference key to update-Yes
-v, --value <value>Value for the preference-Yes

notification-preferences reset

Reset notification preferences to defaults

Options:

FlagDescriptionDefaultRequired
-f, --forceSkip confirmation-No
-y, --yesSkip confirmation prompts (alias for --force)-No

init

Initialize a Temps project in the current directory

Options:

FlagDescriptionDefaultRequired
-n, --name <name>Project name (for new projects)-Yes
-y, --yesSkip confirmation prompts-No

Link current directory to a Temps project

Options:

FlagDescriptionDefaultRequired
-e, --environment <name>Set default environment-Yes

up

Deploy the current project (runs setup wizard if not linked)

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug or ID-Yes
-e, --environment <env>Target environment name-Yes
-b, --branch <branch>Git branch to deploy (auto-detected from cwd)-Yes
-n, --name <name>Project name (for new projects)-Yes
--preset <preset>Framework preset slug (skip auto-detection)-Yes
--manualUse manual deployment mode (no git)-No
--no-servicesSkip external service setup-No
--no-waitDo not wait for deployment to complete-No
-y, --yesSkip confirmation prompts-No

status

Show project deployment status

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug-Yes
-e, --environment <env>Filter by environment-Yes
--jsonOutput in JSON format-No

instances (alias: instance)

Manage Temps server instances

Subcommands:

  • list (ls) - List configured instances
  • add - Add a new instance
  • remove (rm) - Remove an instance
  • switch (use) - Switch to a different instance
  • show - Show instance details (or current instance)

instances list (alias: ls)

List configured instances

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

instances add

Add a new instance

Options:

FlagDescriptionDefaultRequired
-n, --name <name>Instance name-Yes
-u, --url <url>Instance URL-Yes

instances remove (alias: rm)

Remove an instance

instances switch (alias: use)

Switch to a different instance

instances show

Show instance details (or current instance)

Options:

FlagDescriptionDefaultRequired
--jsonOutput in JSON format-No

env:pull

Pull environment variables to a .env file

Options:

FlagDescriptionDefaultRequired
-e, --environment <name>Pull from specific environment-Yes
-p, --project <project>Project slug-Yes

env:push

Push environment variables from a .env file

Options:

FlagDescriptionDefaultRequired
-e, --environment <names>Comma-separated environment names-Yes
-p, --project <project>Project slug-Yes
--overwriteOverwrite existing variables-No

rollback

Rollback to a previous deployment

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug-Yes
-e, --environment <env>Target environmentproductionYes
--to <id>Rollback to specific deployment ID-Yes
-y, --yesSkip confirmation-No

open

Open project URL in browser

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug-Yes
-e, --environment <env>Open specific environment-Yes
--dashboardOpen the dashboard instead of the project URL-No

exec (alias: ssh)

Execute a command in a running container (coming soon)

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug-Yes
-e, --environment <env>Target environment-Yes

dev

Start a local development tunnel (coming soon)

Options:

FlagDescriptionDefaultRequired
-p, --project <project>Project slug-Yes
--port <port>Local port to expose3000Yes

cloud

Temps Cloud

Subcommands:

  • login - Login to Temps Cloud
  • logout - Logout from Temps Cloud
  • whoami - Show current Temps Cloud account
  • vps - Manage cloud VPS instances
  • billing - Manage Temps Cloud billing and subscription

cloud login

Login to Temps Cloud

cloud logout

Logout from Temps Cloud

cloud whoami

Show current Temps Cloud account

cloud vps

Manage cloud VPS instances

Subcommands:

  • list - List VPS instances
  • create - Provision a new VPS instance
  • show - Show VPS instance details and provisioning logs
  • destroy - Destroy a VPS instance
  • retry - Retry failed VPS provisioning
  • credentials - Show VPS panel credentials
  • images - List available OS images
  • locations - List available datacenter locations
  • types - List available server types with pricing

cloud vps list

List VPS instances

Options:

FlagDescriptionDefaultRequired
--jsonOutput as JSON-No

cloud vps create

Provision a new VPS instance

Options:

FlagDescriptionDefaultRequired
--image <image>OS image ID-Yes
--location <location>Datacenter location ID-Yes
--type <type>Server type ID-Yes
--jsonOutput as JSON-No

cloud vps show

Show VPS instance details and provisioning logs

Options:

FlagDescriptionDefaultRequired
--jsonOutput as JSON-No

cloud vps destroy

Destroy a VPS instance

cloud vps retry

Retry failed VPS provisioning

cloud vps credentials

Show VPS panel credentials

Options:

FlagDescriptionDefaultRequired
--jsonOutput as JSON-No

cloud vps images

List available OS images

Options:

FlagDescriptionDefaultRequired
--jsonOutput as JSON-No

cloud vps locations

List available datacenter locations

Options:

FlagDescriptionDefaultRequired
--jsonOutput as JSON-No

cloud vps types

List available server types with pricing

Options:

FlagDescriptionDefaultRequired
--location <location>Filter by datacenter location-Yes
--jsonOutput as JSON-No

cloud billing

Manage Temps Cloud billing and subscription

Subcommands:

  • overview - Show billing overview
  • usage - Show usage and limits
  • upgrade - Upgrade your plan

cloud billing overview

Show billing overview

Options:

FlagDescriptionDefaultRequired
--jsonOutput as JSON-No

cloud billing usage

Show usage and limits

Options:

FlagDescriptionDefaultRequired
--jsonOutput as JSON-No

cloud billing upgrade

Upgrade your plan

Options:

FlagDescriptionDefaultRequired
--yearlyUse yearly billing cycle (default: monthly)-No
--no-browserDon't open browser, just show the URL-No

Examples

Basic Workflow

# Login to Temps
bunx @temps-sdk/cli login

# Create a new project
bunx @temps-sdk/cli projects create --name my-app

# Deploy to production
bunx @temps-sdk/cli deploy --project my-app --environment production

# View deployment logs
bunx @temps-sdk/cli logs --project my-app --follow

# Stream runtime container logs
bunx @temps-sdk/cli runtime-logs --project my-app

# List containers
bunx @temps-sdk/cli containers list --project-id 1 --environment-id 1

Managing Environments

# List environments
bunx @temps-sdk/cli environments list --project my-app

# Set environment variables
bunx @temps-sdk/cli environments vars set --project my-app --key DATABASE_URL --value "postgres://..."

# View environment variables
bunx @temps-sdk/cli environments vars list --project my-app

Managing Domains

# Add a custom domain
bunx @temps-sdk/cli domains add --project my-app --domain app.example.com

# List domains
bunx @temps-sdk/cli domains list --project my-app

# Remove a domain
bunx @temps-sdk/cli domains remove --project my-app --domain app.example.com

Environment Variables

The CLI respects the following environment variables:

VariableDescription
TEMPS_API_URLAPI endpoint URL
TEMPS_API_TOKENAPI authentication token
TEMPS_API_KEYAPI key (alternative to token)
NO_COLORDisable colored output

Configuration

Configuration is stored in:

  • Config file: ~/.temps/config.json
  • Credentials: ~/.temps/.secrets

Use bunx @temps-sdk/cli configure show to view current configuration.

Support

Was this page helpful?