Skip to content

Command Line Tools

wheels deploy docs

Print embedded per-topic help. wheels deploy docs lists the available sections; wheels deploy docs <section> prints that section’s Markdown.

wheels deploy docs [<section>]
  • accessories — sidecar containers
  • builder — Docker image build config
  • env — environment variable handling
  • hooks.kamal/hooks/ scripts
  • proxykamal-proxy configuration
  • registry — image registry setup
  • servers — the servers: block shapes
  • ssh — SSH connection config

Output is plain Markdown straight from the binary’s bundled docs. Unknown section names throw DeployMainCli.UnknownDocsSection.

These embedded docs are a terser, hands-on companion to the web guides. For the full treatment, see Deployment & Operations.

illustrative — multiple commands
wheels deploy docs
wheels deploy docs proxy
wheels deploy docs ssh