View all commands

You can view all of the commands by running kamal --help.

$ kamal --help
Commands:
  kamal accessory           # Manage accessories (db/redis/search)
  kamal app                 # Manage application
  kamal audit               # Show audit log from servers
  kamal build               # Build application image
  kamal config              # Show combined config (including secrets!)
  kamal deploy              # Deploy app to servers
  kamal details             # Show details about all containers
  kamal docs [SECTION]      # Show Kamal configuration documentation
  kamal help [COMMAND]      # Describe available commands or one specific command
  kamal init                # Create config stub in config/deploy.yml and secrets stub in .kamal
  kamal lock                # Manage the deploy lock
  kamal proxy               # Manage kamal-proxy
  kamal prune               # Prune old application images and containers
  kamal redeploy            # Deploy app to servers without bootstrapping servers, starting kamal-proxy and pruning
  kamal registry            # Login and -out of the image registry
  kamal remove              # Remove kamal-proxy, app, accessories, and registry session from servers
  kamal rollback [VERSION]  # Rollback app to VERSION
  kamal secrets             # Helpers for extracting secrets
  kamal server              # Bootstrap servers with curl and Docker
  kamal setup               # Setup all accessories, push the env, and deploy app to servers
  kamal upgrade             # Upgrade from Kamal 1.x to 2.0
  kamal version             # Show Kamal version

Options:
  -v, [--verbose], [--no-verbose], [--skip-verbose]        # Detailed logging
  -q, [--quiet], [--no-quiet], [--skip-quiet]              # Minimal logging
      [--version=VERSION]                                  # Run commands against a specific app version
  -p, [--primary], [--no-primary], [--skip-primary]        # Run commands only on primary host instead of all
  -h, [--hosts=HOSTS]                                      # Run commands on these hosts instead of all (separate by comma, supports wildcards with *)
  -r, [--roles=ROLES]                                      # Run commands on these roles instead of all (separate by comma, supports wildcards with *)
  -c, [--config-file=CONFIG_FILE]                          # Path to config file
                                                           # Default: config/deploy.yml
  -d, [--destination=DESTINATION]                          # Specify destination to be used for config file (staging -> deploy.staging.yml)
  -H, [--skip-hooks]                                       # Don't run hooks
                                                           # Default: false
      [--lock-wait], [--no-lock-wait], [--skip-lock-wait]  # Wait for the deploy lock if it's already held instead of failing immediately
                                                           # Default: false
      [--lock-wait-timeout=N]                              # Maximum seconds to wait for the deploy lock when --lock-wait is set
                                                           # Default: 900
      [--lock-wait-interval=N]                             # Seconds between deploy lock polls when --lock-wait is set
                                                           # Default: 15