Skip to content
Install

CLI reference

The orchard CLI speaks the same API as the dashboard. Output is human-readable in a terminal and JSON when piped, so your scripts get the same powers you do.

brew install --cask leafdtk/tap/orchard-cli

Every command accepts -o json for machine-readable output, and --org / --env to override the saved context. 428 commands are available.

Threshold alerts on app metrics

orchard alert

Aliases: alerts

Add a rule: —metric cpu_percent —threshold 85 —for 300

orchard alert create
FlagTypeDefaultDescription
--comparatorstringgtgt or lt
--deploymentstringscope to a deployment id
--forint300seconds the condition must hold before it fires
--metricstringmetric id (see orchard alert metrics) (required)
--min-request-ratefloat640skip evaluation below this many requests per second (traffic metrics)
--projectstringscope to a project id
--thresholdfloat640threshold in the metric’s unit (required)

Delete a rule

orchard alert delete <ruleId>

Aliases: rm

List alert rules, including the ones inherited from above

orchard alert list

Aliases: ls

FlagTypeDefaultDescription
--deploymentstringscope to a deployment id
--projectstringscope to a project id

The metrics a rule can watch

orchard alert metrics

Every rule that applies to an app and whether it is firing

orchard alert status <deploymentId>

Change a rule’s threshold, window, or enabled state

orchard alert update <ruleId>
FlagTypeDefaultDescription
--disabledboolfalseturn the rule off
--enabledboolfalseturn the rule on
--forint0new window in seconds
--min-request-ratefloat640new minimum request rate
--thresholdfloat640new threshold

Call any Orchard API operation, or search the API

orchard api <operationId | METHOD path>
FlagTypeDefaultDescription
-d, --datastringrequest body: JSON, @file, or - to read stdin
-p, --path-paramstringArray[]path parameter as name=value (repeatable)
-q, --querystringArray[]query parameter as name=value (repeatable)

Show an operation’s params, body and response schema

orchard api describe <operationId | METHOD path>
FlagTypeDefaultDescription
--refreshboolfalserevalidate the cached spec first

Find API operations by keywords

orchard api search <query...>
FlagTypeDefaultDescription
--limitint10maximum results
--refreshboolfalserevalidate the cached spec first

Inspect the audit log

orchard audit

Aliases: audit-log, audit-logs

List audit log entries for the organization (or one deployment), newest first

orchard audit list

Aliases: ls

FlagTypeDefaultDescription
--actionstringonly entries with this exact action (e.g. deployment.create)
--allboolfalsefetch every page (capped at 100 pages)
--cursorstringresume from a previous nextCursor
--deploymentstringscope to one deployment instead of the whole organization
--limitint50page size

Manage authentication

orchard auth

Authenticate with Orchard

orchard auth login
FlagTypeDefaultDescription
--api-urlstringOrchard instance to sign in to; adds a context for it. Needed without a terminal unless ORCHARD_API_URL is set
--namestringname for this instance’s context (default: its hostname)
--no-browserboolfalseprint the URL instead of opening a browser
--tokenstringpaste a token instead of using the browser
--web-urlstringoverride web app base URL (defaults to the API URL)
--with-tokenboolfalseprompt for a token instead of using the browser

Remove the stored token

orchard auth logout

Manage browser sign-in sessions

orchard auth session

Aliases: sessions

List active browser sessions

orchard auth session list

Aliases: ls

Revoke a browser session (signs that device out)

orchard auth session revoke <sessionId>

Sign out everywhere: revoke all sessions and delete every API token

orchard auth session revoke-all

Show the current authentication state

orchard auth status

Manage personal API tokens (orch_…)

orchard auth token

Aliases: tokens

Create a personal API token (the secret is shown only once)

orchard auth token create
FlagTypeDefaultDescription
--expires-instringlifetime like 30d or 12h (default and max 90d)
--namestringtoken name (required)
--projectstringArray[]restrict the token to a project id or slug (repeatable)
--scopestringArray[]token scope: read|deploy|exec (repeatable; default read)

List your API tokens (secrets are never shown)

orchard auth token list

Aliases: ls

Revoke an API token

orchard auth token revoke <tokenId>

Aliases: delete, rm

Import your Claude Code setup into Orchard (CLAUDE.md, agents, commands, skills, MCP servers)

orchard claude

Import your Claude Code setup (CLAUDE.md, agents, commands, skills, MCP servers)

orchard claude import
FlagTypeDefaultDescription
--dirstringClaude Code config directory (default ~/.claude)
--dry-runboolfalseshow what would be uploaded and exit
--fromstringclaudesource to import from (only “claude”)
--onlystringSlice[]kinds to import: instructions,agent,command,skill,mcp

List the Claude Code setup imported into your account

orchard claude list

Aliases: ls

Remove one imported item from your account

orchard claude remove <kind>/<name>

Aliases: rm

List every command in the CLI (full dump with -o json)

orchard commands
FlagTypeDefaultDescription
-h, --helpboolfalsehelp for commands

Generate the autocompletion script for the specified shell

orchard completion

Generate the autocompletion script for bash

orchard completion bash
FlagTypeDefaultDescription
--no-descriptionsboolfalsedisable completion descriptions

Generate the autocompletion script for fish

orchard completion fish
FlagTypeDefaultDescription
--no-descriptionsboolfalsedisable completion descriptions

Generate the autocompletion script for powershell

orchard completion powershell
FlagTypeDefaultDescription
--no-descriptionsboolfalsedisable completion descriptions

Generate the autocompletion script for zsh

orchard completion zsh
FlagTypeDefaultDescription
--no-descriptionsboolfalsedisable completion descriptions

Manage Docker Compose stacks

orchard compose

Aliases: compose-stack, compose-stacks, stack, stacks

Toggle push-to-deploy for a stack and its service deployments

orchard compose auto-deploy

Disable auto-deploy for the stack

orchard compose auto-deploy disable <stackId>

Enable auto-deploy for the stack

orchard compose auto-deploy enable <stackId>

Delete a compose stack and all of its service deployments

orchard compose delete <stackId>

Aliases: rm

Deploy a compose stack from a GitHub repo’s compose file

