# CLI reference > Every orchard CLI command, generated from the binary's own command tree. Source: https://docs.orchard.hackclub.com/reference/cli/ 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. ```bash brew install --cask leafdtk/tap/orchard-cli ``` Every command accepts `-o json` for machine-readable output, and `--org` / `--env` to override the saved context. **428 commands** are available. ## alert ### `orchard alert` Threshold alerts on app metrics ```bash orchard alert ``` Aliases: `alerts` ### `orchard alert create` Add a rule: --metric cpu_percent --threshold 85 --for 300 ```bash 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` Delete a rule ```bash orchard alert delete ``` Aliases: `rm` ### `orchard alert list` List alert rules, including the ones inherited from above ```bash orchard alert list ``` Aliases: `ls` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--deployment` | string | | scope to a deployment id | | `--project` | string | | scope to a project id | ### `orchard alert metrics` The metrics a rule can watch ```bash orchard alert metrics ``` ### `orchard alert status` Every rule that applies to an app and whether it is firing ```bash orchard alert status ``` ### `orchard alert update` Change a rule's threshold, window, or enabled state ```bash orchard alert update ``` | 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 | ## api ### `orchard api` Call any Orchard API operation, or search the API ```bash orchard api ``` | 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` Show an operation's params, body and response schema ```bash orchard api describe ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--refresh` | bool | `false` | revalidate the cached spec first | ### `orchard api search` Find API operations by keywords ```bash orchard api search ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--limit` | int | `10` | maximum results | | `--refresh` | bool | `false` | revalidate the cached spec first | ## audit ### `orchard audit` Inspect the audit log ```bash orchard audit ``` Aliases: `audit-log`, `audit-logs` ### `orchard audit list` List audit log entries for the organization (or one deployment), newest first ```bash orchard audit list ``` Aliases: `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 | ## auth ### `orchard auth` Manage authentication ```bash orchard auth ``` ### `orchard auth login` Authenticate with Orchard ```bash 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` Remove the stored token ```bash orchard auth logout ``` ### `orchard auth session` Manage browser sign-in sessions ```bash orchard auth session ``` Aliases: `sessions` ### `orchard auth session list` List active browser sessions ```bash orchard auth session list ``` Aliases: `ls` ### `orchard auth session revoke` Revoke a browser session (signs that device out) ```bash orchard auth session revoke ``` ### `orchard auth session revoke-all` Sign out everywhere: revoke all sessions and delete every API token ```bash orchard auth session revoke-all ``` ### `orchard auth status` Show the current authentication state ```bash orchard auth status ``` ### `orchard auth token` Manage personal API tokens (orch_…) ```bash orchard auth token ``` Aliases: `tokens` ### `orchard auth token create` Create a personal API token (the secret is shown only once) ```bash 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` List your API tokens (secrets are never shown) ```bash orchard auth token list ``` Aliases: `ls` ### `orchard auth token revoke` Revoke an API token ```bash orchard auth token revoke ``` Aliases: `delete`, `rm` ## claude ### `orchard claude` Import your Claude Code setup into Orchard (CLAUDE.md, agents, commands, skills, MCP servers) ```bash orchard claude ``` ### `orchard claude import` Import your Claude Code setup (CLAUDE.md, agents, commands, skills, MCP servers) ```bash 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` List the Claude Code setup imported into your account ```bash orchard claude list ``` Aliases: `ls` ### `orchard claude remove` Remove one imported item from your account ```bash orchard claude remove / ``` Aliases: `rm` ## commands ### `orchard commands` List every command in the CLI (full dump with -o json) ```bash orchard commands ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-h`, `--help` | bool | `false` | help for commands | ## completion ### `orchard completion` Generate the autocompletion script for the specified shell ```bash orchard completion ``` ### `orchard completion bash` Generate the autocompletion script for bash ```bash orchard completion bash ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--no-descriptions` | bool | `false` | disable completion descriptions | ### `orchard completion fish` Generate the autocompletion script for fish ```bash orchard completion fish ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--no-descriptions` | bool | `false` | disable completion descriptions | ### `orchard completion powershell` Generate the autocompletion script for powershell ```bash orchard completion powershell ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--no-descriptions` | bool | `false` | disable completion descriptions | ### `orchard completion zsh` Generate the autocompletion script for zsh ```bash orchard completion zsh ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--no-descriptions` | bool | `false` | disable completion descriptions | ## compose ### `orchard compose` Manage Docker Compose stacks ```bash orchard compose ``` Aliases: `compose-stack`, `compose-stacks`, `stack`, `stacks` ### `orchard compose auto-deploy` Toggle push-to-deploy for a stack and its service deployments ```bash orchard compose auto-deploy ``` ### `orchard compose auto-deploy disable` Disable auto-deploy for the stack ```bash orchard compose auto-deploy disable ``` ### `orchard compose auto-deploy enable` Enable auto-deploy for the stack ```bash orchard compose auto-deploy enable ``` ### `orchard compose delete` Delete a compose stack and all of its service deployments ```bash orchard compose delete ``` Aliases: `rm` ### `orchard compose deploy` Deploy a compose stack from a GitHub repo's compose file ```bash 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` Show a compose stack and its service deployments ```bash orchard compose get ``` ### `orchard compose list` List compose stacks in the current project ```bash orchard compose list ``` Aliases: `ls` ### `orchard compose redeploy` Re-pull the compose file and apply it to the stack's services ```bash orchard compose redeploy ``` ## console ### `orchard console` Open the app's language REPL inside a running pod ```bash orchard console ``` 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 ### `orchard context` Switch between Orchard instances and show the default scope ```bash orchard context ``` Aliases: `ctx` ### `orchard context clear` Clear the default scope ```bash orchard context clear ``` ### `orchard context current` Print the active context name ```bash orchard context current ``` ### `orchard context list` List the Orchard instances you have signed in to ```bash orchard context list ``` Aliases: `ls` ### `orchard context remove` Forget a context and its stored token ```bash orchard context remove ``` Aliases: `rm` ### `orchard context rename` Rename a context ```bash orchard context rename ``` ### `orchard context show` Show the current default scope ```bash orchard context show ``` ### `orchard context use` Make a context the active one (pick from a list without a name) ```bash orchard context use [name] ``` ## db ### `orchard db` Manage databases ```bash orchard db ``` Aliases: `database`, `databases` ### `orchard db activity` Show open sessions and blocked queries (needs a deploy-scope token) ```bash orchard db activity ``` ### `orchard db backup` Manage database backups ```bash orchard db backup ``` Aliases: `backups` ### `orchard db backup create` Trigger a new backup (runs asynchronously) ```bash orchard db backup create ``` | 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` List backups for a database ```bash orchard db backup list ``` Aliases: `ls` ### `orchard db backup restore` Restore a database from a backup, a checkpoint or a point in time (latest when none is given) ```bash orchard db backup restore [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` Manage the automated backup schedule ```bash orchard db backup-schedule ``` Aliases: `schedule` ### `orchard db backup-schedule clear` Turn off automated backups and WAL archiving (backups already taken are kept) ```bash orchard db backup-schedule clear ``` ### `orchard db backup-schedule get` Show the backup schedule ```bash orchard db backup-schedule get ``` ### `orchard db backup-schedule set` Set the backup schedule (--cron, or a preset) ```bash orchard db backup-schedule set ``` | 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` Manage checkpoints (named restore points you can roll back to) ```bash orchard db checkpoint ``` Aliases: `checkpoints`, `cp` ### `orchard db checkpoint create` Take a checkpoint of one database, or of every database in the project or environment ```bash orchard db checkpoint create [dbId] ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--label` | string | | label to find the checkpoint by later | ### `orchard db checkpoint group` List the checkpoints taken together in one group ```bash orchard db checkpoint group ``` ### `orchard db checkpoint list` List a database's checkpoints ```bash orchard db checkpoint list ``` Aliases: `ls` ### `orchard db checkpoint restore` Restore a database to a checkpoint (in place, or into a new database with --fork) ```bash orchard db checkpoint restore ``` | 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` Restore every database in a checkpoint group to that group's checkpoints ```bash orchard db checkpoint restore-group ``` | 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` Hide a checkpoint so it is no longer offered for restore ```bash orchard db checkpoint rm ``` Aliases: `delete` ### `orchard db connection` Show connection details and credentials (recorded in the audit log) ```bash orchard db connection ``` Aliases: `conn` ### `orchard db create` Create a Postgres database in the current project ```bash 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` Delete a database (kept in the trash for 30 days when it has a backup) ```bash orchard db delete ``` Aliases: `rm` ### `orchard db diagnose` Explain a database's health in one call (exits 10 when it is down) ```bash orchard db diagnose ``` ### `orchard db extension` Manage Postgres extensions ```bash orchard db extension ``` Aliases: `extensions`, `ext` ### `orchard db extension install` Install a Postgres extension ```bash orchard db extension install ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--preload` | bool | `false` | add to shared_preload_libraries (causes a database restart) | ### `orchard db extension list` List available and installed extensions ```bash orchard db extension list ``` Aliases: `ls` ### `orchard db extension uninstall` Drop a Postgres extension (and objects depending on it) ```bash orchard db extension uninstall ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--remove-preload` | bool | `false` | also remove from shared_preload_libraries (causes a database restart) | ### `orchard db fork` Copy a database into a new one, from now, a backup, a checkpoint or a point in time ```bash orchard db fork ``` | 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` Show a database ```bash orchard db get ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--watch` | bool | `false` | keep re-rendering as the database changes (TTY only) | ### `orchard db killed` Inspect logs captured from killed database containers ```bash orchard db killed ``` ### `orchard db killed list` List killed-container log captures for a database ```bash orchard db killed list ``` Aliases: `ls` ### `orchard db killed logs` Print the captured logs of a killed database container ```bash orchard db killed logs ``` ### `orchard db list` List databases (scoped to the current project or organization when set) ```bash orchard db list ``` Aliases: `ls` ### `orchard db logs` Fetch Postgres logs from the database pod ```bash orchard db logs ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--tail` | int | `200` | number of log lines to fetch | ### `orchard db metrics` Show CPU/memory/network usage for the database pod ```bash orchard db metrics ``` | 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` Inspect and control restore, fork, undelete, upgrade and restore test operations ```bash orchard db ops ``` Aliases: `op`, `operations` ### `orchard db ops cancel` Cancel an operation that hasn't finished ```bash orchard db ops cancel ``` ### `orchard db ops get` Show an operation (--wait blocks until it succeeds or fails) ```bash orchard db ops get ``` | 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` List operations on a database, newest first ```bash orchard db ops list ``` Aliases: `ls` ### `orchard db ops undo` Swap back to the copy from before an in-place restore (within 24 hours) ```bash orchard db ops undo ``` | 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` Manage the PgBouncer connection pooler in front of a database ```bash orchard db pooler ``` ### `orchard db pooler get` Show the pooler's settings and state ```bash orchard db pooler get ``` ### `orchard db pooler set` Turn the pooler on or off and change its settings ```bash orchard db pooler set ``` | 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` Show or change deletion protection, DDL checkpoints and scheduled restore tests ```bash orchard db protect ``` | 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` Open an interactive psql session in a sandboxed client pod ```bash orchard db psql ``` ### `orchard db public` Manage public access ```bash orchard db public ``` ### `orchard db public disable` Stop exposing the database publicly ```bash orchard db public disable ``` ### `orchard db public enable` Expose the database publicly with TLS ```bash orchard db public enable ``` ### `orchard db recovery` Show how far back a database can be restored, and what it can be restored from ```bash orchard db recovery ``` ### `orchard db replication` Show or change how standbys confirm writes (async, preferred or required) ```bash orchard db replication ``` ### `orchard db replication get` Show the replication mode ```bash orchard db replication get ``` ### `orchard db replication set` Set the replication mode (preferred and required need at least 2 instances) ```bash orchard db replication set ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--mode` | string | | async\|preferred\|required (required) | ### `orchard db resources` Manage CPU/memory requests ```bash orchard db resources ``` ### `orchard db resources set` Update CPU/memory requests (restarts the database pod) ```bash orchard db resources set ``` | 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` Set a new password and push it to every bound app ```bash orchard db rotate-password ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-y`, `--yes` | bool | `false` | skip the confirmation | ### `orchard db security` Show the running Postgres version, known CVEs and what fixes them ```bash orchard db security ``` ### `orchard db settings` Read or update Postgres parameters ```bash orchard db settings ``` ### `orchard db settings get` Show configured Postgres parameters ```bash orchard db settings get ``` ### `orchard db settings set` Update Postgres parameters (KEY= removes a parameter) ```bash orchard db settings set KEY=VAL... ``` ### `orchard db storage` Manage the storage volume ```bash orchard db storage ``` ### `orchard db storage expand` Grow the storage volume (never shrinks) ```bash orchard db storage expand ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--size` | string | | new volume size, e.g. "10Gi" (required) | ### `orchard db test-backup` Prove backups restore: restore the latest one into a throwaway copy and check it ```bash orchard db test-backup ``` Aliases: `restore-test`, `restore-tests` ### `orchard db test-backup list` List past restore tests and their results ```bash orchard db test-backup list ``` Aliases: `ls` ### `orchard db test-backup run` Start a restore test now (the throwaway copy is deleted afterwards) ```bash orchard db test-backup run ``` | 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` List and bring back deleted databases (kept for 30 days) ```bash orchard db trash ``` ### `orchard db trash list` List deleted databases in the current project ```bash orchard db trash list ``` Aliases: `ls` ### `orchard db trash restore` Bring a deleted database back from its backups ```bash orchard db trash restore ``` | 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` Move a database to the newest minor release of its Postgres major ```bash orchard db update ``` ### `orchard db upgrade` Upgrade a database to a newer Postgres major version ```bash orchard db upgrade ``` | 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` Manage extra Postgres users with read or write access ```bash orchard db user ``` Aliases: `users` ### `orchard db user create` Create a user and print its password once (needs a deploy-scope token) ```bash orchard db user create ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--access` | string | `read` | read\|write | ### `orchard db user list` List the extra users of a database ```bash orchard db user list ``` Aliases: `ls` ### `orchard db user rm` Drop a user ```bash orchard db user rm ``` Aliases: `delete` ### `orchard db versions` List the Postgres major versions you can create or upgrade to ```bash orchard db versions ``` ## deploy ### `orchard deploy` Manage deployments ```bash orchard deploy ``` Aliases: `deployment`, `deployments` ### `orchard deploy auto-deploy` Manage push-to-deploy for GitHub deployments ```bash orchard deploy auto-deploy ``` ### `orchard deploy auto-deploy disable` Stop auto-deploying on pushes ```bash orchard deploy auto-deploy disable ``` ### `orchard deploy auto-deploy enable` Rebuild automatically on pushes to a branch ```bash orchard deploy auto-deploy enable ``` | 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` Show auto-deploy configuration ```bash orchard deploy auto-deploy status ``` ### `orchard deploy bindings` Databases and apps this app is connected to ```bash orchard deploy bindings ``` ### `orchard deploy bindings add` Connect a database or another app and add the obvious variable ```bash orchard deploy bindings add (--database | --app ) ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--app` | string | | app name or id on the same project | | `--as` | string | | binding name used in ${{resource..*}} (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, _URL for an app) | | `--no-env` | bool | `false` | bind only, don't add an env var | ### `orchard deploy bindings list` List bindings ```bash orchard deploy bindings list ``` ### `orchard deploy bindings options` Databases and apps on the project that can still be connected ```bash orchard deploy bindings options ``` ### `orchard deploy bindings remove` Disconnect a resource ```bash orchard deploy bindings remove ``` ### `orchard deploy build-config` Manage how a deployment is built ```bash orchard deploy build-config ``` ### `orchard deploy build-config set` Change build settings for a deployment ```bash orchard deploy build-config set ``` | 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` Manage the build context of a GitHub deployment ```bash orchard deploy build-root ``` ### `orchard deploy build-root set` Build from the repo root (on) or the Dockerfile directory (off) ```bash orchard deploy build-root set ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--depot` | bool | `false` | build with Depot | | `--persistent-cache` | bool | `false` | keep a persistent build cache between builds | ### `orchard deploy cancel` Cancel an in-progress build ```bash orchard deploy cancel ``` ### `orchard deploy create` Create a deployment from a Docker image or a GitHub repo ```bash 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` Delete a deployment and its Kubernetes resources ```bash orchard deploy delete ``` Aliases: `rm` ### `orchard deploy env` Manage a deployment's environment variables ```bash orchard deploy env ``` ### `orchard deploy env get` Show environment variables ```bash orchard deploy env get ``` ### `orchard deploy env set` Add or update environment variables (pods restart) ```bash orchard deploy env set [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` Remove environment variables (pods restart) ```bash orchard deploy env unset KEY... ``` ### `orchard deploy get` Show a deployment ```bash orchard deploy get ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--watch` | bool | `false` | keep re-rendering as the deployment changes (TTY only) | ### `orchard deploy github-deployments` List GitHub deployment status entries for this deployment ```bash orchard deploy github-deployments ``` ### `orchard deploy health-check` Manage liveness/readiness/startup probes ```bash orchard deploy health-check ``` ### `orchard deploy health-check set` Update health check configuration (unset flags keep current values) ```bash orchard deploy health-check set ``` | 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` Show a deployment's image history ```bash orchard deploy history ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--logs` | string | | print build logs for one image history entry | ### `orchard deploy icon` Manage the app picture ```bash orchard deploy icon ``` ### `orchard deploy icon set` Upload an app picture (jpeg/png/gif/webp) ```bash orchard deploy icon set ``` ### `orchard deploy image` Manage the Docker image of an image-source deployment ```bash orchard deploy image ``` ### `orchard deploy image set` Change the image (GitHub-built deployments must use `deploy rebuild`) ```bash orchard deploy image set ``` | 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` Inspect logs captured from killed containers ```bash orchard deploy killed ``` ### `orchard deploy killed list` List killed-container log captures ```bash orchard deploy killed list ``` Aliases: `ls` ### `orchard deploy killed logs` Print the captured logs of a killed container ```bash orchard deploy killed logs ``` ### `orchard deploy list` List deployments (scoped to the current project when one is set) ```bash orchard deploy list ``` Aliases: `ls` ### `orchard deploy logs` Fetch runtime pod logs (or build logs with --build) ```bash orchard deploy logs ``` | 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` Show CPU/memory/network metrics for the last hour ```bash orchard deploy metrics ``` ### `orchard deploy pods` List a deployment's pods ```bash orchard deploy pods ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--live` | bool | `false` | query Kubernetes directly (includes usage and warnings) | ### `orchard deploy pull-policy` Manage whether the image is re-pulled on every pod start ```bash orchard deploy pull-policy ``` ### `orchard deploy pull-policy set` Override the image pull policy ```bash orchard deploy pull-policy set ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--policy` | string | | pull policy: auto\|always\|ifnotpresent (required) | ### `orchard deploy rebuild` Rebuild a deployment from source ```bash orchard deploy rebuild ``` | 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` List releases, newest first ```bash orchard deploy releases ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--limit` | int | `20` | how many releases to show | ### `orchard deploy resources` Manage a deployment's CPU/memory requests ```bash orchard deploy resources ``` ### `orchard deploy resources get` Show CPU/memory requests ```bash orchard deploy resources get ``` ### `orchard deploy resources set` Update CPU/memory requests (0 clears to the organization default; pods restart) ```bash orchard deploy resources set ``` | 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` Restart a deployment's pods ```bash orchard deploy restart ``` | 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` Roll a deployment back to a previous image (default: the previous release) ```bash orchard deploy rollback [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` Scale a deployment to N replicas ```bash orchard deploy scale ``` | 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` Start a stopped deployment; builds the latest held push first when there is one ```bash orchard deploy start ``` | 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` Show whether a deployment is live, and if not, why ```bash orchard deploy status ``` | 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` Stop a deployment: scale it to zero and hold pushes until it is started ```bash orchard deploy stop ``` ### `orchard deploy strategy` Manage the Kubernetes update strategy ```bash orchard deploy strategy ``` ### `orchard deploy strategy set` Set the update strategy (deployments with volumes require recreate) ```bash orchard deploy strategy set ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--type` | string | | update strategy: rollingupdate\|recreate\|bluegreen (required) | ### `orchard deploy volumes` Manage a deployment's volumes ```bash orchard deploy volumes ``` ### `orchard deploy volumes get` Show attached volumes ```bash orchard deploy volumes get ``` ### `orchard deploy volumes set` Replace all volumes with the given volumes ```bash orchard deploy volumes set ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--volume` | stringArray | `[]` | volume as mountPath=size (repeatable); omit to remove all volumes | ### `orchard deploy webhook-token` Manage deploy webhook trigger tokens ```bash orchard deploy webhook-token ``` Aliases: `webhook-tokens` ### `orchard deploy webhook-token create` Create a webhook token that restarts the deployment via POST ```bash orchard deploy webhook-token create ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--label` | string | | human-readable label for the token | ### `orchard deploy webhook-token delete` Delete a webhook token ```bash orchard deploy webhook-token delete ``` Aliases: `rm` ### `orchard deploy webhook-token list` List webhook tokens (secrets are never shown again) ```bash orchard deploy webhook-token list ``` Aliases: `ls` ## doctor ### `orchard doctor` Check the instance's isolation and security configuration (superadmin) ```bash 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 ### `orchard domain` Manage domains ```bash orchard domain ``` Aliases: `ingress`, `domains` ### `orchard domain create` Add a domain to a deployment ```bash 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` Delete a domain ```bash orchard domain delete ``` Aliases: `rm` ### `orchard domain get` Show a domain ```bash orchard domain get ``` ### `orchard domain list` List domains ```bash orchard domain list ``` Aliases: `ls` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--deployment` | string | | list domains of this deployment id | ### `orchard domain protection` Control access protection on a domain ```bash orchard domain protection ``` ### `orchard domain protection get` Show a domain's protection mode and bypass secret ```bash orchard domain protection get ``` ### `orchard domain protection set` Set a domain's protection mode ```bash orchard domain protection set ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--mode` | string | | protection mode: none\|password\|orchard | | `--password` | string | | password (required with --mode password) | ### `orchard domain update` Update a domain's host, path, port, or TLS ```bash orchard domain update ``` | 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` Check that a domain's DNS points at your instance ```bash orchard domain validate-dns ``` ## env ### `orchard env` Manage project environments ```bash orchard env ``` Aliases: `environment`, `envs` ### `orchard env create` Create an environment in the project ```bash 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` Delete an environment and its namespace ```bash orchard env delete ``` Aliases: `rm` ### `orchard env get` Show an environment ```bash orchard env get [name-or-id] ``` ### `orchard env list` List environments in the project ```bash orchard env list ``` Aliases: `ls` ### `orchard env pull` Write environment variables to a local dotenv file ```bash 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` Make an environment the project default ```bash orchard env set-default ``` ### `orchard env vars` Manage shared environment variables ```bash orchard env vars ``` Aliases: `var` ### `orchard env vars get` List shared variables (secret values are write-only, never returned) ```bash orchard env vars get [env] ``` Aliases: `list`, `ls` ### `orchard env vars set` Set shared variables (merged into the existing set) ```bash 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` Remove shared variables ```bash orchard env vars unset KEY [KEY ...] ``` Aliases: `rm`, `remove` ## events ### `orchard events` Stream live events from the organization event bus ```bash orchard events ``` ### `orchard events tail` Tail organization events until interrupted (NDJSON when piped) ```bash 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) | ## git ### `orchard git` Git providers you have linked with your own token ```bash orchard git ``` Aliases: `git-providers`, `providers` ### `orchard git add` Connect a git provider ```bash orchard git add --provider --name --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` List branches of a repository ```bash orchard git branches ``` ### `orchard git detect` Inspect a repository the way the new app form does ```bash orchard git detect ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--branch` | string | | branch to inspect (default: the repository default) | ### `orchard git list` List git providers ```bash orchard git list ``` ### `orchard git remove` Disconnect a git provider ```bash orchard git remove ``` ### `orchard git repos` List repositories the token can see ```bash orchard git repos ``` ### `orchard git webhook` Show the webhook URL and secret to paste into the forge ```bash orchard git webhook ``` ## github ### `orchard github` Manage the GitHub integration ```bash orchard github ``` Aliases: `gh` ### `orchard github branches` List a repository's branches ```bash orchard github branches ``` ### `orchard github contents` List files and directories in a repository ```bash orchard github contents [path] ``` Aliases: `ls` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--branch` | string | | branch to read from (default: the repo's default branch) | ### `orchard github dockerfile-info` Show exposed ports, env vars, and build stages of a Dockerfile ```bash orchard github dockerfile-info ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--branch` | string | | branch to read from (default: the repo's default branch) | ### `orchard github dockerfiles` Find Dockerfiles in a repository ```bash orchard github dockerfiles ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--branch` | string | | branch to search (default: the repo's default branch) | ### `orchard github install` Get the GitHub App installation URL ```bash orchard github install ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--open` | bool | `false` | open the URL in your browser | ### `orchard github installations` List GitHub App installations available to your account ```bash orchard github installations ``` ### `orchard github link` Link your GitHub account (opens the OAuth flow in a browser) ```bash orchard github link ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--open` | bool | `false` | open the URL in your browser | ### `orchard github repos` List repositories you can deploy from ```bash orchard github repos ``` Aliases: `repositories` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--all` | bool | `false` | fetch more pages from the OAuth fallback listing | ### `orchard github status` Show the linked GitHub account and app installations ```bash orchard github status ``` ### `orchard github unlink` Unlink your GitHub account ```bash orchard github unlink ``` ## help ### `orchard help` Help about any command ```bash orchard help [command] ``` ## import ### `orchard import` Import a GitHub repo and deploy it ```bash orchard import ``` | 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 ### `orchard invitation` View and act on organization invitations sent to you ```bash orchard invitation ``` Aliases: `invitations` ### `orchard invitation accept` Accept a pending invitation ```bash orchard invitation accept ``` ### `orchard invitation accept-all` Accept every pending invitation ```bash orchard invitation accept-all ``` ### `orchard invitation decline` Decline a pending invitation ```bash orchard invitation decline ``` ### `orchard invitation list` List your pending invitations ```bash orchard invitation list ``` Aliases: `ls` ## job ### `orchard job` Manage scheduled jobs (multi-step pipelines) ```bash orchard job ``` Aliases: `jobs` ### `orchard job create` Create a job in the project from a steps file ```bash 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` Delete a job, its schedule, and its run history ```bash orchard job delete ``` Aliases: `rm` ### `orchard job get` Show a job and its steps ```bash orchard job get ``` ### `orchard job list` List jobs in the organization (or the current project when one is set) ```bash orchard job list ``` Aliases: `ls` ### `orchard job pause` Pause a job's schedule (manual runs still work) ```bash orchard job pause ``` ### `orchard job resume` Resume a paused job's schedule ```bash orchard job resume ``` ### `orchard job run` Trigger a job run now ```bash orchard job run ``` | 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` List a job's run history, newest first ```bash orchard job runs ``` | 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` Manage a job's step pipeline ```bash orchard job steps ``` ### `orchard job steps set` Replace a job's entire ordered step list ```bash orchard job steps set ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--file` | string | | path to the steps JSON file (required) | ### `orchard job update` Update a job's name, schedule, or paused state ```bash orchard job update ``` | 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 ### `orchard job-run` Inspect and manage job runs ```bash orchard job-run ``` Aliases: `job-runs` ### `orchard job-run cancel` Cancel an in-progress run (remaining steps are skipped) ```bash orchard job-run cancel ``` ### `orchard job-run get` Show a run: status, timing, and per-step results ```bash orchard job-run get ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--watch` | bool | `false` | keep re-rendering as the run progresses (TTY only) | ### `orchard job-run logs` Print step logs (all steps in order, or one with --step) ```bash orchard job-run logs ``` | 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 ### `orchard licenses` Show the licenses of the open-source software built into this CLI ```bash orchard licenses ``` ## link ### `orchard link` Link this directory to an Orchard project ```bash 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 | ## logs ### `orchard logs` Fetch or follow a deployment's logs (shortcut for `deploy logs`) ```bash orchard logs ``` | 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 ### `orchard member` Manage members of the scoped organization ```bash orchard member ``` Aliases: `members` ### `orchard member enable` Turn a member's access back on (projects are not restored) ```bash orchard member enable ``` ### `orchard member invite` Invite someone to the organization by email ```bash orchard member invite ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--role` | string | `member` | organization role: owner\|admin\|member | ### `orchard member invites` Manage the organization's pending invitations ```bash orchard member invites ``` Aliases: `invitations` ### `orchard member invites cancel` Cancel a pending invitation ```bash orchard member invites cancel ``` Aliases: `revoke`, `rm` ### `orchard member invites list` List pending invitations for the organization ```bash orchard member invites list ``` Aliases: `ls` ### `orchard member invites resend` Resend a pending invitation's email, or create a new link with no email ```bash orchard member invites resend ``` ### `orchard member list` List members of the organization ```bash orchard member list ``` Aliases: `ls` ### `orchard member remove` Turn off a member's access (they stay on the list and can be turned back on) ```bash orchard member remove ``` Aliases: `rm`, `disable` ### `orchard member set-role` Change a member's organization role (owner\|admin\|member\|guest) ```bash orchard member set-role ``` ## notify ### `orchard notify` Manage organization notification channels ```bash orchard notify ``` Aliases: `notification`, `notifications` ### `orchard notify channel` Manage notification channels ```bash orchard notify channel ``` Aliases: `channels` ### `orchard notify channel create` Create a notification channel in the organization ```bash 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` Delete a notification channel and its delivery history ```bash orchard notify channel delete ``` Aliases: `rm` ### `orchard notify channel list` List the organization's notification channels ```bash orchard notify channel list ``` Aliases: `ls` ### `orchard notify channel test` Send a test notification through a channel ```bash orchard notify channel test ``` ### `orchard notify channel update` Update a notification channel ```bash orchard notify channel update ``` | 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` List a channel's recent delivery attempts, newest first ```bash orchard notify deliveries ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--limit` | int | `30` | show at most this many deliveries | ## observe ### `orchard observe` Deployment observability: logs, HTTP metrics, errors, runtime ```bash orchard observe ``` Aliases: `obs` ### `orchard observe activity` Activity feed for a deployment ```bash orchard observe activity ``` 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` Which observability signals are available for this deployment ```bash orchard observe capabilities ``` ### `orchard observe errors` Grouped error log entries with counts and trends ```bash orchard observe errors ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--window` | string | `1h` | time window (15m, 1h, 6h or 24h) | ### `orchard observe http` HTTP request rate, error rate and latency for the last hour ```bash orchard observe http ``` ### `orchard observe logs` Structured logs (level detection, multi-line grouping) with filter and follow ```bash orchard observe logs ``` | 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` Stat strip: uptime, pods, restarts, cpu/mem, request rate, errors, latency ```bash orchard observe overview ``` ### `orchard observe runtime` Detected language/framework (from build logs, image, env vars or dockerfile) ```bash orchard observe runtime ``` ## open ### `orchard open` Open a deployment's URL in your browser ```bash orchard open [deployment-id] ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--dash` | bool | `false` | open the deployment's dashboard page instead of the app URL | ## org ### `orchard org` Manage organizations ```bash orchard org ``` Aliases: `orgs`, `organization`, `organizations` ### `orchard org avatar` Manage the organization avatar ```bash orchard org avatar ``` ### `orchard org avatar delete` Remove the organization avatar ```bash orchard org avatar delete ``` Aliases: `rm` ### `orchard org avatar set` Upload an organization avatar image ```bash orchard org avatar set ``` ### `orchard org backup-settings` Organization-wide R2 settings for database backups ```bash orchard org backup-settings ``` Aliases: `backups` ### `orchard org backup-settings get` Show the scoped organization's backup settings ```bash orchard org backup-settings get ``` ### `orchard org backup-settings set` Update the scoped organization's backup settings ```bash 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://.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` Show an organization (defaults to the current scope) ```bash orchard org get [slug-or-id] ``` ### `orchard org list` List organizations you belong to ```bash orchard org list ``` Aliases: `ls` ### `orchard org registry` Manage default registry credentials for the scoped organization ```bash orchard org registry ``` Aliases: `registries`, `pull-secret` ### `orchard org registry list` List organization registry defaults ```bash orchard org registry list ``` Aliases: `ls` ### `orchard org registry remove` Remove a registry credential ```bash orchard org registry remove ``` Aliases: `rm`, `delete` ### `orchard org registry set` Add or replace the credential for a registry (ghcr.io, docker.io, registry.gitlab.com, ...) ```bash orchard org registry set ``` | 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` Update an organization ```bash orchard org update ``` | 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 ### `orchard overview` Org dashboard: projects, deployments, and databases at a glance ```bash 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 | ## pod ### `orchard pod` Inspect and interact with running pods ```bash orchard pod ``` Aliases: `pods` ### `orchard pod delete` Delete a pod (its controller will replace it) ```bash orchard pod delete ``` Aliases: `rm` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-n`, `--namespace` | string | | kubernetes namespace (default: the scoped project's namespace) | ### `orchard pod exec` Run a one-shot command in a pod (like kubectl exec) ```bash orchard pod exec -- ``` | 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` Show a pod's status, containers, and node ```bash orchard pod get ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-n`, `--namespace` | string | | kubernetes namespace (default: the scoped project's namespace) | ### `orchard pod list` List pods in a namespace ```bash orchard pod list ``` Aliases: `ls` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-n`, `--namespace` | string | | kubernetes namespace (default: the scoped project's namespace) | ### `orchard pod logs` Fetch runtime logs from a pod ```bash orchard pod logs ``` | 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` Open an interactive shell in a pod ```bash orchard pod shell ``` | 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 ### `orchard project` Manage projects ```bash orchard project ``` Aliases: `projects`, `proj` ### `orchard project background` Manage the project background image ```bash orchard project background ``` ### `orchard project background set` Upload a background image for the scoped project (jpeg/png/webp, max 8MB) ```bash orchard project background set ``` ### `orchard project create` Create a project in the scoped organization ```bash 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` Delete a project and everything in it ```bash orchard project delete ``` Aliases: `rm` ### `orchard project get` Show a project ```bash orchard project get ``` ### `orchard project icon` Manage the project icon ```bash orchard project icon ``` ### `orchard project icon set` Upload a project icon (jpeg/png/gif/webp, max 2MB) ```bash orchard project icon set ``` ### `orchard project invitation` Manage pending invitations for the scoped project ```bash orchard project invitation ``` Aliases: `invitations`, `invite` ### `orchard project invitation revoke` Revoke a pending project invitation ```bash orchard project invitation revoke ``` ### `orchard project list` List projects (all organizations, or the scoped one) ```bash orchard project list ``` Aliases: `ls` ### `orchard project member` Manage members of the scoped project ```bash orchard project member ``` Aliases: `members` ### `orchard project member add` Add an organization member to the project (emails without an account get an invitation) ```bash orchard project member add ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--role` | string | `member` | project role: admin\|member\|viewer | ### `orchard project member list` List project members ```bash orchard project member list ``` Aliases: `ls` ### `orchard project member remove` Remove a member from the project ```bash orchard project member remove ``` Aliases: `rm` ### `orchard project member set-role` Change a member's project role (admin\|member\|viewer) ```bash orchard project member set-role ``` ### `orchard project registry` Manage credentials for pulling private images into the scoped project ```bash orchard project registry ``` Aliases: `registries`, `pull-secret` ### `orchard project registry list` List the registries this project can pull private images from ```bash orchard project registry list ``` Aliases: `ls` ### `orchard project registry remove` Remove a registry credential ```bash orchard project registry remove ``` Aliases: `rm`, `delete` ### `orchard project registry set` Add or replace the credential for a registry (ghcr.io, docker.io, registry.gitlab.com, ...) ```bash orchard project registry set ``` | 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` Pull live Kubernetes state for the project into Orchard ```bash orchard project sync ``` ### `orchard project transfer` Transfer ownership of a project to another member ```bash orchard project transfer ``` ### `orchard project transfer accept` Accept ownership of a project offered to you ```bash orchard project transfer accept ``` ### `orchard project transfer cancel` Withdraw the scoped project's pending ownership transfer ```bash orchard project transfer cancel ``` ### `orchard project transfer decline` Decline ownership of a project offered to you ```bash orchard project transfer decline ``` ### `orchard project transfer list` List ownership transfers waiting on you ```bash orchard project transfer list ``` Aliases: `ls` ### `orchard project transfer request` Ask another project member to take ownership of the scoped project ```bash orchard project transfer request ``` ### `orchard project update` Update project fields ```bash orchard project update ``` | 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) | ## quota ### `orchard quota` Inspect resource quotas and usage for the organization ```bash orchard quota ``` Aliases: `quotas` ### `orchard quota me` Show your own allowance, usage and remaining allowance in the organization ```bash orchard quota me ``` ### `orchard quota members` Show per-member allowances and usage (organization admins) ```bash orchard quota members ``` ### `orchard quota projects` Show per-project caps and usage (organization admins) ```bash orchard quota projects ``` ### `orchard quota show` Show organization-wide usage against its caps ```bash orchard quota show ``` ## sandbox ### `orchard sandbox` Manage Greenhouse cloud dev sandboxes ```bash orchard sandbox ``` Aliases: `sb` ### `orchard sandbox chat` Send a message to the claude agent in a sandbox ```bash orchard sandbox chat [message...] ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-m`, `--message` | string | | message to send (default: the remaining args, or stdin) | ### `orchard sandbox conversations` List and manage Cloud Code conversations in a sandbox ```bash orchard sandbox conversations ``` 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: = | ### `orchard sandbox create` Create a cloud dev sandbox ```bash 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` Manage agent tokens injected into your sandboxes ```bash orchard sandbox credentials ``` ### `orchard sandbox credentials clear` Remove stored sandbox agent tokens ```bash 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` Store agent tokens (claude code / openai) for your sandboxes ```bash 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` Show which sandbox agent tokens are configured (never the values) ```bash orchard sandbox credentials status ``` ### `orchard sandbox delete` Delete a sandbox and its home volume ```bash orchard sandbox delete ``` Aliases: `rm` ### `orchard sandbox diff` Show git changes inside the sandbox workspace ```bash orchard sandbox diff ``` | 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` Fork a machine you own into a new one with the same disk and sessions ```bash orchard sandbox fork ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--name` | string | | Name of the new machine (defaults to -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` Show a sandbox ```bash orchard sandbox get ``` ### `orchard sandbox link` Attach Orchard projects so their env vars land in the sandbox ```bash orchard sandbox link ``` Aliases: `links` ### `orchard sandbox link add` Attach a project environment to a sandbox (host only); --env picks the environment ```bash orchard sandbox link add ``` ### `orchard sandbox link list` List projects attached to a sandbox ```bash orchard sandbox link list ``` Aliases: `ls` ### `orchard sandbox link remove` Detach a project from a sandbox (host only) ```bash orchard sandbox link remove ``` Aliases: `rm` ### `orchard sandbox list` List your sandboxes ```bash orchard sandbox list ``` Aliases: `ls` ### `orchard sandbox repo` Manage git repositories inside a sandbox ```bash orchard sandbox repo ``` ### `orchard sandbox repo add` Clone another repository into a sandbox ```bash orchard sandbox repo add ``` ### `orchard sandbox repo icon` Set the icon a repository shows in Greenhouse ```bash orchard sandbox repo icon [icon] ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--clear` | bool | `false` | remove the icon | ### `orchard sandbox repo list` List repositories cloned into a sandbox ```bash orchard sandbox repo list ``` Aliases: `ls` ### `orchard sandbox retry` Retry a sandbox's failed Kubernetes or Vercel changes ```bash orchard sandbox retry ``` ### `orchard sandbox session` Manage worktree agent sessions inside a sandbox ```bash orchard sandbox session ``` Aliases: `sessions` ### `orchard sandbox session archive` Archive a session (removes the worktree, keeps the branch) ```bash orchard sandbox session archive ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--restore` | bool | `false` | Restore an archived session instead | ### `orchard sandbox session create` Start a session on a fresh git worktree (branch orchard/) ```bash orchard sandbox session create ``` | 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` List sessions with their branch, diffstat and PR ```bash orchard sandbox session list ``` Aliases: `ls` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--all` | bool | `false` | Include archived sessions | ### `orchard sandbox session preview` Deploy a session branch as a gh- preview environment (host only) ```bash orchard sandbox session preview ``` | 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` Send a prompt to a session's agent as yourself (reads stdin with - or no text) ```bash orchard sandbox session prompt [text|-] ``` ### `orchard sandbox session transcript` Print the latest messages of a session's agent chat ```bash orchard sandbox session transcript ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--limit` | int | `0` | How many of the latest messages to show (1-200, default 30) | ### `orchard sandbox share` Read-only share links for organization teammates (transcript and diff only) ```bash orchard sandbox share ``` ### `orchard sandbox share create` Create a share link (the token is shown once) ```bash orchard sandbox share create ``` | 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` List share links and whether they are active, expired or revoked ```bash orchard sandbox share list ``` Aliases: `ls` ### `orchard sandbox share revoke` Revoke a share link; viewers lose access on their next request ```bash orchard sandbox share revoke ``` ### `orchard sandbox ssh` SSH into a sandbox through the orchard tunnel ```bash orchard sandbox ssh [-- 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` Print ssh config Host blocks, or --install a wildcard orchard-* entry into ~/.ssh/config ```bash 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` Start a stopped sandbox ```bash orchard sandbox start ``` | 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` Stop a sandbox (its home volume is kept) ```bash orchard sandbox stop ``` | 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` Rename a sandbox or switch its ssh identity ```bash orchard sandbox update ``` | 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` Show a machine's CPU, memory, disk and time limits ```bash orchard sandbox usage ``` ## service ### `orchard service` Manage deployment services and ports ```bash orchard service ``` Aliases: `services`, `svc` ### `orchard service create` Create a service exposing a port on a deployment ```bash 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-) | | `--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` Delete a service from a deployment ```bash orchard service delete ``` Aliases: `rm` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-d`, `--deployment` | string | | deployment id | ### `orchard service exposure` Manage service exposure ```bash orchard service exposure ``` ### `orchard service exposure set` Switch a service between public and internal ```bash orchard service exposure set ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-d`, `--deployment` | string | | deployment id | ### `orchard service list` List services for a deployment ```bash orchard service list ``` Aliases: `ls` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-d`, `--deployment` | string | | deployment id | ### `orchard service port` Manage individual service ports ```bash orchard service port ``` ### `orchard service port public` Toggle public exposure of a single service port ```bash orchard service port public ``` ### `orchard service port public disable` Stop exposing a single service port publicly ```bash orchard service port public disable ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-d`, `--deployment` | string | | deployment id | ### `orchard service port public enable` Expose a single service port publicly ```bash orchard service port public enable ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `-d`, `--deployment` | string | | deployment id | ### `orchard service update` Update a service's ports or domain ```bash orchard service update ``` | 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 ### `orchard ssh-identity` Manage the ssh identities your Greenhouse sandboxes accept ```bash orchard ssh-identity ``` Aliases: `ssh-key`, `identity` ### `orchard ssh-identity add` Register an ssh public key as a named identity ```bash orchard ssh-identity add ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--key` | string | | ssh public key: literal, @file, or a file path | ### `orchard ssh-identity import-github` Import your public ssh keys from GitHub as identities ```bash orchard ssh-identity import-github ``` ### `orchard ssh-identity list` List your ssh identities ```bash orchard ssh-identity list ``` Aliases: `ls` ### `orchard ssh-identity remove` Delete an ssh identity ```bash orchard ssh-identity remove ``` Aliases: `rm` ## status-page ### `orchard status-page` Public status pages for an organization ```bash orchard status-page ``` Aliases: `status-pages`, `statuspage` ### `orchard status-page create` Create a page: --title 'Acme status' --slug acme --component deployment: ```bash orchard status-page create ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--component` | stringSlice | `[]` | deployment: or database:, 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: ' status') | ### `orchard status-page delete` Delete a page and its host ```bash orchard status-page delete ``` Aliases: `rm` ### `orchard status-page list` List the organization's status pages ```bash orchard status-page list ``` Aliases: `ls` ### `orchard status-page options` Apps and databases a page can list ```bash orchard status-page options ``` ### `orchard status-page show` Read a public status page the way a visitor does ```bash 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` Change a page's title, slug, host, visibility or components ```bash orchard status-page update ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--component` | stringSlice | `[]` | replace the components with deployment: or database: (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 ### `orchard tailscale` Expose deployments on your Tailscale network ```bash orchard tailscale ``` Aliases: `ts` ### `orchard tailscale expose` Expose a deployment on your tailnet through a proxy pod ```bash orchard tailscale expose ``` ### `orchard tailscale get` Show a deployment's Tailscale exposure ```bash orchard tailscale get ``` ### `orchard tailscale link` Link your Tailscale account with an auth key ```bash 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` Show whether a Tailscale account is linked ```bash orchard tailscale status ``` ### `orchard tailscale unexpose` Remove a deployment's Tailscale exposure ```bash orchard tailscale unexpose ``` ### `orchard tailscale unlink` Unlink your Tailscale account ```bash orchard tailscale unlink ``` ## template ### `orchard template` Deploy prebuilt app stacks from templates ```bash orchard template ``` Aliases: `templates`, `tpl` ### `orchard template admin create` Create a template from a YAML definition file ```bash orchard template admin create ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--file` | string | | path to the template YAML definition (required) | ### `orchard template admin delete` Delete a template (fails while instances of it exist) ```bash orchard template admin delete ``` Aliases: `rm` ### `orchard template admin update` Replace a template's YAML definition (built-ins can't be updated) ```bash orchard template admin update ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--file` | string | | path to the template YAML definition (required) | ### `orchard template deploy` Deploy a template into the current project ```bash orchard template deploy ``` | 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` Show a template with its parameters and resources ```bash orchard template get ``` ### `orchard template instance` Manage deployed template instances ```bash orchard template instance ``` Aliases: `instances` ### `orchard template instance delete` Delete a template instance and every resource it created ```bash orchard template instance delete ``` Aliases: `rm` ### `orchard template instance get` Show a template instance and the resources it created ```bash orchard template instance get ``` ### `orchard template instance list` List template instances in the current project ```bash orchard template instance list ``` Aliases: `ls` ### `orchard template list` List available templates ```bash orchard template list ``` Aliases: `ls` ## top ### `orchard top` Live pods, resources and traffic for one app, or one database with --db ```bash orchard top ``` | Flag | Type | Default | Description | | --- | --- | --- | --- | | `--db` | bool | `false` | the id is a database | | `--once` | bool | `false` | print one snapshot and exit | ## ui ### `orchard ui` Launch the interactive dashboard ```bash orchard ui ``` Aliases: `dash`, `tui` ## unlink ### `orchard unlink` Remove the directory link created by `orchard link` ```bash orchard unlink ``` ## up ### `orchard up` Deploy the current directory ```bash 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 | ## use ### `orchard use` Set the default org/project/env for future commands ```bash orchard use ``` ## user ### `orchard user` Manage your user profile ```bash orchard user ``` ### `orchard user avatar` Manage your avatar image ```bash orchard user avatar ``` ### `orchard user avatar delete` Remove your avatar ```bash orchard user avatar delete ``` Aliases: `rm` ### `orchard user avatar set` Upload an avatar image (jpeg/png/gif/webp, max 5MB) ```bash orchard user avatar set ``` ### `orchard user profile` Show your profile ```bash orchard user profile ``` ### `orchard user profile update` Update your profile (only flagged fields change) ```bash 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 ### `orchard version` Print the CLI version ```bash orchard version ``` ## webhook ### `orchard webhook` Trigger deploy webhooks ```bash orchard webhook ``` Aliases: `webhooks` ### `orchard webhook deploy` Trigger a deployment via a webhook token (no sign-in required) ```bash orchard webhook deploy ``` | 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) |