CLI Reference

Global flags

These flags are available on every command:

Flag	Type	Default	Description
`--config`	string	`~/.zwrm/config.toml`	CLI configuration file path
`--api-url`	string	`https://zwrm.io`	Control plane API URL
`--org`	string	from config	Organization slug or ID (overrides env/config)
`--verbose`, `-v`	bool	`false`	Enable verbose output

`zwrm init`

Initialize a new zwrm.toml configuration file.

zwrm init [--name <name>] [--dockerfile <path>] [--no-prompt] [--no-workflow]

Flag	Type	Default	Description
`--name`	string	current directory name	Application name
`--dockerfile`	string	`Dockerfile`	Dockerfile path
`--no-prompt`	bool	`false`	Use defaults without prompting
`--no-workflow`	bool	`false`	Don’t create a GitHub Actions deploy workflow

`zwrm deploy`

Build and deploy the application. Guide →

zwrm deploy [--app <name>] [--context <dir>] [--force-build] [--replicas <n>]

Flag	Type	Default	Description
`--app`	string	from `zwrm.toml`	Application name
`--context`	string	`.`	Build context directory
`--force-build`	bool	`false`	Bypass build cache
`--replicas`	int	`1`	Number of VM instances

`zwrm status`

Show application and machine status. Guide →

zwrm status [--app <name>] [--app-id <uuid>]

`zwrm scale`

Scale to a target number of machines. Guide →

zwrm scale <count> [--app <name>] [--app-id <uuid>]

`zwrm destroy`

Destroy machines or the entire application. Guide →

zwrm destroy [--app <name>] [--machine <id>] [--all] [--force]

Flag	Type	Default	Description
`--app`	string	from `zwrm.toml`	Application name
`--app-id`	string	—	Application UUID
`--machine`	string	—	Destroy a specific machine (prefix match)
`--all`	bool	`false`	Also destroy the app
`--force`, `-f`	bool	`false`	Skip confirmation

`zwrm logs`

View or stream VM console output. Guide →

zwrm logs [--app <name>] [--machine <id>] [--follow] [--lines <n>]

Flag	Type	Default	Description
`--app`	string	from `zwrm.toml`	Application name
`--app-id`	string	—	Application UUID
`--machine`	string	—	Specific machine ID
`--follow`, `-f`	bool	`false`	Stream in real-time
`--lines`, `-n`	int	`100`	Number of lines

`zwrm ssh`

SSH into a running VM, or run a single command on it. Guide →

zwrm ssh [machine-id] [flags] [-- command [args...]]

Everything after -- runs on the VM instead of opening an interactive shell; the CLI exits with the remote command’s exit code.

Flag	Type	Default	Description
`--app`	string	from `zwrm.toml`	Application name
`--app-id`	string	—	Application UUID
`--machine`	string	—	Machine ID (alternative to positional)
`--command`, `-C`	string	—	Remote command (alternative to `-- command`)
`--direct`	bool	`false`	Direct connection (host access only)
`--tty`, `-t` / `--no-tty`, `-T`	bool	auto	Force / disable PTY allocation
`--user`	string	—	SSH user override

--machine also works for app-less machines (Postgres, sandboxes); those connect directly rather than through the proxy, whose usernames are {app}.{machine}.

zwrm ssh -- uptime
zwrm ssh --app myapp -- bash -lc 'cd /app && python3 task.py'
echo 'print(1)' | zwrm ssh -- python3 -

`zwrm sftp`

Transfer files to/from a running VM through the SSH proxy. Run without a subcommand for an interactive SFTP shell, or use one-shot subcommands:

zwrm sftp get <remote> <local>
zwrm sftp put <local> <remote>
zwrm sftp ls <remote-dir>

All forms accept --app, --app-id, --machine, and --user. Modern scp (OpenSSH ≥ 9.0) also works against the proxy directly.

`zwrm secrets`

Manage encrypted application secrets. Guide →

`zwrm secrets set`

zwrm secrets set <NAME> <VALUE>
zwrm secrets set <NAME>=<VALUE>

`zwrm secrets list`

zwrm secrets list [--app <name>]

`zwrm secrets unset`

zwrm secrets unset <NAME> [--app <name>]

`zwrm secrets add`

zwrm secrets add --from-file <path> [--app <name>]