orchard compose deploy
FlagTypeDefaultDescription
--auto-deployboolfalserebuild services automatically on pushes to the branch
--githubstringGitHub source as owner/repo[#branch] or a repo URL (required)
--namestringstack name (required)
--pathstringdocker-compose.ymlpath to the compose file in the repo

Show a compose stack and its service deployments

orchard compose get <stackId>

List compose stacks in the current project

orchard compose list

Aliases: ls

Re-pull the compose file and apply it to the stack’s services

orchard compose redeploy <stackId>

Open the app’s language REPL inside a running pod

orchard console <deploymentId>

Aliases: repl

FlagTypeDefaultDescription
--podstringpod to use (default: the first ready pod)
--replstringREPL command to run (default: detected from the app’s language)

Switch between Orchard instances and show the default scope

orchard context

Aliases: ctx

Clear the default scope

orchard context clear

Print the active context name

orchard context current

List the Orchard instances you have signed in to

orchard context list

Aliases: ls

Forget a context and its stored token

orchard context remove <name>

Aliases: rm

Rename a context

orchard context rename <old> <new>

Show the current default scope

orchard context show

Make a context the active one (pick from a list without a name)

orchard context use [name]

Manage databases

orchard db

Aliases: database, databases

Show open sessions and blocked queries (needs a deploy-scope token)

orchard db activity <dbId>

Manage database backups

orchard db backup

Aliases: backups

Trigger a new backup (runs asynchronously)

orchard db backup create <id>
FlagTypeDefaultDescription
--labelstringhuman-readable label for the backup
--timeoutduration10m0sgive up waiting after this long (exit 8)
--typestringbackup type: full|diff|incr (default full)
--waitboolfalseblock until the operation reaches a terminal state

List backups for a database

orchard db backup list <id>

Aliases: ls

Restore a database from a backup, a checkpoint or a point in time (latest when none is given)

orchard db backup restore <id> [backupId]
FlagTypeDefaultDescription
--atstringrestore to a point in time: an ISO time, or “latest”
--checkpointstringrestore to this checkpoint id
--forkboolfalserestore into a new database and leave the original untouched
--namestringname for the new database (with —fork)
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Manage the automated backup schedule

orchard db backup-schedule

Aliases: schedule

Turn off automated backups and WAL archiving (backups already taken are kept)

orchard db backup-schedule clear <id>

Show the backup schedule

orchard db backup-schedule get <id>

Set the backup schedule (—cron, or a preset)

orchard db backup-schedule set <id>
FlagTypeDefaultDescription
--cronstring5-field cron expression in UTC
--dailyboolfalsebackup daily at 02:00 UTC
--hourlyboolfalsebackup every hour
--weeklyboolfalsebackup weekly on Sunday 02:00 UTC

Manage checkpoints (named restore points you can roll back to)

orchard db checkpoint

Aliases: checkpoints, cp

Take a checkpoint of one database, or of every database in the project or environment

orchard db checkpoint create [dbId]
FlagTypeDefaultDescription
--labelstringlabel to find the checkpoint by later

List the checkpoints taken together in one group

orchard db checkpoint group <groupId>

List a database’s checkpoints

orchard db checkpoint list <dbId>

Aliases: ls

Restore a database to a checkpoint (in place, or into a new database with —fork)

orchard db checkpoint restore <checkpointId>
FlagTypeDefaultDescription
--forkboolfalserestore into a new database and leave the original untouched
--namestringname for the new database (with —fork)
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Restore every database in a checkpoint group to that group’s checkpoints

orchard db checkpoint restore-group <groupId>
FlagTypeDefaultDescription
--forkboolfalserestore each into a new database and leave the originals untouched
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Hide a checkpoint so it is no longer offered for restore

orchard db checkpoint rm <checkpointId>

Aliases: delete

Show connection details and credentials (recorded in the audit log)

orchard db connection <id>

Aliases: conn

Create a Postgres database in the current project

orchard db create
FlagTypeDefaultDescription
--cpuint0CPU request in millicores (e.g. 500)
--memorystringmemory request in bytes or with unit (e.g. “512Mi”)
--namestringdatabase display name (required)
--pg-majorint0Postgres major version; choices come from orchard db versions (server default when omitted)
--replicasint0number of Postgres instances, primary included (server default when omitted)
--restore-fromstringpostgres:// URL to seed data from on first boot
--storagestringstorage size, e.g. “1Gi” (server default 1Gi)
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Delete a database (kept in the trash for 30 days when it has a backup)

orchard db delete <id>

Aliases: rm

Explain a database’s health in one call (exits 10 when it is down)

orchard db diagnose <dbId>

Manage Postgres extensions

orchard db extension

Aliases: extensions, ext

Install a Postgres extension

orchard db extension install <id> <name>
FlagTypeDefaultDescription
--preloadboolfalseadd to shared_preload_libraries (causes a database restart)

List available and installed extensions

orchard db extension list <id>

Aliases: ls

Drop a Postgres extension (and objects depending on it)

orchard db extension uninstall <id> <name>
FlagTypeDefaultDescription
--remove-preloadboolfalsealso remove from shared_preload_libraries (causes a database restart)

Copy a database into a new one, from now, a backup, a checkpoint or a point in time

orchard db fork <id>
FlagTypeDefaultDescription
--atstringwhere to copy from: “now” (default), “latest”, or an ISO time
--backupstringstart from this backup id
--checkpointstringstart from this checkpoint id
--namestringname for the new database (server picks one by default)
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Show a database

orchard db get <id>
FlagTypeDefaultDescription
--watchboolfalsekeep re-rendering as the database changes (TTY only)

Inspect logs captured from killed database containers

orchard db killed

List killed-container log captures for a database

orchard db killed list <id>

Aliases: ls

Print the captured logs of a killed database container

orchard db killed logs <id> <entryId>

List databases (scoped to the current project or organization when set)

orchard db list

Aliases: ls

Fetch Postgres logs from the database pod

orchard db logs <id>
FlagTypeDefaultDescription
--tailint200number of log lines to fetch

Show CPU/memory/network usage for the database pod

orchard db metrics <id>
FlagTypeDefaultDescription
--endint640window end (unix-ms, default now)
--startint640window start (unix-ms, default end-1h)
--stepint640sample step in ms (default 30000)

Inspect and control restore, fork, undelete, upgrade and restore test operations

orchard db ops

Aliases: op, operations

Cancel an operation that hasn’t finished

orchard db ops cancel <opId>

Show an operation (—wait blocks until it succeeds or fails)

orchard db ops get <opId>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

List operations on a database, newest first

orchard db ops list <dbId>

Aliases: ls

Swap back to the copy from before an in-place restore (within 24 hours)

orchard db ops undo <opId>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Manage the PgBouncer connection pooler in front of a database

orchard db pooler

Show the pooler’s settings and state

orchard db pooler get <dbId>

Turn the pooler on or off and change its settings

orchard db pooler set <dbId>
FlagTypeDefaultDescription
--enabledstringrun the pooler: on|off
--instancesint0pooler instances (1-3)
--max-client-connint0client connections the pooler accepts (10-5000)
--modestringpool mode: transaction|session
--pool-sizeint0server connections per user and database (1-100)

Show or change deletion protection, DDL checkpoints and scheduled restore tests

orchard db protect <dbId>
FlagTypeDefaultDescription
--ddl-checkpointsstringcheckpoint before destructive DDL: on|off
--deletionstringdeletion protection: on|off
--restore-testsstringscheduled restore tests: on|off

Open an interactive psql session in a sandboxed client pod

orchard db psql <id>

Manage public access

orchard db public

Stop exposing the database publicly

orchard db public disable <id>

Expose the database publicly with TLS

orchard db public enable <id>

Show how far back a database can be restored, and what it can be restored from

orchard db recovery <dbId>

Show or change how standbys confirm writes (async, preferred or required)

orchard db replication

Show the replication mode

orchard db replication get <dbId>

Set the replication mode (preferred and required need at least 2 instances)

orchard db replication set <dbId>
FlagTypeDefaultDescription
--modestringasync|preferred|required (required)

Manage CPU/memory requests

orchard db resources

Update CPU/memory requests (restarts the database pod)

orchard db resources set <id>
FlagTypeDefaultDescription
--cpuint0CPU request in millicores (0 clears back to default)
--memorystringmemory request in bytes or with unit (“512Mi”; 0 clears)

Set a new password and push it to every bound app

orchard db rotate-password <id>
FlagTypeDefaultDescription
-y, --yesboolfalseskip the confirmation

Show the running Postgres version, known CVEs and what fixes them

orchard db security <dbId>

Read or update Postgres parameters

orchard db settings

Show configured Postgres parameters

orchard db settings get <id>

Update Postgres parameters (KEY= removes a parameter)

orchard db settings set <id> KEY=VAL...

Manage the storage volume

orchard db storage

Grow the storage volume (never shrinks)

orchard db storage expand <id>
FlagTypeDefaultDescription
--sizestringnew volume size, e.g. “10Gi” (required)

Prove backups restore: restore the latest one into a throwaway copy and check it

orchard db test-backup

Aliases: restore-test, restore-tests

List past restore tests and their results

orchard db test-backup list <dbId>

Aliases: ls

Start a restore test now (the throwaway copy is deleted afterwards)

orchard db test-backup run <dbId>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

List and bring back deleted databases (kept for 30 days)

orchard db trash

List deleted databases in the current project

orchard db trash list

Aliases: ls

Bring a deleted database back from its backups

orchard db trash restore <deletedId>
FlagTypeDefaultDescription
--namestringname for the restored database (default: its old name)
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Move a database to the newest minor release of its Postgres major

orchard db update <dbId>

Upgrade a database to a newer Postgres major version

orchard db upgrade <dbId>
FlagTypeDefaultDescription
--no-rehearseboolfalseskip the rehearsal on a copy
--timeoutduration10m0sgive up waiting after this long (exit 8)
--toint0target Postgres major, as listed by orchard db versions (required)
--waitboolfalseblock until the operation reaches a terminal state

Manage extra Postgres users with read or write access

orchard db user

Aliases: users

Create a user and print its password once (needs a deploy-scope token)

orchard db user create <dbId> <name>
FlagTypeDefaultDescription
--accessstringreadread|write

List the extra users of a database

orchard db user list <dbId>

Aliases: ls

Drop a user

orchard db user rm <dbId> <name>

Aliases: delete

List the Postgres major versions you can create or upgrade to

orchard db versions

Manage deployments

orchard deploy

Aliases: deployment, deployments

Manage push-to-deploy for GitHub deployments

orchard deploy auto-deploy

Stop auto-deploying on pushes

orchard deploy auto-deploy disable <id>

Rebuild automatically on pushes to a branch

orchard deploy auto-deploy enable <id>
FlagTypeDefaultDescription
--branchstringbranch to auto-deploy from (required)
--pathstringArray[]only build when a push changes this glob (repeatable, prefix ! to ignore, pass —path="" to clear)

Show auto-deploy configuration

orchard deploy auto-deploy status <id>

Databases and apps this app is connected to

orchard deploy bindings

Connect a database or another app and add the obvious variable

orchard deploy bindings add <id> (--database <name|id> | --app <name|id>)
FlagTypeDefaultDescription
--appstringapp name or id on the same project
--asstringbinding name used in ${{resource.<name>.*}} (default: derived from the database name)
--databasestringdatabase name or id on the same project
--envstringenv key to add (default DATABASE_URL for a database, <NAME>_URL for an app)
--no-envboolfalsebind only, don’t add an env var

List bindings

orchard deploy bindings list <id>

Databases and apps on the project that can still be connected

orchard deploy bindings options <id>

Disconnect a resource

orchard deploy bindings remove <id> <name>

Manage how a deployment is built

orchard deploy build-config

Change build settings for a deployment

orchard deploy build-config set <id>
FlagTypeDefaultDescription
--build-cmdstringrailpack: override the detected build command
--build-typestringdockerfile|railpack
--builderstringauto|fast|standard, force or block the fast VM builder
--dockerfilestringpath to the Dockerfile relative to the repo root
--install-cmdstringrailpack: override the detected install command
--output-dirstringrailpack: directory of built static files
--rootstringrailpack: directory of the app inside the repo
--start-cmdstringcommand to run instead of the image CMD; "" uses the image’s own
--targetstringstage to stop at in a multi-stage Dockerfile; "" builds the final stage

Manage the build context of a GitHub deployment

orchard deploy build-root

Build from the repo root (on) or the Dockerfile directory (off)

orchard deploy build-root set <id> <on|off>
FlagTypeDefaultDescription
--depotboolfalsebuild with Depot
--persistent-cacheboolfalsekeep a persistent build cache between builds

Cancel an in-progress build

orchard deploy cancel <id>

Create a deployment from a Docker image or a GitHub repo

orchard deploy create
FlagTypeDefaultDescription
--auto-urlbooltruegenerate a URL when the port is known (protected by default)
--build-cmdstringoverride the detected build command
--build-rootboolfalseuse the repo root as the build context
--cpuint0CPU request in millicores (e.g. 500)
--dockerfilestringpath to the Dockerfile relative to the repo root
--envstringArray[]environment variable KEY=VAL (repeatable)
--env-filestringread environment variables from a dotenv-style file
--gitstringgit provider name (see: orchard git list), used with —repo
--githubstringGitHub source as owner/repo[#branch]
--imagestringDocker image reference (e.g. nginx:latest)
--install-cmdstringoverride the detected install command
--memorystringmemory request in bytes or with unit (e.g. “512Mi”)
--namestringdeployment name (required)
--output-dirstringdirectory of built static files; serves the app as a static site
--portint0port the container listens on (default: the image’s or Dockerfile’s EXPOSE, else 80)
--pull-policystringpin the pull policy instead of deriving it from the tag: always|ifnotpresent (—image only)
--railpackboolfalsebuild with railpack instead of a Dockerfile
--replicasint0number of replicas (server default 1)
--repostringrepository https URL on that provider, with an optional #branch
--rootstringdirectory of the app inside the repo (monorepos)
--start-cmdstringoverride the detected start command
--targetstringstage to stop at in a multi-stage Dockerfile; empty builds the final stage
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Delete a deployment and its Kubernetes resources

orchard deploy delete <id>

Aliases: rm

Manage a deployment’s environment variables

orchard deploy env

Show environment variables

orchard deploy env get <id>

Add or update environment variables (pods restart)

orchard deploy env set <id> [KEY=VAL ...]
FlagTypeDefaultDescription
--filestringread KEY=VAL pairs from a dotenv-style file
--secretboolfalsestore the given vars in a Kubernetes Secret

Remove environment variables (pods restart)

orchard deploy env unset <id> KEY...

Show a deployment

orchard deploy get <id>
FlagTypeDefaultDescription
--watchboolfalsekeep re-rendering as the deployment changes (TTY only)

List GitHub deployment status entries for this deployment

orchard deploy github-deployments <id>

Manage liveness/readiness/startup probes

orchard deploy health-check

Update health check configuration (unset flags keep current values)

orchard deploy health-check set <id>
FlagTypeDefaultDescription
--commandstringexec probe command
--enabledboolfalseenable or disable health checks (—enabled=false to disable)
--intervalint0seconds between probes
--livenessbooltrueenable the liveness probe
--pathstringHTTP probe path (e.g. /healthz)
--portint0probe port
--readinessbooltrueenable the readiness probe
--retriesint0failures before the probe reports unhealthy
--startupboolfalseenable the startup probe
--startup-failure-thresholdint0startup probe failure threshold
--timeoutint0probe timeout in seconds
--typestringprobe type: http|tcp|exec

Show a deployment’s image history

orchard deploy history <id>
FlagTypeDefaultDescription
--logsstringprint build logs for one image history entry

Manage the app picture

orchard deploy icon

Upload an app picture (jpeg/png/gif/webp)

orchard deploy icon set <id> <file>

Manage the Docker image of an image-source deployment

orchard deploy image

Change the image (GitHub-built deployments must use deploy rebuild)

orchard deploy image set <id> <image>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Inspect logs captured from killed containers

orchard deploy killed

List killed-container log captures

orchard deploy killed list <id>

Aliases: ls

Print the captured logs of a killed container

orchard deploy killed logs <id> <entryId>

List deployments (scoped to the current project when one is set)

orchard deploy list

Aliases: ls

Fetch runtime pod logs (or build logs with —build)

orchard deploy logs <id>
FlagTypeDefaultDescription
--buildboolfalsefetch build logs instead of runtime pod logs
-f, --followboolfalsekeep polling for new log lines until interrupted
--tailint100lines of recent logs per pod

Show CPU/memory/network metrics for the last hour

orchard deploy metrics <id>

List a deployment’s pods

orchard deploy pods <id>
FlagTypeDefaultDescription
--liveboolfalsequery Kubernetes directly (includes usage and warnings)

Manage whether the image is re-pulled on every pod start

orchard deploy pull-policy

Override the image pull policy

orchard deploy pull-policy set <id>
FlagTypeDefaultDescription
--policystringpull policy: auto|always|ifnotpresent (required)

Rebuild a deployment from source

orchard deploy rebuild <id>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

List releases, newest first

orchard deploy releases <id>
FlagTypeDefaultDescription
--limitint20how many releases to show

Manage a deployment’s CPU/memory requests

orchard deploy resources

Show CPU/memory requests

orchard deploy resources get <id>

Update CPU/memory requests (0 clears to the organization default; pods restart)

orchard deploy resources set <id>
FlagTypeDefaultDescription
--cpuint0CPU request in millicores (0 clears to the default)
--memorystringmemory request in bytes or with unit, e.g. “512Mi” (0 clears)

Restart a deployment’s pods

orchard deploy restart <id>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Roll a deployment back to a previous image (default: the previous release)

orchard deploy rollback <id> [historyId]
FlagTypeDefaultDescription
--restore-databasesboolfalsealso restore bound databases to before the current release
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Scale a deployment to N replicas

orchard deploy scale <id> <replicas>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Start a stopped deployment; builds the latest held push first when there is one

orchard deploy start <id>
FlagTypeDefaultDescription
--buildboolfalserebuild from source before starting
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Show whether a deployment is live, and if not, why

orchard deploy status <id>
FlagTypeDefaultDescription
--releasestringpin the evaluation to this release id
--sincestringonly count changes observed after this server timestamp (ISO)
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Stop a deployment: scale it to zero and hold pushes until it is started

orchard deploy stop <id>

Manage the Kubernetes update strategy

orchard deploy strategy

Set the update strategy (deployments with volumes require recreate)

orchard deploy strategy set <id>
FlagTypeDefaultDescription
--typestringupdate strategy: rollingupdate|recreate|bluegreen (required)

Manage a deployment’s volumes

orchard deploy volumes

Show attached volumes

orchard deploy volumes get <id>

Replace all volumes with the given volumes

orchard deploy volumes set <id>
FlagTypeDefaultDescription
--volumestringArray[]volume as mountPath=size (repeatable); omit to remove all volumes

Manage deploy webhook trigger tokens

orchard deploy webhook-token

Aliases: webhook-tokens

Create a webhook token that restarts the deployment via POST

orchard deploy webhook-token create <id>
FlagTypeDefaultDescription
--labelstringhuman-readable label for the token

Delete a webhook token

orchard deploy webhook-token delete <id> <tokenId>

Aliases: rm

List webhook tokens (secrets are never shown again)

orchard deploy webhook-token list <id>

Aliases: ls

Check the instance’s isolation and security configuration (superadmin)

orchard doctor
FlagTypeDefaultDescription
--selftestboolfalsealso run the active isolation self-test (creates temporary namespaces and pods)
--timeoutduration10m0show long to wait for the self-test to finish

Manage domains

orchard domain

Aliases: ingress, domains

Add a domain to a deployment

orchard domain create
FlagTypeDefaultDescription
--deploymentstringdeployment id to route traffic to
--hoststringfully-qualified domain name
--pathstring/URL path prefix
--service-portint80port to route to
--tlsbooltrueprovision TLS for the host

Delete a domain

orchard domain delete <domain-id>

Aliases: rm

Show a domain

orchard domain get <domain-id>

List domains

orchard domain list

Aliases: ls

FlagTypeDefaultDescription
--deploymentstringlist domains of this deployment id

Control access protection on a domain

orchard domain protection

Show a domain’s protection mode and bypass secret

orchard domain protection get <domain-id>

Set a domain’s protection mode

orchard domain protection set <domain-id>
FlagTypeDefaultDescription
--modestringprotection mode: none|password|orchard
--passwordstringpassword (required with —mode password)

Update a domain’s host, path, port, or TLS

orchard domain update <domain-id>
FlagTypeDefaultDescription
--hoststringnew domain name
--pathstring/URL path prefix
--redirect-statusint0for a redirect domain: 301, 302, 307 or 308
--redirect-tostringfor a redirect domain: where it sends visitors
--service-portint0port to route to
--tlsbooltrueprovision TLS for the host

Check that a domain’s DNS points at your instance

orchard domain validate-dns <host>

Manage project environments

orchard env

Aliases: environment, envs

Create an environment in the project

orchard env create
FlagTypeDefaultDescription
--namestringenvironment name (required)
--slugstringurl-safe slug (defaults to the slugified name)

Delete an environment and its namespace

orchard env delete <name-or-id>

Aliases: rm

Show an environment

orchard env get [name-or-id]

List environments in the project

orchard env list

Aliases: ls

Write environment variables to a local dotenv file

orchard env pull [env]
FlagTypeDefaultDescription
--deploymentstringmerge this deployment’s own vars on top
--forceboolfalseoverwrite even if the file wasn’t generated by orchard
--outstring.env.orchardoutput file path

Make an environment the project default

orchard env set-default <name-or-id>

Manage shared environment variables

orchard env vars

Aliases: var

List shared variables (secret values are write-only, never returned)

orchard env vars get [env]

Aliases: list, ls

Set shared variables (merged into the existing set)

orchard env vars set [KEY=VAL ...]
FlagTypeDefaultDescription
--filestringread KEY=VALs from a dotenv file
--secretboolfalsemark the variables being set as secret (write-only, encrypted at rest)

Remove shared variables

orchard env vars unset KEY [KEY ...]

Aliases: rm, remove

Stream live events from the organization event bus

orchard events

Tail organization events until interrupted (NDJSON when piped)

orchard events tail
FlagTypeDefaultDescription
--since-idstringreplay events newer than this event id before going live
--typesstringonly show these event types (comma-separated, e.g. deployment.changed,build.changed)

Git providers you have linked with your own token

orchard git

Aliases: git-providers, providers

Connect a git provider

orchard git add --provider <kind> --name <name> --token <token>
FlagTypeDefaultDescription
--namestringshort name used with —git on deploy create
--providerstringgithub | gitlab | gitea | bitbucket | generic
--tokenstringtoken or password
--urlstringbase URL of the host (default: the public instance of the provider)
--usernamestringAtlassian account email for a bitbucket API token, or the username for a generic host

List branches of a repository

orchard git branches <name> <owner/repo>

Inspect a repository the way the new app form does

orchard git detect <name> <owner/repo>
FlagTypeDefaultDescription
--branchstringbranch to inspect (default: the repository default)

List git providers

orchard git list

Disconnect a git provider

orchard git remove <name>

List repositories the token can see

orchard git repos <name>

Show the webhook URL and secret to paste into the forge

orchard git webhook <name>

Manage the GitHub integration

orchard github

Aliases: gh

List a repository’s branches

orchard github branches <owner/repo>

List files and directories in a repository

orchard github contents <owner/repo> [path]

Aliases: ls

FlagTypeDefaultDescription
--branchstringbranch to read from (default: the repo’s default branch)

Show exposed ports, env vars, and build stages of a Dockerfile

orchard github dockerfile-info <owner/repo> <dockerfile-path>
FlagTypeDefaultDescription
--branchstringbranch to read from (default: the repo’s default branch)

Find Dockerfiles in a repository

orchard github dockerfiles <owner/repo>
FlagTypeDefaultDescription
--branchstringbranch to search (default: the repo’s default branch)

Get the GitHub App installation URL

orchard github install
FlagTypeDefaultDescription
--openboolfalseopen the URL in your browser

List GitHub App installations available to your account

orchard github installations

Link your GitHub account (opens the OAuth flow in a browser)

orchard github link
FlagTypeDefaultDescription
--openboolfalseopen the URL in your browser

List repositories you can deploy from

orchard github repos

Aliases: repositories

FlagTypeDefaultDescription
--allboolfalsefetch more pages from the OAuth fallback listing

Show the linked GitHub account and app installations

orchard github status

Unlink your GitHub account

orchard github unlink

Help about any command

orchard help [command]

Import a GitHub repo and deploy it

orchard import <owner/repo[#branch] | url>
FlagTypeDefaultDescription
--namestringoverride the project/deployment name (default: repo name)
--portint0override the detected port
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

View and act on organization invitations sent to you

orchard invitation

Aliases: invitations

Accept a pending invitation

orchard invitation accept <id>

Accept every pending invitation

orchard invitation accept-all

Decline a pending invitation

orchard invitation decline <id>

List your pending invitations

orchard invitation list

Aliases: ls

Manage scheduled jobs (multi-step pipelines)

orchard job

Aliases: jobs

Create a job in the project from a steps file

orchard job create
FlagTypeDefaultDescription
--concurrencystringconcurrency policy: forbid|allow (server default forbid)
--cronstring5-field cron schedule (omit for manual-only)
--descriptionstringoptional description
--namestringjob name, unique within the project (required)
--pausedboolfalsecreate the job with a paused schedule
--stepsstringpath to the steps JSON file (required)
--timezonestringIANA time zone for the schedule (default UTC)

Delete a job, its schedule, and its run history

orchard job delete <id>

Aliases: rm

Show a job and its steps

orchard job get <id>

List jobs in the organization (or the current project when one is set)

orchard job list

Aliases: ls

Pause a job’s schedule (manual runs still work)

orchard job pause <id>

Resume a paused job’s schedule

orchard job resume <id>

Trigger a job run now

orchard job run <id>
FlagTypeDefaultDescription
--allow-concurrentboolfalsestart even if another run is active
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

List a job’s run history, newest first

orchard job runs <id>
FlagTypeDefaultDescription
--allboolfalsefetch every page (capped at 100 pages)
--cursorstringresume from a previous nextCursor
--limitint50page size

Manage a job’s step pipeline

orchard job steps

Replace a job’s entire ordered step list

orchard job steps set <id>
FlagTypeDefaultDescription
--filestringpath to the steps JSON file (required)

Update a job’s name, schedule, or paused state

orchard job update <id>
FlagTypeDefaultDescription
--concurrencystringconcurrency policy: forbid|allow
--cronstringnew 5-field cron ("" for manual-only)
--descriptionstringnew description
--namestringnew job name
--pausedboolfalsepause (true) or resume (false) the schedule

Inspect and manage job runs

orchard job-run

Aliases: job-runs

Cancel an in-progress run (remaining steps are skipped)

orchard job-run cancel <runId>

Show a run: status, timing, and per-step results

orchard job-run get <runId>
FlagTypeDefaultDescription
--watchboolfalsekeep re-rendering as the run progresses (TTY only)

Print step logs (all steps in order, or one with —step)

orchard job-run logs <runId>
FlagTypeDefaultDescription
-f, --followboolfalsepoll for new log lines while the run is active; stops once it finishes
--stepint01-based step number (default: all steps in order)

Show the licenses of the open-source software built into this CLI

orchard licenses

Link this directory to an Orchard project

orchard link
FlagTypeDefaultDescription
--no-gitignoreboolfalseskip adding .orchard/ to the repo .gitignore
--statusboolfalseshow the link in effect for this directory

Fetch or follow a deployment’s logs (shortcut for deploy logs)

orchard logs <deploymentId>
FlagTypeDefaultDescription
--buildboolfalsefetch build logs instead of runtime pod logs
-f, --followboolfalsekeep polling for new log lines until interrupted
--tailint100lines of recent logs per pod

Manage members of the scoped organization

orchard member

Aliases: members

Turn a member’s access back on (projects are not restored)

orchard member enable <memberId>

Invite someone to the organization by email

orchard member invite <email>
FlagTypeDefaultDescription
--rolestringmemberorganization role: owner|admin|member

Manage the organization’s pending invitations

orchard member invites

Aliases: invitations

Cancel a pending invitation

orchard member invites cancel <invitationId>

Aliases: revoke, rm

List pending invitations for the organization

orchard member invites list

Aliases: ls

Resend a pending invitation’s email, or create a new link with no email

orchard member invites resend <invitationId>

List members of the organization

orchard member list

Aliases: ls

Turn off a member’s access (they stay on the list and can be turned back on)

orchard member remove <memberId>

Aliases: rm, disable

Change a member’s organization role (owner|admin|member|guest)

orchard member set-role <memberId> <role>

Manage organization notification channels

orchard notify

Aliases: notification, notifications

Manage notification channels

orchard notify channel

Aliases: channels

Create a notification channel in the organization

orchard notify channel create
FlagTypeDefaultDescription
--emailstringSlice[]recipient email, must be an organization member (email channels, repeatable)
--eventsstringSlice[]events to deliver, comma-separated (required)
--namestringchannel name, 1-100 characters (required)
--projectstringSlice[]limit the channel to a project id (repeatable; default all projects)
--typestringchannel type: discord|slack|webhook|email (required)
--urlstringwebhook URL (discord/slack/webhook channels)

Delete a notification channel and its delivery history

orchard notify channel delete <channelId>

Aliases: rm

List the organization’s notification channels

orchard notify channel list

Aliases: ls

Send a test notification through a channel

orchard notify channel test <channelId>

Update a notification channel

orchard notify channel update <channelId>
FlagTypeDefaultDescription
--all-projectsboolfalseclear the project scope (fire for every project)
--disabledboolfalsepause delivery
--emailstringSlice[]replace the recipient list (email channels, repeatable)
--enabledboolfalseresume delivery
--eventsstringSlice[]replace the delivered events, comma-separated
--namestringnew channel name
--projectstringSlice[]replace the project scope with these project ids (repeatable)
--urlstringnew webhook URL (discord/slack/webhook channels)

List a channel’s recent delivery attempts, newest first

orchard notify deliveries <channelId>
FlagTypeDefaultDescription
--limitint30show at most this many deliveries

Deployment observability: logs, HTTP metrics, errors, runtime

orchard observe

Aliases: obs

Activity feed for a deployment

orchard observe activity <deploymentId>

Aliases: timeline

FlagTypeDefaultDescription
--allboolfalsefetch every page (capped at 100 pages)
--cursorstringresume from a previous nextCursor
--kindsstringcomma list of audit,build,release,pod,error (default: all)
--limitint50page size

Which observability signals are available for this deployment

orchard observe capabilities <deploymentId>

Grouped error log entries with counts and trends

orchard observe errors <deploymentId>
FlagTypeDefaultDescription
--windowstring1htime window (15m, 1h, 6h or 24h)

HTTP request rate, error rate and latency for the last hour

orchard observe http <deploymentId>

Structured logs (level detection, multi-line grouping) with filter and follow

orchard observe logs <deploymentId>
FlagTypeDefaultDescription
--followboolfalsepoll every 3s and print new entries
--levelstringonly entries with this level (debug|info|warn|error|fatal)
--searchstringonly entries containing this substring
--tailint200lines of recent logs to scan (max 20000)

Stat strip: uptime, pods, restarts, cpu/mem, request rate, errors, latency

orchard observe overview <deploymentId>

Detected language/framework (from build logs, image, env vars or dockerfile)

orchard observe runtime <deploymentId>

Open a deployment’s URL in your browser

orchard open [deployment-id]
FlagTypeDefaultDescription
--dashboolfalseopen the deployment’s dashboard page instead of the app URL

Manage organizations

orchard org

Aliases: orgs, organization, organizations

Manage the organization avatar

orchard org avatar

Remove the organization avatar

orchard org avatar delete <slug-or-id>

Aliases: rm

Upload an organization avatar image

orchard org avatar set <slug-or-id> <file>

Organization-wide R2 settings for database backups

orchard org backup-settings

Aliases: backups

Show the scoped organization’s backup settings

orchard org backup-settings get

Update the scoped organization’s backup settings

orchard org backup-settings set
FlagTypeDefaultDescription
--access-keystringR2 access key id (write-only; empty to clear)
--bucketstringR2 bucket name (empty to clear)
--endpointstringR2 endpoint, e.g. https://<account-id>.r2.cloudflarestorage.com (empty to clear)
--regionstringR2 region, usually auto (empty to clear)
--secret-keystringR2 secret access key (write-only; empty to clear)

Show an organization (defaults to the current scope)

orchard org get [slug-or-id]

List organizations you belong to

orchard org list

Aliases: ls

Manage default registry credentials for the scoped organization

orchard org registry

Aliases: registries, pull-secret

List organization registry defaults

orchard org registry list

Aliases: ls

Remove a registry credential

orchard org registry remove <id>

Aliases: rm, delete

Add or replace the credential for a registry (ghcr.io, docker.io, registry.gitlab.com, …)

orchard org registry set <registry>
FlagTypeDefaultDescription
-p, --passwordstringpassword or access token
--password-stdinboolfalseread the password or token from stdin
-u, --usernamestringregistry username

Update an organization

orchard org update <slug-or-id>
FlagTypeDefaultDescription
--namestringnew display name
--postgres-auto-updateboolfalselet Orchard roll Postgres minor updates on this organization’s databases (admins only)
--public-ipstringpublic IP advertised for exposed databases (empty to clear)
--subdomainstringcustom subdomain (empty to clear)

Org dashboard: projects, deployments, and databases at a glance

orchard overview
FlagTypeDefaultDescription
--allboolfalseevery organization you belong to, with what each holds
--buildsboolfalseinclude the recent build feed

Inspect and interact with running pods

orchard pod

Aliases: pods

Delete a pod (its controller will replace it)

orchard pod delete <name>

Aliases: rm

FlagTypeDefaultDescription
-n, --namespacestringkubernetes namespace (default: the scoped project’s namespace)

Run a one-shot command in a pod (like kubectl exec)

orchard pod exec <name> -- <cmd...>
FlagTypeDefaultDescription
-c, --containerstringcontainer name (default: the pod’s first container)
-n, --namespacestringkubernetes namespace (default: the scoped project’s namespace)

Show a pod’s status, containers, and node

orchard pod get <name>
FlagTypeDefaultDescription
-n, --namespacestringkubernetes namespace (default: the scoped project’s namespace)

List pods in a namespace

orchard pod list

Aliases: ls

FlagTypeDefaultDescription
-n, --namespacestringkubernetes namespace (default: the scoped project’s namespace)

Fetch runtime logs from a pod

orchard pod logs <name>
FlagTypeDefaultDescription
-c, --containerstringcontainer name (default: the pod’s only container)
-f, --followboolfalsekeep polling for new log lines until interrupted
-n, --namespacestringkubernetes namespace (default: the scoped project’s namespace)
--previousboolfalselogs from the previous (terminated) container instance
--tailint100number of log lines to fetch

Open an interactive shell in a pod

orchard pod shell <name>
FlagTypeDefaultDescription
-c, --containerstringcontainer name (default: the pod’s first container)
-n, --namespacestringkubernetes namespace (default: the scoped project’s namespace)

Manage projects

orchard project

Aliases: projects, proj

Manage the project background image

orchard project background

Upload a background image for the scoped project (jpeg/png/webp, max 8MB)

orchard project background set <file>

Create a project in the scoped organization

orchard project create
FlagTypeDefaultDescription
--descriptionstringproject description
--namestringproject name (required)
--slugstringurl slug (default: derived from the name)

Delete a project and everything in it

orchard project delete <project>

Aliases: rm

Show a project

orchard project get <project>

Manage the project icon

orchard project icon

Upload a project icon (jpeg/png/gif/webp, max 2MB)

orchard project icon set <project> <file>

Manage pending invitations for the scoped project

orchard project invitation

Aliases: invitations, invite

Revoke a pending project invitation

orchard project invitation revoke <invitationId>

List projects (all organizations, or the scoped one)

orchard project list

Aliases: ls

Manage members of the scoped project

orchard project member

Aliases: members

Add an organization member to the project (emails without an account get an invitation)

orchard project member add <email>
FlagTypeDefaultDescription
--rolestringmemberproject role: admin|member|viewer

List project members

orchard project member list

Aliases: ls

Remove a member from the project

orchard project member remove <memberId>

Aliases: rm

Change a member’s project role (admin|member|viewer)

orchard project member set-role <memberId> <role>

Manage credentials for pulling private images into the scoped project

orchard project registry

Aliases: registries, pull-secret

List the registries this project can pull private images from

orchard project registry list

Aliases: ls

Remove a registry credential

orchard project registry remove <id>

Aliases: rm, delete

Add or replace the credential for a registry (ghcr.io, docker.io, registry.gitlab.com, …)

orchard project registry set <registry>
FlagTypeDefaultDescription
-p, --passwordstringpassword or access token
--password-stdinboolfalseread the password or token from stdin
-u, --usernamestringregistry username

Pull live Kubernetes state for the project into Orchard

orchard project sync <project>

Transfer ownership of a project to another member

orchard project transfer

Accept ownership of a project offered to you

orchard project transfer accept <requestId>

Withdraw the scoped project’s pending ownership transfer

orchard project transfer cancel

Decline ownership of a project offered to you

orchard project transfer decline <requestId>

List ownership transfers waiting on you

orchard project transfer list

Aliases: ls

Ask another project member to take ownership of the scoped project

orchard project transfer request <email|userId>

Update project fields

orchard project update <project>
FlagTypeDefaultDescription
--background-imagestringbackground image URL (empty string clears)
--descriptionstringnew description (empty string clears)
--iconstringicon emoji or image URL (empty string clears)
--namestringnew project name
--repository-urlstringlinked repository URL (empty string clears)

Inspect resource quotas and usage for the organization

orchard quota

Aliases: quotas

Show your own allowance, usage and remaining allowance in the organization

orchard quota me

Show per-member allowances and usage (organization admins)

orchard quota members

Show per-project caps and usage (organization admins)

orchard quota projects

Show organization-wide usage against its caps

orchard quota show

Manage Greenhouse cloud dev sandboxes

orchard sandbox

Aliases: sb

Send a message to the claude agent in a sandbox

orchard sandbox chat <name> [message...]
FlagTypeDefaultDescription
-m, --messagestringmessage to send (default: the remaining args, or stdin)

List and manage Cloud Code conversations in a sandbox

orchard sandbox conversations <sandbox>

Aliases: convos

FlagTypeDefaultDescription
--deletestringdelete a conversation by id
--historystringprint a conversation transcript as json by conversation id
--newstringcreate a conversation with this title
--renamestringrename: <conversation-id>=<new title>

Create a cloud dev sandbox

orchard sandbox create [name]
FlagTypeDefaultDescription
--identitystringssh identity name or id (default: your only identity)
--repostringgit repository URL to clone into the sandbox
--runnerstringwhere the sandbox runs: kubernetes|vercel (default: the instance default)
--setupstringsetup script file run once on first boot (- reads stdin)
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Manage agent tokens injected into your sandboxes

orchard sandbox credentials

Remove stored sandbox agent tokens

orchard sandbox credentials clear
FlagTypeDefaultDescription
--claudeboolfalseclear the claude token
--openaiboolfalseclear the openai token

Store agent tokens (claude code / openai) for your sandboxes

orchard sandbox credentials set
FlagTypeDefaultDescription
--claudestringclaude code oauth token from claude setup-token (- reads stdin)
--openaistringopenai/codex token (- reads stdin)

Show which sandbox agent tokens are configured (never the values)

orchard sandbox credentials status

Delete a sandbox and its home volume

orchard sandbox delete <name>

Aliases: rm

Show git changes inside the sandbox workspace

orchard sandbox diff <name>
FlagTypeDefaultDescription
--filestringlimit the diff to one file
--statboolfalselist changed files instead of the diff

Fork a machine you own into a new one with the same disk and sessions

orchard sandbox fork <sandbox>
FlagTypeDefaultDescription
--namestringName of the new machine (defaults to <name>-fork)
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Show a sandbox

orchard sandbox get <name>

Attach Orchard projects so their env vars land in the sandbox

orchard sandbox link

Aliases: links

Attach a project environment to a sandbox (host only); —env picks the environment

orchard sandbox link add <sandbox> <project>

List projects attached to a sandbox

orchard sandbox link list <sandbox>

Aliases: ls

Detach a project from a sandbox (host only)

orchard sandbox link remove <sandbox> <project>

Aliases: rm

List your sandboxes

orchard sandbox list

Aliases: ls

Manage git repositories inside a sandbox

orchard sandbox repo

Clone another repository into a sandbox

orchard sandbox repo add <sandbox> <repo-url>

Set the icon a repository shows in Greenhouse

orchard sandbox repo icon <sandbox> <repo> [icon]
FlagTypeDefaultDescription
--clearboolfalseremove the icon

List repositories cloned into a sandbox

orchard sandbox repo list <sandbox>

Aliases: ls

Retry a sandbox’s failed Kubernetes or Vercel changes

orchard sandbox retry <name>

Manage worktree agent sessions inside a sandbox

orchard sandbox session

Aliases: sessions

Archive a session (removes the worktree, keeps the branch)

orchard sandbox session archive <sandbox> <session>
FlagTypeDefaultDescription
--restoreboolfalseRestore an archived session instead

Start a session on a fresh git worktree (branch orchard/<slug>)

orchard sandbox session create <sandbox> <repo>
FlagTypeDefaultDescription
--agentstringCoding agent: opencode (default), acp:claude, acp:opencode, acp:fx or acp:codex
--basestringBase branch (defaults to the repo’s default branch)
--promptstringFirst prompt for the agent
--titlestringSession title

List sessions with their branch, diffstat and PR

orchard sandbox session list <sandbox>

Aliases: ls

FlagTypeDefaultDescription
--allboolfalseInclude archived sessions

Deploy a session branch as a gh-<slug> preview environment (host only)

orchard sandbox session preview <sandbox> <session>
FlagTypeDefaultDescription
--deploymentstringDeployment id whose config is copied
--removeboolfalseTear the preview environment down instead

Send a prompt to a session’s agent as yourself (reads stdin with - or no text)

orchard sandbox session prompt <sandbox> <session> [text|-]

Print the latest messages of a session’s agent chat

orchard sandbox session transcript <sandbox> <session>
FlagTypeDefaultDescription
--limitint0How many of the latest messages to show (1-200, default 30)

Read-only share links for organization teammates (transcript and diff only)

orchard sandbox share

Create a share link (the token is shown once)

orchard sandbox share create <sandbox>
FlagTypeDefaultDescription
--expires-inint0Hours until the link expires (1-720, default 168)
--sessionstringShare one session (id or slug) instead of every active session

List share links and whether they are active, expired or revoked

orchard sandbox share list <sandbox>

Aliases: ls

Revoke a share link; viewers lose access on their next request

orchard sandbox share revoke <sandbox> <link-id>

SSH into a sandbox through the orchard tunnel

orchard sandbox ssh <name> [-- ssh-args...]
FlagTypeDefaultDescription
--startboolfalsestart the sandbox first if it is stopped
--userstringdevssh user

Print ssh config Host blocks, or —install a wildcard orchard-* entry into ~/.ssh/config

orchard sandbox ssh-config [name]
FlagTypeDefaultDescription
--installboolfalsegenerate an orchard ssh key, register it, and wire ssh orchard-&lt;name&gt; into ~/.ssh/config

Start a stopped sandbox

orchard sandbox start <name>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Stop a sandbox (its home volume is kept)

orchard sandbox stop <name>
FlagTypeDefaultDescription
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the operation reaches a terminal state

Rename a sandbox or switch its ssh identity

orchard sandbox update <name>
FlagTypeDefaultDescription
--identitystringssh identity name or id to switch to
--namestringnew sandbox name
--no-setupboolfalseremove the setup script
--setupstringsetup script file run once on first boot (- reads stdin)

Show a machine’s CPU, memory, disk and time limits

orchard sandbox usage <sandbox>

Manage deployment services and ports

orchard service

Aliases: services, svc

Create a service exposing a port on a deployment

orchard service create
FlagTypeDefaultDescription
-d, --deploymentstringdeployment id
--domainstringcustom domain for the service
--namestringservice name (default: port-<port>)
--node-portint0explicit public port
--portint0service port (required)
--protocolstringTCPport protocol (TCP|UDP)
--publicboolfalseexpose the service publicly
--target-portint0container port to route to (default: —port)

Delete a service from a deployment

orchard service delete <service-id>

Aliases: rm

FlagTypeDefaultDescription
-d, --deploymentstringdeployment id

Manage service exposure

orchard service exposure

Switch a service between public and internal

orchard service exposure set <service-id> <public|internal>
FlagTypeDefaultDescription
-d, --deploymentstringdeployment id

List services for a deployment

orchard service list

Aliases: ls

FlagTypeDefaultDescription
-d, --deploymentstringdeployment id

Manage individual service ports

orchard service port

Toggle public exposure of a single service port

orchard service port public

Stop exposing a single service port publicly

orchard service port public disable <service-id> <port-id>
FlagTypeDefaultDescription
-d, --deploymentstringdeployment id

Expose a single service port publicly

orchard service port public enable <service-id> <port-id>
FlagTypeDefaultDescription
-d, --deploymentstringdeployment id

Update a service’s ports or domain

orchard service update <service-id>
FlagTypeDefaultDescription
-d, --deploymentstringdeployment id
--domainstringcustom domain for the service (empty clears it)
--node-portint0explicit public port
--portint0service port
--protocolstringTCPport protocol (TCP|UDP)
--target-portint0container port to route to (default: —port)

Manage the ssh identities your Greenhouse sandboxes accept

orchard ssh-identity

Aliases: ssh-key, identity

Register an ssh public key as a named identity

orchard ssh-identity add <name>
FlagTypeDefaultDescription
--keystringssh public key: literal, @file, or a file path

Import your public ssh keys from GitHub as identities

orchard ssh-identity import-github

List your ssh identities

orchard ssh-identity list

Aliases: ls

Delete an ssh identity

orchard ssh-identity remove <name>

Aliases: rm

Public status pages for an organization

orchard status-page

Aliases: status-pages, statuspage

Create a page: —title ‘Acme status’ —slug acme —component deployment:<id>

orchard status-page create
FlagTypeDefaultDescription
--componentstringSlice[]deployment:<id> or database:<id>, in order (repeatable)
--descriptionstringone line under the title
--privateboolfalsecreate hidden; nothing renders until it is public
--slugstringpath slug (default: the organization slug)
--subdomainstringhost under the apps domain
--titlestringpage title (default: ‘<organization> status’)

Delete a page and its host

orchard status-page delete <pageId>

Aliases: rm

List the organization’s status pages

orchard status-page list

Aliases: ls

Apps and databases a page can list

orchard status-page options

Read a public status page the way a visitor does

orchard status-page show [slug]
FlagTypeDefaultDescription
--hoststringresolve the page from its host instead of a slug

Change a page’s title, slug, host, visibility or components

orchard status-page update <pageId>
FlagTypeDefaultDescription
--componentstringSlice[]replace the components with deployment:<id> or database:<id> (repeatable)
--descriptionstringnew description
--no-subdomainboolfalseremove the host
--privateboolfalsehide the page
--publicboolfalsemake the page public
--slugstringnew slug
--subdomainstringnew host under the apps domain
--titlestringnew title

Expose deployments on your Tailscale network

orchard tailscale

Aliases: ts

Expose a deployment on your tailnet through a proxy pod

orchard tailscale expose <deploymentId>

Show a deployment’s Tailscale exposure

orchard tailscale get <deploymentId>

Link your Tailscale account with an auth key

orchard tailscale link
FlagTypeDefaultDescription
--auth-keystringTailscale auth key (tskey-auth-…); falls back to ORCHARD_TS_AUTHKEY or a stdin prompt

Show whether a Tailscale account is linked

orchard tailscale status

Remove a deployment’s Tailscale exposure

orchard tailscale unexpose <deploymentId>

Unlink your Tailscale account

orchard tailscale unlink

Deploy prebuilt app stacks from templates

orchard template

Aliases: templates, tpl

Create a template from a YAML definition file

orchard template admin create
FlagTypeDefaultDescription
--filestringpath to the template YAML definition (required)

Delete a template (fails while instances of it exist)

orchard template admin delete <id>

Aliases: rm

Replace a template’s YAML definition (built-ins can’t be updated)

orchard template admin update <id>
FlagTypeDefaultDescription
--filestringpath to the template YAML definition (required)

Deploy a template into the current project

orchard template deploy <templateId>
FlagTypeDefaultDescription
--cpuint0CPU request override in millicores for created resources
--memorystringmemory request override in bytes or with unit (e.g. “512Mi”)
--paramstringArray[]template parameter KEY=VAL (repeatable)

Show a template with its parameters and resources

orchard template get <id>

Manage deployed template instances

orchard template instance

Aliases: instances

Delete a template instance and every resource it created

orchard template instance delete <id>

Aliases: rm

Show a template instance and the resources it created

orchard template instance get <id>

List template instances in the current project

orchard template instance list

Aliases: ls

List available templates

orchard template list

Aliases: ls

Live pods, resources and traffic for one app, or one database with —db

orchard top <id>
FlagTypeDefaultDescription
--dbboolfalsethe id is a database
--onceboolfalseprint one snapshot and exit

Launch the interactive dashboard

orchard ui

Aliases: dash, tui

Remove the directory link created by orchard link

orchard unlink

Deploy the current directory

orchard up [dir]
FlagTypeDefaultDescription
--build-cmdstringoverride the detected build command
--detachboolfalsestart the build without following its logs
--dockerfilestringDockerfile path relative to the directory
--install-cmdstringoverride the detected install command
--namestringdeployment name (default: directory name)
--output-dirstringdirectory of built static files; serves the app as a static site
--portint0port the app listens on (default: EXPOSE, the base image’s port, or 3000)
--railpackboolfalseforce a Railpack build even when a Dockerfile exists
--rootstringdirectory of the app inside the repo (monorepos)
--start-cmdstringoverride the detected start command
--timeoutduration10m0sgive up waiting after this long (exit 8)
--waitboolfalseblock until the deploy is live; —wait=false returns when the build finishes

Set the default org/project/env for future commands

orchard use <org|project|env> <id-or-slug>

Manage your user profile

orchard user

Manage your avatar image

orchard user avatar

Remove your avatar

orchard user avatar delete

Aliases: rm

Upload an avatar image (jpeg/png/gif/webp, max 5MB)

orchard user avatar set <file>

Show your profile

orchard user profile

Update your profile (only flagged fields change)

orchard user profile update
FlagTypeDefaultDescription
--first-namestringnew first name ("" to clear)
--last-namestringnew last name ("" to clear)
--usernamestringnew username (must be unique)

Print the CLI version

orchard version

Trigger deploy webhooks

orchard webhook

Aliases: webhooks

Trigger a deployment via a webhook token (no sign-in required)

orchard webhook deploy <token>
FlagTypeDefaultDescription
--imagestringswitch to this image before restarting (Docker-image deployments only)
--tagstringimage tag to deploy (server defaults to latest when only —image is set)