Skip to main content

Global flags

These flags are available on every command:
FlagTypeDefaultDescription
--configstring~/.zwrm/config.tomlCLI configuration file path
--api-urlstringhttps://zwrm.ioControl plane API URL
--verbose, -vboolfalseEnable verbose output

zwrm init

Initialize a new zwrm.toml configuration file.
zwrm init [--name <name>] [--dockerfile <path>] [--no-prompt]
FlagTypeDefaultDescription
--namestringcurrent directory nameApplication name
--dockerfilestringauto-detectedDockerfile path
--no-promptboolfalseUse defaults without prompting

zwrm deploy

Build and deploy the application. Guide →
zwrm deploy [--app <name>] [--context <dir>] [--force-build] [--replicas <n>]
FlagTypeDefaultDescription
--appstringfrom zwrm.tomlApplication name
--contextstring.Build context directory
--force-buildboolfalseBypass build cache
--replicasint1Number 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]
FlagTypeDefaultDescription
--appstringfrom zwrm.tomlApplication name
--app-idstringApplication UUID
--machinestringDestroy a specific machine (prefix match)
--allboolfalseAlso destroy the app
--force, -fboolfalseSkip confirmation

zwrm logs

View or stream VM console output. Guide →
zwrm logs [--app <name>] [--machine <id>] [--follow] [--lines <n>]
FlagTypeDefaultDescription
--appstringfrom zwrm.tomlApplication name
--app-idstringApplication UUID
--machinestringSpecific machine ID
--follow, -fboolfalseStream in real-time
--lines, -nint100Number of lines

zwrm ssh

SSH into a running VM. Guide →
zwrm ssh [machine-id] [--app <name>] [--direct] [--user <user>]
FlagTypeDefaultDescription
--appstringfrom zwrm.tomlApplication name
--app-idstringApplication UUID
--machinestringMachine ID (alternative to positional)
--directboolfalseDirect connection (host access only)
--userstringSSH user override

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>]
FlagTypeDefaultDescription
--sizeint1024Volume size in MB
--mountstring/dataMount point in the VM
--no-syncboolfalseDon’t update zwrm.toml

zwrm volumes list

zwrm volumes list [--app <name>]

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>]
FlagTypeDefaultDescription
--sizestringsmallPreset: small, medium, large
--databasestringpostgresInitial 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>]
FlagTypeDefaultDescription
--namestringName for the restored database (required)
--backupstringlatestSpecific backup ID
--pitrstringPoint-in-time recovery target (RFC 3339)
--sizestringsame as sourceSize preset override

zwrm postgres restore status

zwrm postgres restore status <restore-id>

zwrm postgres scale

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

zwrm auth

Manage authentication. Guide →

zwrm auth login

zwrm auth login [--token <token>]

zwrm auth logout

zwrm auth logout

zwrm auth whoami

zwrm auth whoami

zwrm auth token

zwrm auth token

zwrm agent

Manage coding agent VMs. Guide →
zwrm agent <type> [instance]
zwrm a <type> [instance]
FlagTypeDefaultDescription
--templatestringTemplate from registry
--sizestringVM size preset
--shellboolfalseStart plain bash
--cmdstringOverride startup command
--instancestringNamed instance

zwrm agent list

zwrm agent list

zwrm agent destroy

zwrm agent destroy <instance>

zwrm agent secrets

Manage agent instance secrets. Guide →

zwrm agent secrets set

zwrm agent secrets set <NAME>=<VALUE> [--instance <name>]
zwrm agent secrets set <NAME> <VALUE> [--instance <name>]

zwrm agent secrets list

zwrm agent secrets list [--instance <name>]

zwrm agent secrets unset

zwrm agent secrets unset <NAME> [--instance <name>]

zwrm agent secrets add

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

zwrm dashboard

Show monitoring dashboard URLs. Guide →
zwrm dashboard [--open]

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.