# Kamal CLI

**Canonical:** https://apis.io/apis/kamal-deploy/kamal/  
**Provider:** Kamal — https://apis.io/providers/kamal-deploy/  
**Documentation:** https://kamal-deploy.org/docs/

Kamal CLI is one of 2 APIs that [Kamal](https://apis.io/providers/kamal-deploy/) publishes on the [APIs.io](https://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, and release notes.

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`.

## Machine-readable artifacts (11)

- **Documentation** — https://kamal-deploy.org/docs/
- **GettingStarted** — https://kamal-deploy.org/docs/installation/
- **Source** — https://github.com/basecamp/kamal
- **GitHubRepository** — https://github.com/basecamp/kamal
- **License** — https://github.com/basecamp/kamal/blob/main/MIT-LICENSE
- **ReleaseNotes** — https://github.com/basecamp/kamal/releases
- **Configuration** — https://kamal-deploy.org/docs/configuration/
- **Hooks** — https://kamal-deploy.org/docs/hooks/
- **Upgrade** — https://kamal-deploy.org/docs/upgrading/
- **SDKs** — https://rubygems.org/gems/kamal
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/kamal-deploy/refs/heads/main/apis.yml

## Other Kamal APIs (1)

- [Kamal Proxy](https://apis.io/apis/kamal-deploy/kamal-proxy/)

## Tags

CLI, Deployment, Docker, Rails, Ruby, SSH

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/kamal-deploy/kamal/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/kamal-deploy/.