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-cliEvery command accepts -o json for machine-readable output, and --org / --env to
override the saved context. 428 commands are available.
orchard alert
Section titled “orchard alert”Threshold alerts on app metrics
orchard alertAliases: alerts
orchard alert create
Section titled “orchard alert create”Add a rule: —metric cpu_percent —threshold 85 —for 300
orchard alert create| Flag | Type | Default | Description |
|---|---|---|---|
--comparator | string | gt | gt or lt |
--deployment | string | scope to a deployment id | |
--for | int | 300 | seconds the condition must hold before it fires |
--metric | string | metric id (see orchard alert metrics) (required) | |
--min-request-rate | float64 | 0 | skip evaluation below this many requests per second (traffic metrics) |
--project | string | scope to a project id | |
--threshold | float64 | 0 | threshold in the metric’s unit (required) |
orchard alert delete
Section titled “orchard alert delete”Delete a rule
orchard alert delete <ruleId>Aliases: rm
orchard alert list
Section titled “orchard alert list”List alert rules, including the ones inherited from above
orchard alert listAliases: ls
| Flag | Type | Default | Description |
|---|---|---|---|
--deployment | string | scope to a deployment id | |
--project | string | scope to a project id |
orchard alert metrics
Section titled “orchard alert metrics”The metrics a rule can watch
orchard alert metricsorchard alert status
Section titled “orchard alert status”Every rule that applies to an app and whether it is firing
orchard alert status <deploymentId>orchard alert update
Section titled “orchard alert update”Change a rule’s threshold, window, or enabled state
orchard alert update <ruleId>| Flag | Type | Default | Description |
|---|---|---|---|
--disabled | bool | false | turn the rule off |
--enabled | bool | false | turn the rule on |
--for | int | 0 | new window in seconds |
--min-request-rate | float64 | 0 | new minimum request rate |
--threshold | float64 | 0 | new threshold |
orchard api
Section titled “orchard api”Call any Orchard API operation, or search the API
orchard api <operationId | METHOD path>| Flag | Type | Default | Description |
|---|---|---|---|
-d, --data | string | request body: JSON, @file, or - to read stdin | |
-p, --path-param | stringArray | [] | path parameter as name=value (repeatable) |
-q, --query | stringArray | [] | query parameter as name=value (repeatable) |
orchard api describe
Section titled “orchard api describe”Show an operation’s params, body and response schema
orchard api describe <operationId | METHOD path>| Flag | Type | Default | Description |
|---|---|---|---|
--refresh | bool | false | revalidate the cached spec first |
orchard api search
Section titled “orchard api search”Find API operations by keywords
orchard api search <query...>| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 10 | maximum results |
--refresh | bool | false | revalidate the cached spec first |
orchard audit
Section titled “orchard audit”Inspect the audit log
orchard auditAliases: audit-log, audit-logs
orchard audit list
Section titled “orchard audit list”List audit log entries for the organization (or one deployment), newest first
orchard audit listAliases: ls
| Flag | Type | Default | Description |
|---|---|---|---|
--action | string | only entries with this exact action (e.g. deployment.create) | |
--all | bool | false | fetch every page (capped at 100 pages) |
--cursor | string | resume from a previous nextCursor | |
--deployment | string | scope to one deployment instead of the whole organization | |
--limit | int | 50 | page size |
orchard auth
Section titled “orchard auth”Manage authentication
orchard authorchard auth login
Section titled “orchard auth login”Authenticate with Orchard
orchard auth login| Flag | Type | Default | Description |
|---|---|---|---|
--api-url | string | Orchard instance to sign in to; adds a context for it. Needed without a terminal unless ORCHARD_API_URL is set | |
--name | string | name for this instance’s context (default: its hostname) | |
--no-browser | bool | false | print the URL instead of opening a browser |
--token | string | paste a token instead of using the browser | |
--web-url | string | override web app base URL (defaults to the API URL) | |
--with-token | bool | false | prompt for a token instead of using the browser |
orchard auth logout
Section titled “orchard auth logout”Remove the stored token
orchard auth logoutorchard auth session
Section titled “orchard auth session”Manage browser sign-in sessions
orchard auth sessionAliases: sessions
orchard auth session list
Section titled “orchard auth session list”List active browser sessions
orchard auth session listAliases: ls
orchard auth session revoke
Section titled “orchard auth session revoke”Revoke a browser session (signs that device out)
orchard auth session revoke <sessionId>orchard auth session revoke-all
Section titled “orchard auth session revoke-all”Sign out everywhere: revoke all sessions and delete every API token
orchard auth session revoke-allorchard auth status
Section titled “orchard auth status”Show the current authentication state
orchard auth statusorchard auth token
Section titled “orchard auth token”Manage personal API tokens (orch_…)
orchard auth tokenAliases: tokens
orchard auth token create
Section titled “orchard auth token create”Create a personal API token (the secret is shown only once)
orchard auth token create| Flag | Type | Default | Description |
|---|---|---|---|
--expires-in | string | lifetime like 30d or 12h (default and max 90d) | |
--name | string | token name (required) | |
--project | stringArray | [] | restrict the token to a project id or slug (repeatable) |
--scope | stringArray | [] | token scope: read|deploy|exec (repeatable; default read) |
orchard auth token list
Section titled “orchard auth token list”List your API tokens (secrets are never shown)
orchard auth token listAliases: ls
orchard auth token revoke
Section titled “orchard auth token revoke”Revoke an API token
orchard auth token revoke <tokenId>Aliases: delete, rm
claude
Section titled “claude”orchard claude
Section titled “orchard claude”Import your Claude Code setup into Orchard (CLAUDE.md, agents, commands, skills, MCP servers)
orchard claudeorchard claude import
Section titled “orchard claude import”Import your Claude Code setup (CLAUDE.md, agents, commands, skills, MCP servers)
orchard claude import| Flag | Type | Default | Description |
|---|---|---|---|
--dir | string | Claude Code config directory (default ~/.claude) | |
--dry-run | bool | false | show what would be uploaded and exit |
--from | string | claude | source to import from (only “claude”) |
--only | stringSlice | [] | kinds to import: instructions,agent,command,skill,mcp |
orchard claude list
Section titled “orchard claude list”List the Claude Code setup imported into your account
orchard claude listAliases: ls
orchard claude remove
Section titled “orchard claude remove”Remove one imported item from your account
orchard claude remove <kind>/<name>Aliases: rm
commands
Section titled “commands”orchard commands
Section titled “orchard commands”List every command in the CLI (full dump with -o json)
orchard commands| Flag | Type | Default | Description |
|---|---|---|---|
-h, --help | bool | false | help for commands |
completion
Section titled “completion”orchard completion
Section titled “orchard completion”Generate the autocompletion script for the specified shell
orchard completionorchard completion bash
Section titled “orchard completion bash”Generate the autocompletion script for bash
orchard completion bash| Flag | Type | Default | Description |
|---|---|---|---|
--no-descriptions | bool | false | disable completion descriptions |
orchard completion fish
Section titled “orchard completion fish”Generate the autocompletion script for fish
orchard completion fish| Flag | Type | Default | Description |
|---|---|---|---|
--no-descriptions | bool | false | disable completion descriptions |
orchard completion powershell
Section titled “orchard completion powershell”Generate the autocompletion script for powershell
orchard completion powershell| Flag | Type | Default | Description |
|---|---|---|---|
--no-descriptions | bool | false | disable completion descriptions |
orchard completion zsh
Section titled “orchard completion zsh”Generate the autocompletion script for zsh
orchard completion zsh| Flag | Type | Default | Description |
|---|---|---|---|
--no-descriptions | bool | false | disable completion descriptions |
compose
Section titled “compose”orchard compose
Section titled “orchard compose”Manage Docker Compose stacks
orchard composeAliases: compose-stack, compose-stacks, stack, stacks
orchard compose auto-deploy
Section titled “orchard compose auto-deploy”Toggle push-to-deploy for a stack and its service deployments
orchard compose auto-deployorchard compose auto-deploy disable
Section titled “orchard compose auto-deploy disable”Disable auto-deploy for the stack
orchard compose auto-deploy disable <stackId>orchard compose auto-deploy enable
Section titled “orchard compose auto-deploy enable”Enable auto-deploy for the stack
orchard compose auto-deploy enable <stackId>orchard compose delete
Section titled “orchard compose delete”Delete a compose stack and all of its service deployments
orchard compose delete <stackId>Aliases: rm
orchard compose deploy
Section titled “orchard compose deploy”Deploy a compose stack from a GitHub repo’s compose file
orchard compose deploy| Flag | Type | Default | Description |
|---|---|---|---|
--auto-deploy | bool | false | rebuild services automatically on pushes to the branch |
--github | string | GitHub source as owner/repo[#branch] or a repo URL (required) | |
--name | string | stack name (required) | |
--path | string | docker-compose.yml | path to the compose file in the repo |
orchard compose get
Section titled “orchard compose get”Show a compose stack and its service deployments
orchard compose get <stackId>orchard compose list
Section titled “orchard compose list”List compose stacks in the current project
orchard compose listAliases: ls
orchard compose redeploy
Section titled “orchard compose redeploy”Re-pull the compose file and apply it to the stack’s services
orchard compose redeploy <stackId>console
Section titled “console”orchard console
Section titled “orchard console”Open the app’s language REPL inside a running pod
orchard console <deploymentId>Aliases: repl
| Flag | Type | Default | Description |
|---|---|---|---|
--pod | string | pod to use (default: the first ready pod) | |
--repl | string | REPL command to run (default: detected from the app’s language) |
context
Section titled “context”orchard context
Section titled “orchard context”Switch between Orchard instances and show the default scope
orchard contextAliases: ctx
orchard context clear
Section titled “orchard context clear”Clear the default scope
orchard context clearorchard context current
Section titled “orchard context current”Print the active context name
orchard context currentorchard context list
Section titled “orchard context list”List the Orchard instances you have signed in to
orchard context listAliases: ls
orchard context remove
Section titled “orchard context remove”Forget a context and its stored token
orchard context remove <name>Aliases: rm
orchard context rename
Section titled “orchard context rename”Rename a context
orchard context rename <old> <new>orchard context show
Section titled “orchard context show”Show the current default scope
orchard context showorchard context use
Section titled “orchard context use”Make a context the active one (pick from a list without a name)
orchard context use [name]orchard db
Section titled “orchard db”Manage databases
orchard dbAliases: database, databases
orchard db activity
Section titled “orchard db activity”Show open sessions and blocked queries (needs a deploy-scope token)
orchard db activity <dbId>orchard db backup
Section titled “orchard db backup”Manage database backups
orchard db backupAliases: backups
orchard db backup create
Section titled “orchard db backup create”Trigger a new backup (runs asynchronously)
orchard db backup create <id>| Flag | Type | Default | Description |
|---|---|---|---|
--label | string | human-readable label for the backup | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--type | string | backup type: full|diff|incr (default full) | |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db backup list
Section titled “orchard db backup list”List backups for a database
orchard db backup list <id>Aliases: ls
orchard db backup restore
Section titled “orchard db backup restore”Restore a database from a backup, a checkpoint or a point in time (latest when none is given)
orchard db backup restore <id> [backupId]| Flag | Type | Default | Description |
|---|---|---|---|
--at | string | restore to a point in time: an ISO time, or “latest” | |
--checkpoint | string | restore to this checkpoint id | |
--fork | bool | false | restore into a new database and leave the original untouched |
--name | string | name for the new database (with —fork) | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db backup-schedule
Section titled “orchard db backup-schedule”Manage the automated backup schedule
orchard db backup-scheduleAliases: schedule
orchard db backup-schedule clear
Section titled “orchard db backup-schedule clear”Turn off automated backups and WAL archiving (backups already taken are kept)
orchard db backup-schedule clear <id>orchard db backup-schedule get
Section titled “orchard db backup-schedule get”Show the backup schedule
orchard db backup-schedule get <id>orchard db backup-schedule set
Section titled “orchard db backup-schedule set”Set the backup schedule (—cron, or a preset)
orchard db backup-schedule set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--cron | string | 5-field cron expression in UTC | |
--daily | bool | false | backup daily at 02:00 UTC |
--hourly | bool | false | backup every hour |
--weekly | bool | false | backup weekly on Sunday 02:00 UTC |
orchard db checkpoint
Section titled “orchard db checkpoint”Manage checkpoints (named restore points you can roll back to)
orchard db checkpointAliases: checkpoints, cp
orchard db checkpoint create
Section titled “orchard db checkpoint create”Take a checkpoint of one database, or of every database in the project or environment
orchard db checkpoint create [dbId]| Flag | Type | Default | Description |
|---|---|---|---|
--label | string | label to find the checkpoint by later |
orchard db checkpoint group
Section titled “orchard db checkpoint group”List the checkpoints taken together in one group
orchard db checkpoint group <groupId>orchard db checkpoint list
Section titled “orchard db checkpoint list”List a database’s checkpoints
orchard db checkpoint list <dbId>Aliases: ls
orchard db checkpoint restore
Section titled “orchard db checkpoint restore”Restore a database to a checkpoint (in place, or into a new database with —fork)
orchard db checkpoint restore <checkpointId>| Flag | Type | Default | Description |
|---|---|---|---|
--fork | bool | false | restore into a new database and leave the original untouched |
--name | string | name for the new database (with —fork) | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db checkpoint restore-group
Section titled “orchard db checkpoint restore-group”Restore every database in a checkpoint group to that group’s checkpoints
orchard db checkpoint restore-group <groupId>| Flag | Type | Default | Description |
|---|---|---|---|
--fork | bool | false | restore each into a new database and leave the originals untouched |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db checkpoint rm
Section titled “orchard db checkpoint rm”Hide a checkpoint so it is no longer offered for restore
orchard db checkpoint rm <checkpointId>Aliases: delete
orchard db connection
Section titled “orchard db connection”Show connection details and credentials (recorded in the audit log)
orchard db connection <id>Aliases: conn
orchard db create
Section titled “orchard db create”Create a Postgres database in the current project
orchard db create| Flag | Type | Default | Description |
|---|---|---|---|
--cpu | int | 0 | CPU request in millicores (e.g. 500) |
--memory | string | memory request in bytes or with unit (e.g. “512Mi”) | |
--name | string | database display name (required) | |
--pg-major | int | 0 | Postgres major version; choices come from orchard db versions (server default when omitted) |
--replicas | int | 0 | number of Postgres instances, primary included (server default when omitted) |
--restore-from | string | postgres:// URL to seed data from on first boot | |
--storage | string | storage size, e.g. “1Gi” (server default 1Gi) | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db delete
Section titled “orchard db delete”Delete a database (kept in the trash for 30 days when it has a backup)
orchard db delete <id>Aliases: rm
orchard db diagnose
Section titled “orchard db diagnose”Explain a database’s health in one call (exits 10 when it is down)
orchard db diagnose <dbId>orchard db extension
Section titled “orchard db extension”Manage Postgres extensions
orchard db extensionAliases: extensions, ext
orchard db extension install
Section titled “orchard db extension install”Install a Postgres extension
orchard db extension install <id> <name>| Flag | Type | Default | Description |
|---|---|---|---|
--preload | bool | false | add to shared_preload_libraries (causes a database restart) |
orchard db extension list
Section titled “orchard db extension list”List available and installed extensions
orchard db extension list <id>Aliases: ls
orchard db extension uninstall
Section titled “orchard db extension uninstall”Drop a Postgres extension (and objects depending on it)
orchard db extension uninstall <id> <name>| Flag | Type | Default | Description |
|---|---|---|---|
--remove-preload | bool | false | also remove from shared_preload_libraries (causes a database restart) |
orchard db fork
Section titled “orchard db fork”Copy a database into a new one, from now, a backup, a checkpoint or a point in time
orchard db fork <id>| Flag | Type | Default | Description |
|---|---|---|---|
--at | string | where to copy from: “now” (default), “latest”, or an ISO time | |
--backup | string | start from this backup id | |
--checkpoint | string | start from this checkpoint id | |
--name | string | name for the new database (server picks one by default) | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db get
Section titled “orchard db get”Show a database
orchard db get <id>| Flag | Type | Default | Description |
|---|---|---|---|
--watch | bool | false | keep re-rendering as the database changes (TTY only) |
orchard db killed
Section titled “orchard db killed”Inspect logs captured from killed database containers
orchard db killedorchard db killed list
Section titled “orchard db killed list”List killed-container log captures for a database
orchard db killed list <id>Aliases: ls
orchard db killed logs
Section titled “orchard db killed logs”Print the captured logs of a killed database container
orchard db killed logs <id> <entryId>orchard db list
Section titled “orchard db list”List databases (scoped to the current project or organization when set)
orchard db listAliases: ls
orchard db logs
Section titled “orchard db logs”Fetch Postgres logs from the database pod
orchard db logs <id>| Flag | Type | Default | Description |
|---|---|---|---|
--tail | int | 200 | number of log lines to fetch |
orchard db metrics
Section titled “orchard db metrics”Show CPU/memory/network usage for the database pod
orchard db metrics <id>| Flag | Type | Default | Description |
|---|---|---|---|
--end | int64 | 0 | window end (unix-ms, default now) |
--start | int64 | 0 | window start (unix-ms, default end-1h) |
--step | int64 | 0 | sample step in ms (default 30000) |
orchard db ops
Section titled “orchard db ops”Inspect and control restore, fork, undelete, upgrade and restore test operations
orchard db opsAliases: op, operations
orchard db ops cancel
Section titled “orchard db ops cancel”Cancel an operation that hasn’t finished
orchard db ops cancel <opId>orchard db ops get
Section titled “orchard db ops get”Show an operation (—wait blocks until it succeeds or fails)
orchard db ops get <opId>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db ops list
Section titled “orchard db ops list”List operations on a database, newest first
orchard db ops list <dbId>Aliases: ls
orchard db ops undo
Section titled “orchard db ops undo”Swap back to the copy from before an in-place restore (within 24 hours)
orchard db ops undo <opId>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db pooler
Section titled “orchard db pooler”Manage the PgBouncer connection pooler in front of a database
orchard db poolerorchard db pooler get
Section titled “orchard db pooler get”Show the pooler’s settings and state
orchard db pooler get <dbId>orchard db pooler set
Section titled “orchard db pooler set”Turn the pooler on or off and change its settings
orchard db pooler set <dbId>| Flag | Type | Default | Description |
|---|---|---|---|
--enabled | string | run the pooler: on|off | |
--instances | int | 0 | pooler instances (1-3) |
--max-client-conn | int | 0 | client connections the pooler accepts (10-5000) |
--mode | string | pool mode: transaction|session | |
--pool-size | int | 0 | server connections per user and database (1-100) |
orchard db protect
Section titled “orchard db protect”Show or change deletion protection, DDL checkpoints and scheduled restore tests
orchard db protect <dbId>| Flag | Type | Default | Description |
|---|---|---|---|
--ddl-checkpoints | string | checkpoint before destructive DDL: on|off | |
--deletion | string | deletion protection: on|off | |
--restore-tests | string | scheduled restore tests: on|off |
orchard db psql
Section titled “orchard db psql”Open an interactive psql session in a sandboxed client pod
orchard db psql <id>orchard db public
Section titled “orchard db public”Manage public access
orchard db publicorchard db public disable
Section titled “orchard db public disable”Stop exposing the database publicly
orchard db public disable <id>orchard db public enable
Section titled “orchard db public enable”Expose the database publicly with TLS
orchard db public enable <id>orchard db recovery
Section titled “orchard db recovery”Show how far back a database can be restored, and what it can be restored from
orchard db recovery <dbId>orchard db replication
Section titled “orchard db replication”Show or change how standbys confirm writes (async, preferred or required)
orchard db replicationorchard db replication get
Section titled “orchard db replication get”Show the replication mode
orchard db replication get <dbId>orchard db replication set
Section titled “orchard db replication set”Set the replication mode (preferred and required need at least 2 instances)
orchard db replication set <dbId>| Flag | Type | Default | Description |
|---|---|---|---|
--mode | string | async|preferred|required (required) |
orchard db resources
Section titled “orchard db resources”Manage CPU/memory requests
orchard db resourcesorchard db resources set
Section titled “orchard db resources set”Update CPU/memory requests (restarts the database pod)
orchard db resources set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--cpu | int | 0 | CPU request in millicores (0 clears back to default) |
--memory | string | memory request in bytes or with unit (“512Mi”; 0 clears) |
orchard db rotate-password
Section titled “orchard db rotate-password”Set a new password and push it to every bound app
orchard db rotate-password <id>| Flag | Type | Default | Description |
|---|---|---|---|
-y, --yes | bool | false | skip the confirmation |
orchard db security
Section titled “orchard db security”Show the running Postgres version, known CVEs and what fixes them
orchard db security <dbId>orchard db settings
Section titled “orchard db settings”Read or update Postgres parameters
orchard db settingsorchard db settings get
Section titled “orchard db settings get”Show configured Postgres parameters
orchard db settings get <id>orchard db settings set
Section titled “orchard db settings set”Update Postgres parameters (KEY= removes a parameter)
orchard db settings set <id> KEY=VAL...orchard db storage
Section titled “orchard db storage”Manage the storage volume
orchard db storageorchard db storage expand
Section titled “orchard db storage expand”Grow the storage volume (never shrinks)
orchard db storage expand <id>| Flag | Type | Default | Description |
|---|---|---|---|
--size | string | new volume size, e.g. “10Gi” (required) |
orchard db test-backup
Section titled “orchard db test-backup”Prove backups restore: restore the latest one into a throwaway copy and check it
orchard db test-backupAliases: restore-test, restore-tests
orchard db test-backup list
Section titled “orchard db test-backup list”List past restore tests and their results
orchard db test-backup list <dbId>Aliases: ls
orchard db test-backup run
Section titled “orchard db test-backup run”Start a restore test now (the throwaway copy is deleted afterwards)
orchard db test-backup run <dbId>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db trash
Section titled “orchard db trash”List and bring back deleted databases (kept for 30 days)
orchard db trashorchard db trash list
Section titled “orchard db trash list”List deleted databases in the current project
orchard db trash listAliases: ls
orchard db trash restore
Section titled “orchard db trash restore”Bring a deleted database back from its backups
orchard db trash restore <deletedId>| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | name for the restored database (default: its old name) | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db update
Section titled “orchard db update”Move a database to the newest minor release of its Postgres major
orchard db update <dbId>orchard db upgrade
Section titled “orchard db upgrade”Upgrade a database to a newer Postgres major version
orchard db upgrade <dbId>| Flag | Type | Default | Description |
|---|---|---|---|
--no-rehearse | bool | false | skip the rehearsal on a copy |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--to | int | 0 | target Postgres major, as listed by orchard db versions (required) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard db user
Section titled “orchard db user”Manage extra Postgres users with read or write access
orchard db userAliases: users
orchard db user create
Section titled “orchard db user create”Create a user and print its password once (needs a deploy-scope token)
orchard db user create <dbId> <name>| Flag | Type | Default | Description |
|---|---|---|---|
--access | string | read | read|write |
orchard db user list
Section titled “orchard db user list”List the extra users of a database
orchard db user list <dbId>Aliases: ls
orchard db user rm
Section titled “orchard db user rm”Drop a user
orchard db user rm <dbId> <name>Aliases: delete
orchard db versions
Section titled “orchard db versions”List the Postgres major versions you can create or upgrade to
orchard db versionsdeploy
Section titled “deploy”orchard deploy
Section titled “orchard deploy”Manage deployments
orchard deployAliases: deployment, deployments
orchard deploy auto-deploy
Section titled “orchard deploy auto-deploy”Manage push-to-deploy for GitHub deployments
orchard deploy auto-deployorchard deploy auto-deploy disable
Section titled “orchard deploy auto-deploy disable”Stop auto-deploying on pushes
orchard deploy auto-deploy disable <id>orchard deploy auto-deploy enable
Section titled “orchard deploy auto-deploy enable”Rebuild automatically on pushes to a branch
orchard deploy auto-deploy enable <id>| Flag | Type | Default | Description |
|---|---|---|---|
--branch | string | branch to auto-deploy from (required) | |
--path | stringArray | [] | only build when a push changes this glob (repeatable, prefix ! to ignore, pass —path="" to clear) |
orchard deploy auto-deploy status
Section titled “orchard deploy auto-deploy status”Show auto-deploy configuration
orchard deploy auto-deploy status <id>orchard deploy bindings
Section titled “orchard deploy bindings”Databases and apps this app is connected to
orchard deploy bindingsorchard deploy bindings add
Section titled “orchard deploy bindings add”Connect a database or another app and add the obvious variable
orchard deploy bindings add <id> (--database <name|id> | --app <name|id>)| Flag | Type | Default | Description |
|---|---|---|---|
--app | string | app name or id on the same project | |
--as | string | binding name used in ${{resource.<name>.*}} (default: derived from the database name) | |
--database | string | database name or id on the same project | |
--env | string | env key to add (default DATABASE_URL for a database, <NAME>_URL for an app) | |
--no-env | bool | false | bind only, don’t add an env var |
orchard deploy bindings list
Section titled “orchard deploy bindings list”List bindings
orchard deploy bindings list <id>orchard deploy bindings options
Section titled “orchard deploy bindings options”Databases and apps on the project that can still be connected
orchard deploy bindings options <id>orchard deploy bindings remove
Section titled “orchard deploy bindings remove”Disconnect a resource
orchard deploy bindings remove <id> <name>orchard deploy build-config
Section titled “orchard deploy build-config”Manage how a deployment is built
orchard deploy build-configorchard deploy build-config set
Section titled “orchard deploy build-config set”Change build settings for a deployment
orchard deploy build-config set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--build-cmd | string | railpack: override the detected build command | |
--build-type | string | dockerfile|railpack | |
--builder | string | auto|fast|standard, force or block the fast VM builder | |
--dockerfile | string | path to the Dockerfile relative to the repo root | |
--install-cmd | string | railpack: override the detected install command | |
--output-dir | string | railpack: directory of built static files | |
--root | string | railpack: directory of the app inside the repo | |
--start-cmd | string | command to run instead of the image CMD; "" uses the image’s own | |
--target | string | stage to stop at in a multi-stage Dockerfile; "" builds the final stage |
orchard deploy build-root
Section titled “orchard deploy build-root”Manage the build context of a GitHub deployment
orchard deploy build-rootorchard deploy build-root set
Section titled “orchard deploy build-root set”Build from the repo root (on) or the Dockerfile directory (off)
orchard deploy build-root set <id> <on|off>| Flag | Type | Default | Description |
|---|---|---|---|
--depot | bool | false | build with Depot |
--persistent-cache | bool | false | keep a persistent build cache between builds |
orchard deploy cancel
Section titled “orchard deploy cancel”Cancel an in-progress build
orchard deploy cancel <id>orchard deploy create
Section titled “orchard deploy create”Create a deployment from a Docker image or a GitHub repo
orchard deploy create| Flag | Type | Default | Description |
|---|---|---|---|
--auto-url | bool | true | generate a URL when the port is known (protected by default) |
--build-cmd | string | override the detected build command | |
--build-root | bool | false | use the repo root as the build context |
--cpu | int | 0 | CPU request in millicores (e.g. 500) |
--dockerfile | string | path to the Dockerfile relative to the repo root | |
--env | stringArray | [] | environment variable KEY=VAL (repeatable) |
--env-file | string | read environment variables from a dotenv-style file | |
--git | string | git provider name (see: orchard git list), used with —repo | |
--github | string | GitHub source as owner/repo[#branch] | |
--image | string | Docker image reference (e.g. nginx:latest) | |
--install-cmd | string | override the detected install command | |
--memory | string | memory request in bytes or with unit (e.g. “512Mi”) | |
--name | string | deployment name (required) | |
--output-dir | string | directory of built static files; serves the app as a static site | |
--port | int | 0 | port the container listens on (default: the image’s or Dockerfile’s EXPOSE, else 80) |
--pull-policy | string | pin the pull policy instead of deriving it from the tag: always|ifnotpresent (—image only) | |
--railpack | bool | false | build with railpack instead of a Dockerfile |
--replicas | int | 0 | number of replicas (server default 1) |
--repo | string | repository https URL on that provider, with an optional #branch | |
--root | string | directory of the app inside the repo (monorepos) | |
--start-cmd | string | override the detected start command | |
--target | string | stage to stop at in a multi-stage Dockerfile; empty builds the final stage | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard deploy delete
Section titled “orchard deploy delete”Delete a deployment and its Kubernetes resources
orchard deploy delete <id>Aliases: rm
orchard deploy env
Section titled “orchard deploy env”Manage a deployment’s environment variables
orchard deploy envorchard deploy env get
Section titled “orchard deploy env get”Show environment variables
orchard deploy env get <id>orchard deploy env set
Section titled “orchard deploy env set”Add or update environment variables (pods restart)
orchard deploy env set <id> [KEY=VAL ...]| Flag | Type | Default | Description |
|---|---|---|---|
--file | string | read KEY=VAL pairs from a dotenv-style file | |
--secret | bool | false | store the given vars in a Kubernetes Secret |
orchard deploy env unset
Section titled “orchard deploy env unset”Remove environment variables (pods restart)
orchard deploy env unset <id> KEY...orchard deploy get
Section titled “orchard deploy get”Show a deployment
orchard deploy get <id>| Flag | Type | Default | Description |
|---|---|---|---|
--watch | bool | false | keep re-rendering as the deployment changes (TTY only) |
orchard deploy github-deployments
Section titled “orchard deploy github-deployments”List GitHub deployment status entries for this deployment
orchard deploy github-deployments <id>orchard deploy health-check
Section titled “orchard deploy health-check”Manage liveness/readiness/startup probes
orchard deploy health-checkorchard deploy health-check set
Section titled “orchard deploy health-check set”Update health check configuration (unset flags keep current values)
orchard deploy health-check set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--command | string | exec probe command | |
--enabled | bool | false | enable or disable health checks (—enabled=false to disable) |
--interval | int | 0 | seconds between probes |
--liveness | bool | true | enable the liveness probe |
--path | string | HTTP probe path (e.g. /healthz) | |
--port | int | 0 | probe port |
--readiness | bool | true | enable the readiness probe |
--retries | int | 0 | failures before the probe reports unhealthy |
--startup | bool | false | enable the startup probe |
--startup-failure-threshold | int | 0 | startup probe failure threshold |
--timeout | int | 0 | probe timeout in seconds |
--type | string | probe type: http|tcp|exec |
orchard deploy history
Section titled “orchard deploy history”Show a deployment’s image history
orchard deploy history <id>| Flag | Type | Default | Description |
|---|---|---|---|
--logs | string | print build logs for one image history entry |
orchard deploy icon
Section titled “orchard deploy icon”Manage the app picture
orchard deploy iconorchard deploy icon set
Section titled “orchard deploy icon set”Upload an app picture (jpeg/png/gif/webp)
orchard deploy icon set <id> <file>orchard deploy image
Section titled “orchard deploy image”Manage the Docker image of an image-source deployment
orchard deploy imageorchard deploy image set
Section titled “orchard deploy image set”Change the image (GitHub-built deployments must use deploy rebuild)
orchard deploy image set <id> <image>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard deploy killed
Section titled “orchard deploy killed”Inspect logs captured from killed containers
orchard deploy killedorchard deploy killed list
Section titled “orchard deploy killed list”List killed-container log captures
orchard deploy killed list <id>Aliases: ls
orchard deploy killed logs
Section titled “orchard deploy killed logs”Print the captured logs of a killed container
orchard deploy killed logs <id> <entryId>orchard deploy list
Section titled “orchard deploy list”List deployments (scoped to the current project when one is set)
orchard deploy listAliases: ls
orchard deploy logs
Section titled “orchard deploy logs”Fetch runtime pod logs (or build logs with —build)
orchard deploy logs <id>| Flag | Type | Default | Description |
|---|---|---|---|
--build | bool | false | fetch build logs instead of runtime pod logs |
-f, --follow | bool | false | keep polling for new log lines until interrupted |
--tail | int | 100 | lines of recent logs per pod |
orchard deploy metrics
Section titled “orchard deploy metrics”Show CPU/memory/network metrics for the last hour
orchard deploy metrics <id>orchard deploy pods
Section titled “orchard deploy pods”List a deployment’s pods
orchard deploy pods <id>| Flag | Type | Default | Description |
|---|---|---|---|
--live | bool | false | query Kubernetes directly (includes usage and warnings) |
orchard deploy pull-policy
Section titled “orchard deploy pull-policy”Manage whether the image is re-pulled on every pod start
orchard deploy pull-policyorchard deploy pull-policy set
Section titled “orchard deploy pull-policy set”Override the image pull policy
orchard deploy pull-policy set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--policy | string | pull policy: auto|always|ifnotpresent (required) |
orchard deploy rebuild
Section titled “orchard deploy rebuild”Rebuild a deployment from source
orchard deploy rebuild <id>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard deploy releases
Section titled “orchard deploy releases”List releases, newest first
orchard deploy releases <id>| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 20 | how many releases to show |
orchard deploy resources
Section titled “orchard deploy resources”Manage a deployment’s CPU/memory requests
orchard deploy resourcesorchard deploy resources get
Section titled “orchard deploy resources get”Show CPU/memory requests
orchard deploy resources get <id>orchard deploy resources set
Section titled “orchard deploy resources set”Update CPU/memory requests (0 clears to the organization default; pods restart)
orchard deploy resources set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--cpu | int | 0 | CPU request in millicores (0 clears to the default) |
--memory | string | memory request in bytes or with unit, e.g. “512Mi” (0 clears) |
orchard deploy restart
Section titled “orchard deploy restart”Restart a deployment’s pods
orchard deploy restart <id>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard deploy rollback
Section titled “orchard deploy rollback”Roll a deployment back to a previous image (default: the previous release)
orchard deploy rollback <id> [historyId]| Flag | Type | Default | Description |
|---|---|---|---|
--restore-databases | bool | false | also restore bound databases to before the current release |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard deploy scale
Section titled “orchard deploy scale”Scale a deployment to N replicas
orchard deploy scale <id> <replicas>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard deploy start
Section titled “orchard deploy start”Start a stopped deployment; builds the latest held push first when there is one
orchard deploy start <id>| Flag | Type | Default | Description |
|---|---|---|---|
--build | bool | false | rebuild from source before starting |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard deploy status
Section titled “orchard deploy status”Show whether a deployment is live, and if not, why
orchard deploy status <id>| Flag | Type | Default | Description |
|---|---|---|---|
--release | string | pin the evaluation to this release id | |
--since | string | only count changes observed after this server timestamp (ISO) | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard deploy stop
Section titled “orchard deploy stop”Stop a deployment: scale it to zero and hold pushes until it is started
orchard deploy stop <id>orchard deploy strategy
Section titled “orchard deploy strategy”Manage the Kubernetes update strategy
orchard deploy strategyorchard deploy strategy set
Section titled “orchard deploy strategy set”Set the update strategy (deployments with volumes require recreate)
orchard deploy strategy set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--type | string | update strategy: rollingupdate|recreate|bluegreen (required) |
orchard deploy volumes
Section titled “orchard deploy volumes”Manage a deployment’s volumes
orchard deploy volumesorchard deploy volumes get
Section titled “orchard deploy volumes get”Show attached volumes
orchard deploy volumes get <id>orchard deploy volumes set
Section titled “orchard deploy volumes set”Replace all volumes with the given volumes
orchard deploy volumes set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--volume | stringArray | [] | volume as mountPath=size (repeatable); omit to remove all volumes |
orchard deploy webhook-token
Section titled “orchard deploy webhook-token”Manage deploy webhook trigger tokens
orchard deploy webhook-tokenAliases: webhook-tokens
orchard deploy webhook-token create
Section titled “orchard deploy webhook-token create”Create a webhook token that restarts the deployment via POST
orchard deploy webhook-token create <id>| Flag | Type | Default | Description |
|---|---|---|---|
--label | string | human-readable label for the token |
orchard deploy webhook-token delete
Section titled “orchard deploy webhook-token delete”Delete a webhook token
orchard deploy webhook-token delete <id> <tokenId>Aliases: rm
orchard deploy webhook-token list
Section titled “orchard deploy webhook-token list”List webhook tokens (secrets are never shown again)
orchard deploy webhook-token list <id>Aliases: ls
doctor
Section titled “doctor”orchard doctor
Section titled “orchard doctor”Check the instance’s isolation and security configuration (superadmin)
orchard doctor| Flag | Type | Default | Description |
|---|---|---|---|
--selftest | bool | false | also run the active isolation self-test (creates temporary namespaces and pods) |
--timeout | duration | 10m0s | how long to wait for the self-test to finish |
domain
Section titled “domain”orchard domain
Section titled “orchard domain”Manage domains
orchard domainAliases: ingress, domains
orchard domain create
Section titled “orchard domain create”Add a domain to a deployment
orchard domain create| Flag | Type | Default | Description |
|---|---|---|---|
--deployment | string | deployment id to route traffic to | |
--host | string | fully-qualified domain name | |
--path | string | / | URL path prefix |
--service-port | int | 80 | port to route to |
--tls | bool | true | provision TLS for the host |
orchard domain delete
Section titled “orchard domain delete”Delete a domain
orchard domain delete <domain-id>Aliases: rm
orchard domain get
Section titled “orchard domain get”Show a domain
orchard domain get <domain-id>orchard domain list
Section titled “orchard domain list”List domains
orchard domain listAliases: ls
| Flag | Type | Default | Description |
|---|---|---|---|
--deployment | string | list domains of this deployment id |
orchard domain protection
Section titled “orchard domain protection”Control access protection on a domain
orchard domain protectionorchard domain protection get
Section titled “orchard domain protection get”Show a domain’s protection mode and bypass secret
orchard domain protection get <domain-id>orchard domain protection set
Section titled “orchard domain protection set”Set a domain’s protection mode
orchard domain protection set <domain-id>| Flag | Type | Default | Description |
|---|---|---|---|
--mode | string | protection mode: none|password|orchard | |
--password | string | password (required with —mode password) |
orchard domain update
Section titled “orchard domain update”Update a domain’s host, path, port, or TLS
orchard domain update <domain-id>| Flag | Type | Default | Description |
|---|---|---|---|
--host | string | new domain name | |
--path | string | / | URL path prefix |
--redirect-status | int | 0 | for a redirect domain: 301, 302, 307 or 308 |
--redirect-to | string | for a redirect domain: where it sends visitors | |
--service-port | int | 0 | port to route to |
--tls | bool | true | provision TLS for the host |
orchard domain validate-dns
Section titled “orchard domain validate-dns”Check that a domain’s DNS points at your instance
orchard domain validate-dns <host>orchard env
Section titled “orchard env”Manage project environments
orchard envAliases: environment, envs
orchard env create
Section titled “orchard env create”Create an environment in the project
orchard env create| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | environment name (required) | |
--slug | string | url-safe slug (defaults to the slugified name) |
orchard env delete
Section titled “orchard env delete”Delete an environment and its namespace
orchard env delete <name-or-id>Aliases: rm
orchard env get
Section titled “orchard env get”Show an environment
orchard env get [name-or-id]orchard env list
Section titled “orchard env list”List environments in the project
orchard env listAliases: ls
orchard env pull
Section titled “orchard env pull”Write environment variables to a local dotenv file
orchard env pull [env]| Flag | Type | Default | Description |
|---|---|---|---|
--deployment | string | merge this deployment’s own vars on top | |
--force | bool | false | overwrite even if the file wasn’t generated by orchard |
--out | string | .env.orchard | output file path |
orchard env set-default
Section titled “orchard env set-default”Make an environment the project default
orchard env set-default <name-or-id>orchard env vars
Section titled “orchard env vars”Manage shared environment variables
orchard env varsAliases: var
orchard env vars get
Section titled “orchard env vars get”List shared variables (secret values are write-only, never returned)
orchard env vars get [env]Aliases: list, ls
orchard env vars set
Section titled “orchard env vars set”Set shared variables (merged into the existing set)
orchard env vars set [KEY=VAL ...]| Flag | Type | Default | Description |
|---|---|---|---|
--file | string | read KEY=VALs from a dotenv file | |
--secret | bool | false | mark the variables being set as secret (write-only, encrypted at rest) |
orchard env vars unset
Section titled “orchard env vars unset”Remove shared variables
orchard env vars unset KEY [KEY ...]Aliases: rm, remove
events
Section titled “events”orchard events
Section titled “orchard events”Stream live events from the organization event bus
orchard eventsorchard events tail
Section titled “orchard events tail”Tail organization events until interrupted (NDJSON when piped)
orchard events tail| Flag | Type | Default | Description |
|---|---|---|---|
--since-id | string | replay events newer than this event id before going live | |
--types | string | only show these event types (comma-separated, e.g. deployment.changed,build.changed) |
orchard git
Section titled “orchard git”Git providers you have linked with your own token
orchard gitAliases: git-providers, providers
orchard git add
Section titled “orchard git add”Connect a git provider
orchard git add --provider <kind> --name <name> --token <token>| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | short name used with —git on deploy create | |
--provider | string | github | gitlab | gitea | bitbucket | generic | |
--token | string | token or password | |
--url | string | base URL of the host (default: the public instance of the provider) | |
--username | string | Atlassian account email for a bitbucket API token, or the username for a generic host |
orchard git branches
Section titled “orchard git branches”List branches of a repository
orchard git branches <name> <owner/repo>orchard git detect
Section titled “orchard git detect”Inspect a repository the way the new app form does
orchard git detect <name> <owner/repo>| Flag | Type | Default | Description |
|---|---|---|---|
--branch | string | branch to inspect (default: the repository default) |
orchard git list
Section titled “orchard git list”List git providers
orchard git listorchard git remove
Section titled “orchard git remove”Disconnect a git provider
orchard git remove <name>orchard git repos
Section titled “orchard git repos”List repositories the token can see
orchard git repos <name>orchard git webhook
Section titled “orchard git webhook”Show the webhook URL and secret to paste into the forge
orchard git webhook <name>github
Section titled “github”orchard github
Section titled “orchard github”Manage the GitHub integration
orchard githubAliases: gh
orchard github branches
Section titled “orchard github branches”List a repository’s branches
orchard github branches <owner/repo>orchard github contents
Section titled “orchard github contents”List files and directories in a repository
orchard github contents <owner/repo> [path]Aliases: ls
| Flag | Type | Default | Description |
|---|---|---|---|
--branch | string | branch to read from (default: the repo’s default branch) |
orchard github dockerfile-info
Section titled “orchard github dockerfile-info”Show exposed ports, env vars, and build stages of a Dockerfile
orchard github dockerfile-info <owner/repo> <dockerfile-path>| Flag | Type | Default | Description |
|---|---|---|---|
--branch | string | branch to read from (default: the repo’s default branch) |
orchard github dockerfiles
Section titled “orchard github dockerfiles”Find Dockerfiles in a repository
orchard github dockerfiles <owner/repo>| Flag | Type | Default | Description |
|---|---|---|---|
--branch | string | branch to search (default: the repo’s default branch) |
orchard github install
Section titled “orchard github install”Get the GitHub App installation URL
orchard github install| Flag | Type | Default | Description |
|---|---|---|---|
--open | bool | false | open the URL in your browser |
orchard github installations
Section titled “orchard github installations”List GitHub App installations available to your account
orchard github installationsorchard github link
Section titled “orchard github link”Link your GitHub account (opens the OAuth flow in a browser)
orchard github link| Flag | Type | Default | Description |
|---|---|---|---|
--open | bool | false | open the URL in your browser |
orchard github repos
Section titled “orchard github repos”List repositories you can deploy from
orchard github reposAliases: repositories
| Flag | Type | Default | Description |
|---|---|---|---|
--all | bool | false | fetch more pages from the OAuth fallback listing |
orchard github status
Section titled “orchard github status”Show the linked GitHub account and app installations
orchard github statusorchard github unlink
Section titled “orchard github unlink”Unlink your GitHub account
orchard github unlinkorchard help
Section titled “orchard help”Help about any command
orchard help [command]import
Section titled “import”orchard import
Section titled “orchard import”Import a GitHub repo and deploy it
orchard import <owner/repo[#branch] | url>| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | override the project/deployment name (default: repo name) | |
--port | int | 0 | override the detected port |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
invitation
Section titled “invitation”orchard invitation
Section titled “orchard invitation”View and act on organization invitations sent to you
orchard invitationAliases: invitations
orchard invitation accept
Section titled “orchard invitation accept”Accept a pending invitation
orchard invitation accept <id>orchard invitation accept-all
Section titled “orchard invitation accept-all”Accept every pending invitation
orchard invitation accept-allorchard invitation decline
Section titled “orchard invitation decline”Decline a pending invitation
orchard invitation decline <id>orchard invitation list
Section titled “orchard invitation list”List your pending invitations
orchard invitation listAliases: ls
orchard job
Section titled “orchard job”Manage scheduled jobs (multi-step pipelines)
orchard jobAliases: jobs
orchard job create
Section titled “orchard job create”Create a job in the project from a steps file
orchard job create| Flag | Type | Default | Description |
|---|---|---|---|
--concurrency | string | concurrency policy: forbid|allow (server default forbid) | |
--cron | string | 5-field cron schedule (omit for manual-only) | |
--description | string | optional description | |
--name | string | job name, unique within the project (required) | |
--paused | bool | false | create the job with a paused schedule |
--steps | string | path to the steps JSON file (required) | |
--timezone | string | IANA time zone for the schedule (default UTC) |
orchard job delete
Section titled “orchard job delete”Delete a job, its schedule, and its run history
orchard job delete <id>Aliases: rm
orchard job get
Section titled “orchard job get”Show a job and its steps
orchard job get <id>orchard job list
Section titled “orchard job list”List jobs in the organization (or the current project when one is set)
orchard job listAliases: ls
orchard job pause
Section titled “orchard job pause”Pause a job’s schedule (manual runs still work)
orchard job pause <id>orchard job resume
Section titled “orchard job resume”Resume a paused job’s schedule
orchard job resume <id>orchard job run
Section titled “orchard job run”Trigger a job run now
orchard job run <id>| Flag | Type | Default | Description |
|---|---|---|---|
--allow-concurrent | bool | false | start even if another run is active |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard job runs
Section titled “orchard job runs”List a job’s run history, newest first
orchard job runs <id>| Flag | Type | Default | Description |
|---|---|---|---|
--all | bool | false | fetch every page (capped at 100 pages) |
--cursor | string | resume from a previous nextCursor | |
--limit | int | 50 | page size |
orchard job steps
Section titled “orchard job steps”Manage a job’s step pipeline
orchard job stepsorchard job steps set
Section titled “orchard job steps set”Replace a job’s entire ordered step list
orchard job steps set <id>| Flag | Type | Default | Description |
|---|---|---|---|
--file | string | path to the steps JSON file (required) |
orchard job update
Section titled “orchard job update”Update a job’s name, schedule, or paused state
orchard job update <id>| Flag | Type | Default | Description |
|---|---|---|---|
--concurrency | string | concurrency policy: forbid|allow | |
--cron | string | new 5-field cron ("" for manual-only) | |
--description | string | new description | |
--name | string | new job name | |
--paused | bool | false | pause (true) or resume (false) the schedule |
job-run
Section titled “job-run”orchard job-run
Section titled “orchard job-run”Inspect and manage job runs
orchard job-runAliases: job-runs
orchard job-run cancel
Section titled “orchard job-run cancel”Cancel an in-progress run (remaining steps are skipped)
orchard job-run cancel <runId>orchard job-run get
Section titled “orchard job-run get”Show a run: status, timing, and per-step results
orchard job-run get <runId>| Flag | Type | Default | Description |
|---|---|---|---|
--watch | bool | false | keep re-rendering as the run progresses (TTY only) |
orchard job-run logs
Section titled “orchard job-run logs”Print step logs (all steps in order, or one with —step)
orchard job-run logs <runId>| Flag | Type | Default | Description |
|---|---|---|---|
-f, --follow | bool | false | poll for new log lines while the run is active; stops once it finishes |
--step | int | 0 | 1-based step number (default: all steps in order) |
licenses
Section titled “licenses”orchard licenses
Section titled “orchard licenses”Show the licenses of the open-source software built into this CLI
orchard licensesorchard link
Section titled “orchard link”Link this directory to an Orchard project
orchard link| Flag | Type | Default | Description |
|---|---|---|---|
--no-gitignore | bool | false | skip adding .orchard/ to the repo .gitignore |
--status | bool | false | show the link in effect for this directory |
orchard logs
Section titled “orchard logs”Fetch or follow a deployment’s logs (shortcut for deploy logs)
orchard logs <deploymentId>| Flag | Type | Default | Description |
|---|---|---|---|
--build | bool | false | fetch build logs instead of runtime pod logs |
-f, --follow | bool | false | keep polling for new log lines until interrupted |
--tail | int | 100 | lines of recent logs per pod |
member
Section titled “member”orchard member
Section titled “orchard member”Manage members of the scoped organization
orchard memberAliases: members
orchard member enable
Section titled “orchard member enable”Turn a member’s access back on (projects are not restored)
orchard member enable <memberId>orchard member invite
Section titled “orchard member invite”Invite someone to the organization by email
orchard member invite <email>| Flag | Type | Default | Description |
|---|---|---|---|
--role | string | member | organization role: owner|admin|member |
orchard member invites
Section titled “orchard member invites”Manage the organization’s pending invitations
orchard member invitesAliases: invitations
orchard member invites cancel
Section titled “orchard member invites cancel”Cancel a pending invitation
orchard member invites cancel <invitationId>Aliases: revoke, rm
orchard member invites list
Section titled “orchard member invites list”List pending invitations for the organization
orchard member invites listAliases: ls
orchard member invites resend
Section titled “orchard member invites resend”Resend a pending invitation’s email, or create a new link with no email
orchard member invites resend <invitationId>orchard member list
Section titled “orchard member list”List members of the organization
orchard member listAliases: ls
orchard member remove
Section titled “orchard member remove”Turn off a member’s access (they stay on the list and can be turned back on)
orchard member remove <memberId>Aliases: rm, disable
orchard member set-role
Section titled “orchard member set-role”Change a member’s organization role (owner|admin|member|guest)
orchard member set-role <memberId> <role>notify
Section titled “notify”orchard notify
Section titled “orchard notify”Manage organization notification channels
orchard notifyAliases: notification, notifications
orchard notify channel
Section titled “orchard notify channel”Manage notification channels
orchard notify channelAliases: channels
orchard notify channel create
Section titled “orchard notify channel create”Create a notification channel in the organization
orchard notify channel create| Flag | Type | Default | Description |
|---|---|---|---|
--email | stringSlice | [] | recipient email, must be an organization member (email channels, repeatable) |
--events | stringSlice | [] | events to deliver, comma-separated (required) |
--name | string | channel name, 1-100 characters (required) | |
--project | stringSlice | [] | limit the channel to a project id (repeatable; default all projects) |
--type | string | channel type: discord|slack|webhook|email (required) | |
--url | string | webhook URL (discord/slack/webhook channels) |
orchard notify channel delete
Section titled “orchard notify channel delete”Delete a notification channel and its delivery history
orchard notify channel delete <channelId>Aliases: rm
orchard notify channel list
Section titled “orchard notify channel list”List the organization’s notification channels
orchard notify channel listAliases: ls
orchard notify channel test
Section titled “orchard notify channel test”Send a test notification through a channel
orchard notify channel test <channelId>orchard notify channel update
Section titled “orchard notify channel update”Update a notification channel
orchard notify channel update <channelId>| Flag | Type | Default | Description |
|---|---|---|---|
--all-projects | bool | false | clear the project scope (fire for every project) |
--disabled | bool | false | pause delivery |
--email | stringSlice | [] | replace the recipient list (email channels, repeatable) |
--enabled | bool | false | resume delivery |
--events | stringSlice | [] | replace the delivered events, comma-separated |
--name | string | new channel name | |
--project | stringSlice | [] | replace the project scope with these project ids (repeatable) |
--url | string | new webhook URL (discord/slack/webhook channels) |
orchard notify deliveries
Section titled “orchard notify deliveries”List a channel’s recent delivery attempts, newest first
orchard notify deliveries <channelId>| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 30 | show at most this many deliveries |
observe
Section titled “observe”orchard observe
Section titled “orchard observe”Deployment observability: logs, HTTP metrics, errors, runtime
orchard observeAliases: obs
orchard observe activity
Section titled “orchard observe activity”Activity feed for a deployment
orchard observe activity <deploymentId>Aliases: timeline
| Flag | Type | Default | Description |
|---|---|---|---|
--all | bool | false | fetch every page (capped at 100 pages) |
--cursor | string | resume from a previous nextCursor | |
--kinds | string | comma list of audit,build,release,pod,error (default: all) | |
--limit | int | 50 | page size |
orchard observe capabilities
Section titled “orchard observe capabilities”Which observability signals are available for this deployment
orchard observe capabilities <deploymentId>orchard observe errors
Section titled “orchard observe errors”Grouped error log entries with counts and trends
orchard observe errors <deploymentId>| Flag | Type | Default | Description |
|---|---|---|---|
--window | string | 1h | time window (15m, 1h, 6h or 24h) |
orchard observe http
Section titled “orchard observe http”HTTP request rate, error rate and latency for the last hour
orchard observe http <deploymentId>orchard observe logs
Section titled “orchard observe logs”Structured logs (level detection, multi-line grouping) with filter and follow
orchard observe logs <deploymentId>| Flag | Type | Default | Description |
|---|---|---|---|
--follow | bool | false | poll every 3s and print new entries |
--level | string | only entries with this level (debug|info|warn|error|fatal) | |
--search | string | only entries containing this substring | |
--tail | int | 200 | lines of recent logs to scan (max 20000) |
orchard observe overview
Section titled “orchard observe overview”Stat strip: uptime, pods, restarts, cpu/mem, request rate, errors, latency
orchard observe overview <deploymentId>orchard observe runtime
Section titled “orchard observe runtime”Detected language/framework (from build logs, image, env vars or dockerfile)
orchard observe runtime <deploymentId>orchard open
Section titled “orchard open”Open a deployment’s URL in your browser
orchard open [deployment-id]| Flag | Type | Default | Description |
|---|---|---|---|
--dash | bool | false | open the deployment’s dashboard page instead of the app URL |
orchard org
Section titled “orchard org”Manage organizations
orchard orgAliases: orgs, organization, organizations
orchard org avatar
Section titled “orchard org avatar”Manage the organization avatar
orchard org avatarorchard org avatar delete
Section titled “orchard org avatar delete”Remove the organization avatar
orchard org avatar delete <slug-or-id>Aliases: rm
orchard org avatar set
Section titled “orchard org avatar set”Upload an organization avatar image
orchard org avatar set <slug-or-id> <file>orchard org backup-settings
Section titled “orchard org backup-settings”Organization-wide R2 settings for database backups
orchard org backup-settingsAliases: backups
orchard org backup-settings get
Section titled “orchard org backup-settings get”Show the scoped organization’s backup settings
orchard org backup-settings getorchard org backup-settings set
Section titled “orchard org backup-settings set”Update the scoped organization’s backup settings
orchard org backup-settings set| Flag | Type | Default | Description |
|---|---|---|---|
--access-key | string | R2 access key id (write-only; empty to clear) | |
--bucket | string | R2 bucket name (empty to clear) | |
--endpoint | string | R2 endpoint, e.g. https://<account-id>.r2.cloudflarestorage.com (empty to clear) | |
--region | string | R2 region, usually auto (empty to clear) | |
--secret-key | string | R2 secret access key (write-only; empty to clear) |
orchard org get
Section titled “orchard org get”Show an organization (defaults to the current scope)
orchard org get [slug-or-id]orchard org list
Section titled “orchard org list”List organizations you belong to
orchard org listAliases: ls
orchard org registry
Section titled “orchard org registry”Manage default registry credentials for the scoped organization
orchard org registryAliases: registries, pull-secret
orchard org registry list
Section titled “orchard org registry list”List organization registry defaults
orchard org registry listAliases: ls
orchard org registry remove
Section titled “orchard org registry remove”Remove a registry credential
orchard org registry remove <id>Aliases: rm, delete
orchard org registry set
Section titled “orchard org registry set”Add or replace the credential for a registry (ghcr.io, docker.io, registry.gitlab.com, …)
orchard org registry set <registry>| Flag | Type | Default | Description |
|---|---|---|---|
-p, --password | string | password or access token | |
--password-stdin | bool | false | read the password or token from stdin |
-u, --username | string | registry username |
orchard org update
Section titled “orchard org update”Update an organization
orchard org update <slug-or-id>| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | new display name | |
--postgres-auto-update | bool | false | let Orchard roll Postgres minor updates on this organization’s databases (admins only) |
--public-ip | string | public IP advertised for exposed databases (empty to clear) | |
--subdomain | string | custom subdomain (empty to clear) |
overview
Section titled “overview”orchard overview
Section titled “orchard overview”Org dashboard: projects, deployments, and databases at a glance
orchard overview| Flag | Type | Default | Description |
|---|---|---|---|
--all | bool | false | every organization you belong to, with what each holds |
--builds | bool | false | include the recent build feed |
orchard pod
Section titled “orchard pod”Inspect and interact with running pods
orchard podAliases: pods
orchard pod delete
Section titled “orchard pod delete”Delete a pod (its controller will replace it)
orchard pod delete <name>Aliases: rm
| Flag | Type | Default | Description |
|---|---|---|---|
-n, --namespace | string | kubernetes namespace (default: the scoped project’s namespace) |
orchard pod exec
Section titled “orchard pod exec”Run a one-shot command in a pod (like kubectl exec)
orchard pod exec <name> -- <cmd...>| Flag | Type | Default | Description |
|---|---|---|---|
-c, --container | string | container name (default: the pod’s first container) | |
-n, --namespace | string | kubernetes namespace (default: the scoped project’s namespace) |
orchard pod get
Section titled “orchard pod get”Show a pod’s status, containers, and node
orchard pod get <name>| Flag | Type | Default | Description |
|---|---|---|---|
-n, --namespace | string | kubernetes namespace (default: the scoped project’s namespace) |
orchard pod list
Section titled “orchard pod list”List pods in a namespace
orchard pod listAliases: ls
| Flag | Type | Default | Description |
|---|---|---|---|
-n, --namespace | string | kubernetes namespace (default: the scoped project’s namespace) |
orchard pod logs
Section titled “orchard pod logs”Fetch runtime logs from a pod
orchard pod logs <name>| Flag | Type | Default | Description |
|---|---|---|---|
-c, --container | string | container name (default: the pod’s only container) | |
-f, --follow | bool | false | keep polling for new log lines until interrupted |
-n, --namespace | string | kubernetes namespace (default: the scoped project’s namespace) | |
--previous | bool | false | logs from the previous (terminated) container instance |
--tail | int | 100 | number of log lines to fetch |
orchard pod shell
Section titled “orchard pod shell”Open an interactive shell in a pod
orchard pod shell <name>| Flag | Type | Default | Description |
|---|---|---|---|
-c, --container | string | container name (default: the pod’s first container) | |
-n, --namespace | string | kubernetes namespace (default: the scoped project’s namespace) |
project
Section titled “project”orchard project
Section titled “orchard project”Manage projects
orchard projectAliases: projects, proj
orchard project background
Section titled “orchard project background”Manage the project background image
orchard project backgroundorchard project background set
Section titled “orchard project background set”Upload a background image for the scoped project (jpeg/png/webp, max 8MB)
orchard project background set <file>orchard project create
Section titled “orchard project create”Create a project in the scoped organization
orchard project create| Flag | Type | Default | Description |
|---|---|---|---|
--description | string | project description | |
--name | string | project name (required) | |
--slug | string | url slug (default: derived from the name) |
orchard project delete
Section titled “orchard project delete”Delete a project and everything in it
orchard project delete <project>Aliases: rm
orchard project get
Section titled “orchard project get”Show a project
orchard project get <project>orchard project icon
Section titled “orchard project icon”Manage the project icon
orchard project iconorchard project icon set
Section titled “orchard project icon set”Upload a project icon (jpeg/png/gif/webp, max 2MB)
orchard project icon set <project> <file>orchard project invitation
Section titled “orchard project invitation”Manage pending invitations for the scoped project
orchard project invitationAliases: invitations, invite
orchard project invitation revoke
Section titled “orchard project invitation revoke”Revoke a pending project invitation
orchard project invitation revoke <invitationId>orchard project list
Section titled “orchard project list”List projects (all organizations, or the scoped one)
orchard project listAliases: ls
orchard project member
Section titled “orchard project member”Manage members of the scoped project
orchard project memberAliases: members
orchard project member add
Section titled “orchard project member add”Add an organization member to the project (emails without an account get an invitation)
orchard project member add <email>| Flag | Type | Default | Description |
|---|---|---|---|
--role | string | member | project role: admin|member|viewer |
orchard project member list
Section titled “orchard project member list”List project members
orchard project member listAliases: ls
orchard project member remove
Section titled “orchard project member remove”Remove a member from the project
orchard project member remove <memberId>Aliases: rm
orchard project member set-role
Section titled “orchard project member set-role”Change a member’s project role (admin|member|viewer)
orchard project member set-role <memberId> <role>orchard project registry
Section titled “orchard project registry”Manage credentials for pulling private images into the scoped project
orchard project registryAliases: registries, pull-secret
orchard project registry list
Section titled “orchard project registry list”List the registries this project can pull private images from
orchard project registry listAliases: ls
orchard project registry remove
Section titled “orchard project registry remove”Remove a registry credential
orchard project registry remove <id>Aliases: rm, delete
orchard project registry set
Section titled “orchard project registry set”Add or replace the credential for a registry (ghcr.io, docker.io, registry.gitlab.com, …)
orchard project registry set <registry>| Flag | Type | Default | Description |
|---|---|---|---|
-p, --password | string | password or access token | |
--password-stdin | bool | false | read the password or token from stdin |
-u, --username | string | registry username |
orchard project sync
Section titled “orchard project sync”Pull live Kubernetes state for the project into Orchard
orchard project sync <project>orchard project transfer
Section titled “orchard project transfer”Transfer ownership of a project to another member
orchard project transferorchard project transfer accept
Section titled “orchard project transfer accept”Accept ownership of a project offered to you
orchard project transfer accept <requestId>orchard project transfer cancel
Section titled “orchard project transfer cancel”Withdraw the scoped project’s pending ownership transfer
orchard project transfer cancelorchard project transfer decline
Section titled “orchard project transfer decline”Decline ownership of a project offered to you
orchard project transfer decline <requestId>orchard project transfer list
Section titled “orchard project transfer list”List ownership transfers waiting on you
orchard project transfer listAliases: ls
orchard project transfer request
Section titled “orchard project transfer request”Ask another project member to take ownership of the scoped project
orchard project transfer request <email|userId>orchard project update
Section titled “orchard project update”Update project fields
orchard project update <project>| Flag | Type | Default | Description |
|---|---|---|---|
--background-image | string | background image URL (empty string clears) | |
--description | string | new description (empty string clears) | |
--icon | string | icon emoji or image URL (empty string clears) | |
--name | string | new project name | |
--repository-url | string | linked repository URL (empty string clears) |
orchard quota
Section titled “orchard quota”Inspect resource quotas and usage for the organization
orchard quotaAliases: quotas
orchard quota me
Section titled “orchard quota me”Show your own allowance, usage and remaining allowance in the organization
orchard quota meorchard quota members
Section titled “orchard quota members”Show per-member allowances and usage (organization admins)
orchard quota membersorchard quota projects
Section titled “orchard quota projects”Show per-project caps and usage (organization admins)
orchard quota projectsorchard quota show
Section titled “orchard quota show”Show organization-wide usage against its caps
orchard quota showsandbox
Section titled “sandbox”orchard sandbox
Section titled “orchard sandbox”Manage Greenhouse cloud dev sandboxes
orchard sandboxAliases: sb
orchard sandbox chat
Section titled “orchard sandbox chat”Send a message to the claude agent in a sandbox
orchard sandbox chat <name> [message...]| Flag | Type | Default | Description |
|---|---|---|---|
-m, --message | string | message to send (default: the remaining args, or stdin) |
orchard sandbox conversations
Section titled “orchard sandbox conversations”List and manage Cloud Code conversations in a sandbox
orchard sandbox conversations <sandbox>Aliases: convos
| Flag | Type | Default | Description |
|---|---|---|---|
--delete | string | delete a conversation by id | |
--history | string | print a conversation transcript as json by conversation id | |
--new | string | create a conversation with this title | |
--rename | string | rename: <conversation-id>=<new title> |
orchard sandbox create
Section titled “orchard sandbox create”Create a cloud dev sandbox
orchard sandbox create [name]| Flag | Type | Default | Description |
|---|---|---|---|
--identity | string | ssh identity name or id (default: your only identity) | |
--repo | string | git repository URL to clone into the sandbox | |
--runner | string | where the sandbox runs: kubernetes|vercel (default: the instance default) | |
--setup | string | setup script file run once on first boot (- reads stdin) | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard sandbox credentials
Section titled “orchard sandbox credentials”Manage agent tokens injected into your sandboxes
orchard sandbox credentialsorchard sandbox credentials clear
Section titled “orchard sandbox credentials clear”Remove stored sandbox agent tokens
orchard sandbox credentials clear| Flag | Type | Default | Description |
|---|---|---|---|
--claude | bool | false | clear the claude token |
--openai | bool | false | clear the openai token |
orchard sandbox credentials set
Section titled “orchard sandbox credentials set”Store agent tokens (claude code / openai) for your sandboxes
orchard sandbox credentials set| Flag | Type | Default | Description |
|---|---|---|---|
--claude | string | claude code oauth token from claude setup-token (- reads stdin) | |
--openai | string | openai/codex token (- reads stdin) |
orchard sandbox credentials status
Section titled “orchard sandbox credentials status”Show which sandbox agent tokens are configured (never the values)
orchard sandbox credentials statusorchard sandbox delete
Section titled “orchard sandbox delete”Delete a sandbox and its home volume
orchard sandbox delete <name>Aliases: rm
orchard sandbox diff
Section titled “orchard sandbox diff”Show git changes inside the sandbox workspace
orchard sandbox diff <name>| Flag | Type | Default | Description |
|---|---|---|---|
--file | string | limit the diff to one file | |
--stat | bool | false | list changed files instead of the diff |
orchard sandbox fork
Section titled “orchard sandbox fork”Fork a machine you own into a new one with the same disk and sessions
orchard sandbox fork <sandbox>| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | Name of the new machine (defaults to <name>-fork) | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard sandbox get
Section titled “orchard sandbox get”Show a sandbox
orchard sandbox get <name>orchard sandbox link
Section titled “orchard sandbox link”Attach Orchard projects so their env vars land in the sandbox
orchard sandbox linkAliases: links
orchard sandbox link add
Section titled “orchard sandbox link add”Attach a project environment to a sandbox (host only); —env picks the environment
orchard sandbox link add <sandbox> <project>orchard sandbox link list
Section titled “orchard sandbox link list”List projects attached to a sandbox
orchard sandbox link list <sandbox>Aliases: ls
orchard sandbox link remove
Section titled “orchard sandbox link remove”Detach a project from a sandbox (host only)
orchard sandbox link remove <sandbox> <project>Aliases: rm
orchard sandbox list
Section titled “orchard sandbox list”List your sandboxes
orchard sandbox listAliases: ls
orchard sandbox repo
Section titled “orchard sandbox repo”Manage git repositories inside a sandbox
orchard sandbox repoorchard sandbox repo add
Section titled “orchard sandbox repo add”Clone another repository into a sandbox
orchard sandbox repo add <sandbox> <repo-url>orchard sandbox repo icon
Section titled “orchard sandbox repo icon”Set the icon a repository shows in Greenhouse
orchard sandbox repo icon <sandbox> <repo> [icon]| Flag | Type | Default | Description |
|---|---|---|---|
--clear | bool | false | remove the icon |
orchard sandbox repo list
Section titled “orchard sandbox repo list”List repositories cloned into a sandbox
orchard sandbox repo list <sandbox>Aliases: ls
orchard sandbox retry
Section titled “orchard sandbox retry”Retry a sandbox’s failed Kubernetes or Vercel changes
orchard sandbox retry <name>orchard sandbox session
Section titled “orchard sandbox session”Manage worktree agent sessions inside a sandbox
orchard sandbox sessionAliases: sessions
orchard sandbox session archive
Section titled “orchard sandbox session archive”Archive a session (removes the worktree, keeps the branch)
orchard sandbox session archive <sandbox> <session>| Flag | Type | Default | Description |
|---|---|---|---|
--restore | bool | false | Restore an archived session instead |
orchard sandbox session create
Section titled “orchard sandbox session create”Start a session on a fresh git worktree (branch orchard/<slug>)
orchard sandbox session create <sandbox> <repo>| Flag | Type | Default | Description |
|---|---|---|---|
--agent | string | Coding agent: opencode (default), acp:claude, acp:opencode, acp:fx or acp:codex | |
--base | string | Base branch (defaults to the repo’s default branch) | |
--prompt | string | First prompt for the agent | |
--title | string | Session title |
orchard sandbox session list
Section titled “orchard sandbox session list”List sessions with their branch, diffstat and PR
orchard sandbox session list <sandbox>Aliases: ls
| Flag | Type | Default | Description |
|---|---|---|---|
--all | bool | false | Include archived sessions |
orchard sandbox session preview
Section titled “orchard sandbox session preview”Deploy a session branch as a gh-<slug> preview environment (host only)
orchard sandbox session preview <sandbox> <session>| Flag | Type | Default | Description |
|---|---|---|---|
--deployment | string | Deployment id whose config is copied | |
--remove | bool | false | Tear the preview environment down instead |
orchard sandbox session prompt
Section titled “orchard sandbox session prompt”Send a prompt to a session’s agent as yourself (reads stdin with - or no text)
orchard sandbox session prompt <sandbox> <session> [text|-]orchard sandbox session transcript
Section titled “orchard sandbox session transcript”Print the latest messages of a session’s agent chat
orchard sandbox session transcript <sandbox> <session>| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 0 | How many of the latest messages to show (1-200, default 30) |
orchard sandbox share
Section titled “orchard sandbox share”Read-only share links for organization teammates (transcript and diff only)
orchard sandbox shareorchard sandbox share create
Section titled “orchard sandbox share create”Create a share link (the token is shown once)
orchard sandbox share create <sandbox>| Flag | Type | Default | Description |
|---|---|---|---|
--expires-in | int | 0 | Hours until the link expires (1-720, default 168) |
--session | string | Share one session (id or slug) instead of every active session |
orchard sandbox share list
Section titled “orchard sandbox share list”List share links and whether they are active, expired or revoked
orchard sandbox share list <sandbox>Aliases: ls
orchard sandbox share revoke
Section titled “orchard sandbox share revoke”Revoke a share link; viewers lose access on their next request
orchard sandbox share revoke <sandbox> <link-id>orchard sandbox ssh
Section titled “orchard sandbox ssh”SSH into a sandbox through the orchard tunnel
orchard sandbox ssh <name> [-- ssh-args...]| Flag | Type | Default | Description |
|---|---|---|---|
--start | bool | false | start the sandbox first if it is stopped |
--user | string | dev | ssh user |
orchard sandbox ssh-config
Section titled “orchard sandbox ssh-config”Print ssh config Host blocks, or —install a wildcard orchard-* entry into ~/.ssh/config
orchard sandbox ssh-config [name]| Flag | Type | Default | Description |
|---|---|---|---|
--install | bool | false | generate an orchard ssh key, register it, and wire ssh orchard-<name> into ~/.ssh/config |
orchard sandbox start
Section titled “orchard sandbox start”Start a stopped sandbox
orchard sandbox start <name>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard sandbox stop
Section titled “orchard sandbox stop”Stop a sandbox (its home volume is kept)
orchard sandbox stop <name>| Flag | Type | Default | Description |
|---|---|---|---|
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the operation reaches a terminal state |
orchard sandbox update
Section titled “orchard sandbox update”Rename a sandbox or switch its ssh identity
orchard sandbox update <name>| Flag | Type | Default | Description |
|---|---|---|---|
--identity | string | ssh identity name or id to switch to | |
--name | string | new sandbox name | |
--no-setup | bool | false | remove the setup script |
--setup | string | setup script file run once on first boot (- reads stdin) |
orchard sandbox usage
Section titled “orchard sandbox usage”Show a machine’s CPU, memory, disk and time limits
orchard sandbox usage <sandbox>service
Section titled “service”orchard service
Section titled “orchard service”Manage deployment services and ports
orchard serviceAliases: services, svc
orchard service create
Section titled “orchard service create”Create a service exposing a port on a deployment
orchard service create| Flag | Type | Default | Description |
|---|---|---|---|
-d, --deployment | string | deployment id | |
--domain | string | custom domain for the service | |
--name | string | service name (default: port-<port>) | |
--node-port | int | 0 | explicit public port |
--port | int | 0 | service port (required) |
--protocol | string | TCP | port protocol (TCP|UDP) |
--public | bool | false | expose the service publicly |
--target-port | int | 0 | container port to route to (default: —port) |
orchard service delete
Section titled “orchard service delete”Delete a service from a deployment
orchard service delete <service-id>Aliases: rm
| Flag | Type | Default | Description |
|---|---|---|---|
-d, --deployment | string | deployment id |
orchard service exposure
Section titled “orchard service exposure”Manage service exposure
orchard service exposureorchard service exposure set
Section titled “orchard service exposure set”Switch a service between public and internal
orchard service exposure set <service-id> <public|internal>| Flag | Type | Default | Description |
|---|---|---|---|
-d, --deployment | string | deployment id |
orchard service list
Section titled “orchard service list”List services for a deployment
orchard service listAliases: ls
| Flag | Type | Default | Description |
|---|---|---|---|
-d, --deployment | string | deployment id |
orchard service port
Section titled “orchard service port”Manage individual service ports
orchard service portorchard service port public
Section titled “orchard service port public”Toggle public exposure of a single service port
orchard service port publicorchard service port public disable
Section titled “orchard service port public disable”Stop exposing a single service port publicly
orchard service port public disable <service-id> <port-id>| Flag | Type | Default | Description |
|---|---|---|---|
-d, --deployment | string | deployment id |
orchard service port public enable
Section titled “orchard service port public enable”Expose a single service port publicly
orchard service port public enable <service-id> <port-id>| Flag | Type | Default | Description |
|---|---|---|---|
-d, --deployment | string | deployment id |
orchard service update
Section titled “orchard service update”Update a service’s ports or domain
orchard service update <service-id>| Flag | Type | Default | Description |
|---|---|---|---|
-d, --deployment | string | deployment id | |
--domain | string | custom domain for the service (empty clears it) | |
--node-port | int | 0 | explicit public port |
--port | int | 0 | service port |
--protocol | string | TCP | port protocol (TCP|UDP) |
--target-port | int | 0 | container port to route to (default: —port) |
ssh-identity
Section titled “ssh-identity”orchard ssh-identity
Section titled “orchard ssh-identity”Manage the ssh identities your Greenhouse sandboxes accept
orchard ssh-identityAliases: ssh-key, identity
orchard ssh-identity add
Section titled “orchard ssh-identity add”Register an ssh public key as a named identity
orchard ssh-identity add <name>| Flag | Type | Default | Description |
|---|---|---|---|
--key | string | ssh public key: literal, @file, or a file path |
orchard ssh-identity import-github
Section titled “orchard ssh-identity import-github”Import your public ssh keys from GitHub as identities
orchard ssh-identity import-githuborchard ssh-identity list
Section titled “orchard ssh-identity list”List your ssh identities
orchard ssh-identity listAliases: ls
orchard ssh-identity remove
Section titled “orchard ssh-identity remove”Delete an ssh identity
orchard ssh-identity remove <name>Aliases: rm
status-page
Section titled “status-page”orchard status-page
Section titled “orchard status-page”Public status pages for an organization
orchard status-pageAliases: status-pages, statuspage
orchard status-page create
Section titled “orchard status-page create”Create a page: —title ‘Acme status’ —slug acme —component deployment:<id>
orchard status-page create| Flag | Type | Default | Description |
|---|---|---|---|
--component | stringSlice | [] | deployment:<id> or database:<id>, in order (repeatable) |
--description | string | one line under the title | |
--private | bool | false | create hidden; nothing renders until it is public |
--slug | string | path slug (default: the organization slug) | |
--subdomain | string | host under the apps domain | |
--title | string | page title (default: ‘<organization> status’) |
orchard status-page delete
Section titled “orchard status-page delete”Delete a page and its host
orchard status-page delete <pageId>Aliases: rm
orchard status-page list
Section titled “orchard status-page list”List the organization’s status pages
orchard status-page listAliases: ls
orchard status-page options
Section titled “orchard status-page options”Apps and databases a page can list
orchard status-page optionsorchard status-page show
Section titled “orchard status-page show”Read a public status page the way a visitor does
orchard status-page show [slug]| Flag | Type | Default | Description |
|---|---|---|---|
--host | string | resolve the page from its host instead of a slug |
orchard status-page update
Section titled “orchard status-page update”Change a page’s title, slug, host, visibility or components
orchard status-page update <pageId>| Flag | Type | Default | Description |
|---|---|---|---|
--component | stringSlice | [] | replace the components with deployment:<id> or database:<id> (repeatable) |
--description | string | new description | |
--no-subdomain | bool | false | remove the host |
--private | bool | false | hide the page |
--public | bool | false | make the page public |
--slug | string | new slug | |
--subdomain | string | new host under the apps domain | |
--title | string | new title |
tailscale
Section titled “tailscale”orchard tailscale
Section titled “orchard tailscale”Expose deployments on your Tailscale network
orchard tailscaleAliases: ts
orchard tailscale expose
Section titled “orchard tailscale expose”Expose a deployment on your tailnet through a proxy pod
orchard tailscale expose <deploymentId>orchard tailscale get
Section titled “orchard tailscale get”Show a deployment’s Tailscale exposure
orchard tailscale get <deploymentId>orchard tailscale link
Section titled “orchard tailscale link”Link your Tailscale account with an auth key
orchard tailscale link| Flag | Type | Default | Description |
|---|---|---|---|
--auth-key | string | Tailscale auth key (tskey-auth-…); falls back to ORCHARD_TS_AUTHKEY or a stdin prompt |
orchard tailscale status
Section titled “orchard tailscale status”Show whether a Tailscale account is linked
orchard tailscale statusorchard tailscale unexpose
Section titled “orchard tailscale unexpose”Remove a deployment’s Tailscale exposure
orchard tailscale unexpose <deploymentId>orchard tailscale unlink
Section titled “orchard tailscale unlink”Unlink your Tailscale account
orchard tailscale unlinktemplate
Section titled “template”orchard template
Section titled “orchard template”Deploy prebuilt app stacks from templates
orchard templateAliases: templates, tpl
orchard template admin create
Section titled “orchard template admin create”Create a template from a YAML definition file
orchard template admin create| Flag | Type | Default | Description |
|---|---|---|---|
--file | string | path to the template YAML definition (required) |
orchard template admin delete
Section titled “orchard template admin delete”Delete a template (fails while instances of it exist)
orchard template admin delete <id>Aliases: rm
orchard template admin update
Section titled “orchard template admin update”Replace a template’s YAML definition (built-ins can’t be updated)
orchard template admin update <id>| Flag | Type | Default | Description |
|---|---|---|---|
--file | string | path to the template YAML definition (required) |
orchard template deploy
Section titled “orchard template deploy”Deploy a template into the current project
orchard template deploy <templateId>| Flag | Type | Default | Description |
|---|---|---|---|
--cpu | int | 0 | CPU request override in millicores for created resources |
--memory | string | memory request override in bytes or with unit (e.g. “512Mi”) | |
--param | stringArray | [] | template parameter KEY=VAL (repeatable) |
orchard template get
Section titled “orchard template get”Show a template with its parameters and resources
orchard template get <id>orchard template instance
Section titled “orchard template instance”Manage deployed template instances
orchard template instanceAliases: instances
orchard template instance delete
Section titled “orchard template instance delete”Delete a template instance and every resource it created
orchard template instance delete <id>Aliases: rm
orchard template instance get
Section titled “orchard template instance get”Show a template instance and the resources it created
orchard template instance get <id>orchard template instance list
Section titled “orchard template instance list”List template instances in the current project
orchard template instance listAliases: ls
orchard template list
Section titled “orchard template list”List available templates
orchard template listAliases: ls
orchard top
Section titled “orchard top”Live pods, resources and traffic for one app, or one database with —db
orchard top <id>| Flag | Type | Default | Description |
|---|---|---|---|
--db | bool | false | the id is a database |
--once | bool | false | print one snapshot and exit |
orchard ui
Section titled “orchard ui”Launch the interactive dashboard
orchard uiAliases: dash, tui
unlink
Section titled “unlink”orchard unlink
Section titled “orchard unlink”Remove the directory link created by orchard link
orchard unlinkorchard up
Section titled “orchard up”Deploy the current directory
orchard up [dir]| Flag | Type | Default | Description |
|---|---|---|---|
--build-cmd | string | override the detected build command | |
--detach | bool | false | start the build without following its logs |
--dockerfile | string | Dockerfile path relative to the directory | |
--install-cmd | string | override the detected install command | |
--name | string | deployment name (default: directory name) | |
--output-dir | string | directory of built static files; serves the app as a static site | |
--port | int | 0 | port the app listens on (default: EXPOSE, the base image’s port, or 3000) |
--railpack | bool | false | force a Railpack build even when a Dockerfile exists |
--root | string | directory of the app inside the repo (monorepos) | |
--start-cmd | string | override the detected start command | |
--timeout | duration | 10m0s | give up waiting after this long (exit 8) |
--wait | bool | false | block until the deploy is live; —wait=false returns when the build finishes |
orchard use
Section titled “orchard use”Set the default org/project/env for future commands
orchard use <org|project|env> <id-or-slug>orchard user
Section titled “orchard user”Manage your user profile
orchard userorchard user avatar
Section titled “orchard user avatar”Manage your avatar image
orchard user avatarorchard user avatar delete
Section titled “orchard user avatar delete”Remove your avatar
orchard user avatar deleteAliases: rm
orchard user avatar set
Section titled “orchard user avatar set”Upload an avatar image (jpeg/png/gif/webp, max 5MB)
orchard user avatar set <file>orchard user profile
Section titled “orchard user profile”Show your profile
orchard user profileorchard user profile update
Section titled “orchard user profile update”Update your profile (only flagged fields change)
orchard user profile update| Flag | Type | Default | Description |
|---|---|---|---|
--first-name | string | new first name ("" to clear) | |
--last-name | string | new last name ("" to clear) | |
--username | string | new username (must be unique) |
version
Section titled “version”orchard version
Section titled “orchard version”Print the CLI version
orchard versionwebhook
Section titled “webhook”orchard webhook
Section titled “orchard webhook”Trigger deploy webhooks
orchard webhookAliases: webhooks
orchard webhook deploy
Section titled “orchard webhook deploy”Trigger a deployment via a webhook token (no sign-in required)
orchard webhook deploy <token>| Flag | Type | Default | Description |
|---|---|---|---|
--image | string | switch to this image before restarting (Docker-image deployments only) | |
--tag | string | image tag to deploy (server defaults to latest when only —image is set) |