Kamal

Kamal CLI

The Kamal CLI (`kamal`) is the primary command-line interface for packaging, shipping, and operating containerized web apps across one or more SSH-reachable servers. It reads `config/deploy.yml` (plus environment-specific overlays and encrypted secrets) and orchestrates the full lifecycle: building images, pushing to a registry, provisioning Docker on target hosts, starting accessory services, deploying the app via kamal-proxy with health-check gated traffic switching, and tailing logs or rolling back to a prior version. Command groups include `app`, `accessory`, `build`, `proxy`, `registry`, `secrets`, `server`, and `prune`, plus top-level shortcuts like `deploy`, `redeploy`, `rollback`, `setup`, `audit`, `details`, `env`, `lock`, `version`, and `init`.

Kamal CLI is one of 2 APIs that Kamal publishes on the APIs.io network.

Tagged areas include CLI, Deployment, Docker, Rails, and Ruby. The published artifact set on APIs.io includes API documentation, a getting-started guide, a GitHub repository, release notes, and SDKs.

GitHub

Documentation

📖
Documentation
https://kamal-deploy.org/docs/
📖
GettingStarted
https://kamal-deploy.org/docs/installation/

SDKs

📦
GitHubRepository
https://github.com/basecamp/kamal
📦
SDK
kamal (RubyGem)

Other Resources

🔗
Source
https://github.com/basecamp/kamal
🔗
License
https://github.com/basecamp/kamal/blob/main/MIT-LICENSE
🔗
ReleaseNotes
https://github.com/basecamp/kamal/releases
🔗
Configuration
deploy.yml Configuration Reference
🔗
Hooks
https://kamal-deploy.org/docs/hooks/
🔗
Upgrade
https://kamal-deploy.org/docs/upgrading/

API entry from apis.yml

apis.yml Raw ↑ 
aid: kamal-deploy:kamal
name: Kamal CLI
description: 'The Kamal CLI (`kamal`) is the primary command-line interface for packaging, shipping, and
  operating containerized web apps across one or more SSH-reachable servers. It reads `config/deploy.yml`
  (plus environment-specific overlays and encrypted secrets) and orchestrates the full lifecycle: building
  images, pushing to a registry, provisioning Docker on target hosts, starting accessory services, deploying
  the app via kamal-proxy with health-check gated traffic switching, and tailing logs or rolling back
  to a prior version. Command groups include `app`, `accessory`, `build`, `proxy`, `registry`, `secrets`,
  `server`, and `prune`, plus top-level shortcuts like `deploy`, `redeploy`, `rollback`, `setup`, `audit`,
  `details`, `env`, `lock`, `version`, and `init`.'
humanURL: https://kamal-deploy.org/docs/
tags:
- CLI
- Deployment
- Docker
- Rails
- Ruby
- SSH
properties:
- type: Documentation
  url: https://kamal-deploy.org/docs/
- type: GettingStarted
  url: https://kamal-deploy.org/docs/installation/
- type: Source
  url: https://github.com/basecamp/kamal
- type: GitHubRepository
  url: https://github.com/basecamp/kamal
- type: License
  url: https://github.com/basecamp/kamal/blob/main/MIT-LICENSE
- type: ReleaseNotes
  url: https://github.com/basecamp/kamal/releases
- type: Configuration
  url: https://kamal-deploy.org/docs/configuration/
  title: deploy.yml Configuration Reference
- type: Hooks
  url: https://kamal-deploy.org/docs/hooks/
- type: Upgrade
  url: https://kamal-deploy.org/docs/upgrading/
- type: SDK
  url: https://rubygems.org/gems/kamal
  title: kamal (RubyGem)