All subcommands accept --app and --app-id.

`zwrm volumes`

Manage persistent volumes. Guide →

`zwrm volumes create`

zwrm volumes create <name> [--size <mb>] [--mount <path>] [--app <name>]

Flag	Type	Default	Description
`--size`	int	`1024`	Volume size in MB
`--mount`	string	`/data`	Mount point in the VM
`--host`	string	scheduler picks	Host to create the volume on
`--region`	string	—	Constrain placement to a region (ignored with `--host`)
`--no-sync`	bool	`false`	Don’t update zwrm.toml

`zwrm volumes list`

zwrm volumes list [--app <name>]

`zwrm volumes resize`

zwrm volumes resize <name> --size <mb> [--app <name>]

Grow-only: the new size must be larger than the current one.

`zwrm volumes destroy`

zwrm volumes destroy <name> [--force] [--no-sync]

`zwrm volumes limits`

zwrm volumes limits

`zwrm volumes snapshot`

Manage volume snapshots. Guide →

`zwrm volumes snapshot create`

zwrm volumes snapshot create <name> [--app <name>]

`zwrm volumes snapshot list`

zwrm volumes snapshot list <name> [--app <name>]

`zwrm volumes snapshot delete`

zwrm volumes snapshot delete <snapshot-id>

`zwrm volumes snapshot enable` / `disable`

zwrm volumes snapshot enable <name> [--app <name>]
zwrm volumes snapshot disable <name> [--app <name>]

`zwrm volumes restore`

zwrm volumes restore <name> [--app <name>] [--snapshot <id>]

All subcommands accept --app and --app-id.

`zwrm routes`

Manage custom hostname routes. Guide →

`zwrm routes list`

zwrm routes list [--app <name>]

`zwrm routes create`

zwrm routes create --hostname <host> [--port <n>] [--app <name>]

`zwrm routes delete`

zwrm routes delete <route-id> [--force] [--app <name>]

`zwrm postgres`

Manage PostgreSQL databases. Guide →

`zwrm postgres create`

zwrm postgres create <name> [--size <preset>] [--database <dbname>]

Flag	Type	Default	Description
`--size`	string	`small`	Preset: `small`, `medium`, `large`
`--database`	string	instance name	Initial database name

`zwrm postgres list`

zwrm postgres list

`zwrm postgres connect`

zwrm postgres connect <name>

`zwrm postgres destroy`

zwrm postgres destroy <name> [--force]

`zwrm postgres stop` / `start`

zwrm postgres stop <name>
zwrm postgres start <name>

`zwrm postgres presets`

zwrm postgres presets

`zwrm postgres backup`

Manage PostgreSQL backups. Guide →

`zwrm postgres backup enable` / `disable`

zwrm postgres backup enable <name>
zwrm postgres backup disable <name>

`zwrm postgres backup create`

zwrm postgres backup create <name> [--type <base|logical>]

`zwrm postgres backup list`

zwrm postgres backup list <name>

`zwrm postgres backup delete`

zwrm postgres backup delete <backup-id>

`zwrm postgres restore`

zwrm postgres restore <name> --name <new-name> [--backup <id>] [--pitr <timestamp>] [--size <preset>]

Flag	Type	Default	Description
`--name`	string	—	Name for the restored database (omit for in-place restore)
`--backup`	string	latest	Specific backup ID
`--pitr`	string	—	Point-in-time recovery target (RFC 3339)
`--size`	string	same as source	Size preset override

`zwrm postgres restore status`

zwrm postgres restore status <restore-id>

`zwrm postgres scale`

zwrm postgres scale <name> <count>

`zwrm postgres link` / `unlink`

zwrm postgres link <database-name> [--app <name>]
zwrm postgres unlink <database-name> [--app <name>]

`zwrm postgres links`

zwrm postgres links [--app <name>] [--database <name>]

`zwrm auth`

Manage authentication. Guide →

zwrm auth login [--token <token>]

--token is for headless/SSH environments.

`zwrm auth logout`

zwrm auth logout

`zwrm auth whoami`

zwrm auth whoami

`zwrm auth token`

Print the current session token.

zwrm auth token

`zwrm auth tokens`

Manage long-lived API tokens.

