wheels deploy

wheels deploy is the Kamal-compatible deploy orchestrator built into the Wheels CLI. Every verb runs locally on the control machine — there is no agent on the target hosts. Commands fan out over SSH, stream prefixed output back, and honor --dry-run uniformly.

For the end-to-end walk, start at Your First Deploy. For the configuration schema, see deploy.yml Reference. This page is the dry verb index.

Top-level verbs

Verb	Purpose
wheels deploy	Rolling zero-downtime deploy. The everyday verb.
wheels deploy setup	First-run deploy — includes proxy and accessory boot.
wheels deploy redeploy	Re-run the deploy flow without version bump.
wheels deploy rollback	Route traffic back to a previous version.
wheels deploy config	Print the resolved deploy.yml config.
wheels deploy init	Stamp out deploy.yml and .kamal/secrets.
wheels deploy version	Show the mirrored Kamal and kamal-proxy versions.
wheels deploy audit	Tail the on-host audit log.
wheels deploy details	Aggregate app + proxy + accessory state.
wheels deploy docs	Print embedded per-topic help.
wheels deploy remove	Destructive teardown. Requires --confirm.

Subcommand groups

wheels deploy app App container lifecycle: boot, start, stop, logs, containers, images, live, maintenance, remove.

wheels deploy proxy kamal-proxy singleton lifecycle: boot, reboot, start, stop, restart, details, logs, remove.

wheels deploy accessory Sidecar container lifecycle — mirrors app verbs, scoped to a named accessory.

wheels deploy build Docker image lifecycle: deliver, push, pull, create, remove, details, dev.

wheels deploy registry Registry authentication: setup, login, logout, remove.

wheels deploy server Host-level operations. Nested verbs are picocli-shadowed — use the flat aliases: wheels deploy bootstrap and wheels deploy exec.

wheels deploy prune Cleanup: all, images, containers.

wheels deploy lock Deploy-lock management: acquire, release, status.

wheels deploy secrets Secret-store integration. Nested verbs are picocli-shadowed — use the flat aliases: wheels deploy fetch-secrets, extract-secrets, print-secrets.

Global flags

Every wheels deploy verb accepts these:

Flag	Description
--config=<path>	Path to deploy.yml. Default config/deploy.yml. --configPath=<path> is an accepted alias.
--destination=<name>	Overlay deploy.<name>.yml and .kamal/secrets.<name>.
--dry-run	Print the commands that would run, prefixed by host. No network.
--release=<v>	Version label (default: git rev-parse --short HEAD).