zwrm auth tokens create [--name <name>] [--expiry <duration>] [--scopes <list>] [--org <org>]
zwrm auth tokens list
zwrm auth tokens revoke <token-id>

Flag (`create`)	Type	Default	Description
`--name`	string	—	Token name (e.g. `github-actions`)
`--expiry`	string	no expiry	Expiry duration (e.g. `8760h` for one year)
`--scopes`	list	—	Capability set (comma-separated `resource:action`); empty = unrestricted
`--org`	string	target org	Organization a scoped token is bound to

zwrm auth tokens create --name ci --scopes apps:read,deploy --org acme --expiry 8760h

See Capabilities for the scope vocabulary.

`zwrm org`

Manage organizations and org-wide resources.

zwrm org create <name>
zwrm org list

`zwrm org secrets`

Organization-wide secrets, inherited by every app and agent. Guide →

zwrm org secrets set <NAME>=<VALUE>
zwrm org secrets list
zwrm org secrets unset <NAME>
zwrm org secrets add --from-file <path>

`zwrm transfer`

Move an app (with its secrets and agents) to another organization. Requires ownership of both orgs; linked Postgres databases must be unlinked first.

zwrm transfer --app <name> --to-org <org>

Flag	Type	Default	Description
`--app`	string	from `zwrm.toml`	App name (found across all your orgs)
`--app-id`	string	—	App ID (alternative to `--app`)
`--to-org`	string	—	Destination organization slug or ID

`zwrm sandbox`

Manage sandboxes. Guide →

zwrm sandbox create --template <name> [--size <preset>] [--timeout <dur>] [--persistent] [--idle-timeout <dur>] [--env KEY=VALUE ...] [--egress-mode allow_all|deny_all] [--egress-allow-cidr <cidr>] [--disk-size-mb <n>]
zwrm sandbox run --template <name> -- <command>   # create, run, destroy
zwrm sandbox exec <id> -- <command> [--timeout 30s] [--workdir <dir>]
zwrm sandbox list [--status running|creating|suspended|destroyed]
zwrm sandbox status <id>
zwrm sandbox upload <id> <local> <remote>
zwrm sandbox download <id> <remote> <local>
zwrm sandbox keepalive <id> [--timeout <dur>]
zwrm sandbox wake <id>
zwrm sandbox destroy <id> [-f]

See the Sandboxes guides for egress control, persistence, and template details.

`zwrm templates`

Manage agent and sandbox VM templates. Guide →

zwrm templates list
zwrm templates create <name> --dockerfile <path> [--description <text>] [--disk-size-mb <n>] [--env KEY=VALUE ...] [--egress-mode allow_all|deny_all]
zwrm templates rebuild <id>
zwrm templates update-quota <id> [--disk-size-mb <n>] [--ops-per-sec <n>] [--bandwidth-mbps <n>] [--clear-rate-limit]
zwrm templates delete <id> [-f]

`zwrm agent`

Manage agents. Guide → Connect interactively (creates the agent if the name is new):

zwrm agent <type> [instance]      # type: claude | codex
zwrm a <type> [instance]

Flag	Type	Default	Description
`--instance`	string	`default`	Named instance
`--size`	string	agent’s stored size	VM size preset
`--cmd`	string	—	Override default startup command
`--template`	string	—	Registry ID or `github.com/user/repo`

`zwrm agent run`

Start an autonomous run. Guide →

zwrm agent run --agent <name> --prompt <text> [--session <key>] [--model <m>] [--effort <e>] [--size <preset>] [--timeout <dur>]

`zwrm agent run status` / `list` / `cancel` / `continue`

zwrm agent run status <run-id>
zwrm agent run list [--status <status>]
zwrm agent run cancel <run-id>
zwrm agent run continue <run-id> --prompt <text> [--model <m>] [--effort <e>] [--size <preset>] [--timeout <dur>]

`zwrm agent list`

zwrm agent list

`zwrm agent destroy` / `delete`

zwrm agent destroy [instance]        # stop VM, keep volume
zwrm agent delete [instance] [-f]    # delete VM, volume, and record

`zwrm agent update`

Update agent configuration (only passed flags change).

zwrm agent update <instance> [--size <preset>] [--model opus|sonnet] [--effort <e>] [--instructions <text>] [--workspace-ttl <dur>] [--daily-budget <usd>] [--max-runs-per-day <n>] [--allowed-scopes <list>]

--allowed-scopes takes a comma-separated resource:action list; an empty value resets to the platform default. Guide →

`zwrm agent memory`

Curate an agent’s durable memory. Guide →

zwrm agent memory list <agent>
zwrm agent memory show <agent> <slug>
zwrm agent memory save <agent> <slug> --description <text> [--kind user|project|reference|feedback] [--body <md> | --file <path>]
zwrm agent memory delete <agent> <slug>

save reads the body from --body, --file, or stdin.

`zwrm agent budget`

Show or set daily caps. Guide →

zwrm agent budget [instance] [--daily-usd <n>] [--max-runs <n>]

`zwrm agent resize`

zwrm agent resize [instance] --volume <size>   # grow-only, agent must be stopped

`zwrm agent logs`

zwrm agent logs [instance] [--limit 50]

`zwrm agent messages`

Agent inbox. Guide →

zwrm agent messages list [--unreplied]
zwrm agent messages reply <message-id> --text <text>

`zwrm agent channels`

Message delivery channels. Guide →

zwrm agent channels list --agent <name>
zwrm agent channels add --agent <name> --type email|whatsapp|sms|sns --target <target> [--org-wide]
zwrm agent channels enable|disable|remove <channel-id> --agent <name>

`zwrm agent connectors`

Attach MCP gateway virtual servers. Guide →

zwrm agent connectors list <agent>
zwrm agent connectors attach <agent> <server> [--disabled] [--escalate]
zwrm agent connectors detach <agent> <server>
zwrm agent connectors verify <agent> <server>
zwrm agent connectors copy <agent> --from <source-agent>

`zwrm agent skills`

Per-agent skill enablement. Guide →

zwrm agent skills list <agent>
zwrm agent skills enable <agent> <skill>
zwrm agent skills disable <agent> <skill>

`zwrm agent secrets`

Manage agent secrets. Guide →

zwrm agent secrets set <NAME>=<VALUE> [--instance <name>]
zwrm agent secrets list [--instance <name>]
zwrm agent secrets unset <NAME> [--instance <name>]
zwrm agent secrets add --from-file <path> [--instance <name>]

`zwrm skills`

Manage the org skill library. Guide →

zwrm skills list
zwrm skills create <slug> [--name <name>] [--description <text>]
zwrm skills upload <skill> <bundle.zip>
zwrm skills delete <skill>

`zwrm mcp`

MCP gateway and local MCP server. Guide → zwrm mcp with no subcommand runs a stdio MCP server exposing your agent runs (get_agent_run, list_agent_runs, cancel_agent_run).

`zwrm mcp upstream`

zwrm mcp upstream add <name> <url> [--bearer-token <t>] [--header "Name: value"] [--oauth] [--oauth-client-id <id>] [--oauth-client-secret <s>] [--oauth-token-url <url>] [--oauth-scope <scopes>] [--oauth-issuer <url>] [--transport streamable-http|sse] [--allow-private]
zwrm mcp upstream list
zwrm mcp upstream tools <name>
zwrm mcp upstream sync <name>
zwrm mcp upstream grants <name>
zwrm mcp upstream rm <name> [--force]

The auth flags are mutually exclusive. Guide →

`zwrm mcp connect` / `disconnect`

Connect an account to a per-user OAuth upstream. Guide →

zwrm mcp connect <upstream> [--agent <id|instance>]
zwrm mcp disconnect <upstream> [--agent <id|instance>]

--agent authorizes that agent instead of yourself — the account you consent with becomes the agent’s identity on the upstream.

`zwrm mcp server`

zwrm mcp server create <name> --upstream "<name>[:tool1,tool2]" [--upstream ...] [--description <text>] [--bound-grant <upstream>=<type>:<id>]
zwrm mcp server list
zwrm mcp server get <name>
zwrm mcp server rm <name>

Flag	Description
`--bound-grant`	Pin one account for every caller: `<upstream>=<principal_type>:<principal_id>` (repeatable)

Without --bound-grant, each caller acts as their own connected account. Guide →

`zwrm mcp install`

zwrm mcp install <server> [--client claude-code|claude-api|cursor|vscode|windsurf|goose|openai|openapi|custom-gpt] [--all]

`zwrm triggers`

Inbound webhooks: external events → agent runs. Guide →

zwrm triggers list
zwrm triggers create <name> [--default-agent <a>] [--instruction <text>] [--message-template <tpl>] [--session-key-path <path>] [--match <json>] [--routes <json>] [--rate-per-day <n>] [--no-secret]
zwrm triggers deliveries <trigger-id> [--limit 50]
zwrm triggers pause|resume <trigger-id>
zwrm triggers delete <trigger-id>

`zwrm schedules`

Cron → agent runs. Guide →

zwrm schedules list [--agent <name>] [--metadata k=v]
zwrm schedules create <name> --agent <a> --cron "<expr>" --prompt <text> [--session-key <key>] [--metadata k=v] [--paused]
zwrm schedules firings <schedule-id> [--limit 50]
zwrm schedules pause|resume <schedule-id>
zwrm schedules delete <schedule-id>

`zwrm dashboard`

Show monitoring dashboard URLs. Guide →

zwrm dashboard [--open]

`zwrm host`

Manage cluster hosts (platform operators only).

zwrm host list
zwrm host show <host-id>
zwrm host drain <host-id>
zwrm host drain-status <host-id>
zwrm host undrain <host-id>
zwrm host activate <host-id>
zwrm host remove <host-id> [--force]

`zwrm admin`

Control plane administration (host-admin only).

zwrm admin backup                      # take a control plane backup
zwrm admin backups                     # list backups
zwrm admin backups delete <backup-id>

zwrm admin secrets rotate              # rotate the secrets master key
zwrm admin secrets rotation-status
zwrm admin secrets retire-version <version>
zwrm admin secrets escrow-init        # initialize key escrow
zwrm admin secrets migrate-to-kdf
zwrm admin secrets recover

ID prefix matching

Many commands accept machine, route, or database IDs. You don’t need to type the full UUID — just enough characters to uniquely identify the resource:

zwrm ssh abc1          # matches machine with ID starting with "abc1"
zwrm destroy --machine ab12
zwrm routes delete 7f3

If the prefix matches multiple resources, the command fails with an error listing the ambiguous matches.

​Global flags

​zwrm init

​zwrm deploy

​zwrm status

​zwrm scale

​zwrm destroy

​zwrm logs

​zwrm ssh

​zwrm sftp

​zwrm secrets

​zwrm secrets set

​zwrm secrets list

​zwrm secrets unset

​zwrm secrets add

​zwrm volumes

​zwrm volumes create

​zwrm volumes list

​zwrm volumes resize

​zwrm volumes destroy

​zwrm volumes limits

​zwrm volumes snapshot

​zwrm volumes snapshot create

​zwrm volumes snapshot list

​zwrm volumes snapshot delete

​zwrm volumes snapshot enable / disable

​zwrm volumes restore

​zwrm routes

​zwrm routes list

​zwrm routes create

​zwrm routes delete

​zwrm postgres

​zwrm postgres create

​zwrm postgres list

​zwrm postgres connect

​zwrm postgres destroy

​zwrm postgres stop / start

​zwrm postgres presets

​zwrm postgres backup

​zwrm postgres backup enable / disable

​zwrm postgres backup create

​zwrm postgres backup list

​zwrm postgres backup delete

​zwrm postgres restore

​zwrm postgres restore status

​zwrm postgres scale

​zwrm postgres link / unlink

​zwrm postgres links

​zwrm auth

​zwrm auth login

​zwrm auth logout

​zwrm auth whoami

​zwrm auth token

​zwrm auth tokens

​zwrm org

​zwrm org secrets

​zwrm transfer

​zwrm sandbox

​zwrm templates

​zwrm agent

​zwrm agent run

​zwrm agent run status / list / cancel / continue

​zwrm agent list

​zwrm agent destroy / delete

​zwrm agent update

​zwrm agent memory

​zwrm agent budget

​zwrm agent resize

​zwrm agent logs

​zwrm agent messages

​zwrm agent channels

​zwrm agent connectors

​zwrm agent skills

​zwrm agent secrets

​zwrm skills

​zwrm mcp

​zwrm mcp upstream

​zwrm mcp connect / disconnect

​zwrm mcp server

​zwrm mcp install

​zwrm triggers