[](https://github.com/devantler-tech/ksail/stargazers) [](https://github.com/devantler-tech/ksail/releases/latest) [](https://polyformproject.org/licenses/shield/1.0.0) [](https://pkg.go.dev/github.com/devantler-tech/ksail/v7) [](https://github.com/devantler-tech/ksail/actions/workflows/ci.yaml) [](https://github.com/mcp) # 🛥️🐳 KSail  KSail bundles common Kubernetes tooling into a single binary. Spin up local clusters, deploy workloads, and operate cloud-native stacks across distributions and providers through a CLI, VS Code extension, AI chat TUI, or MCP server — with **only Docker or access to a Cloud Provider required**. 📖 **Full documentation:** ## Quick Install ```bash # macOS / Linux (Homebrew) brew install --cask devantler-tech/tap/ksail # Go (1.26.1+) go install github.com/devantler-tech/ksail/v7@latest ``` See the [Installation Guide](https://ksail.devantler.tech/installation/) for binary downloads and more options. ## AI Assistant Plugins Install the ksail plugin for [GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/copilot-cli) or [Claude Code](https://code.claude.com/docs/en/discover-plugins) to auto-register ksail's MCP server and a ksail expertise skill. **Copilot CLI:** ```bash copilot plugin marketplace add devantler-tech/ksail copilot plugin install ksail ``` **Claude Code:** ```text /plugin marketplace add devantler-tech/ksail /plugin install ksail@ksail ``` Requires `ksail` on `PATH`. ## Quick Start ```bash ksail project init --name my-app # scaffold project + native configs ksail cluster create # spin up the cluster (Docker only) ksail cluster connect # open K9s ``` Continue with the [Getting Started guide](https://ksail.devantler.tech/) for GitOps, workloads, and multi-tenancy. ## What KSail Bundles | Category | Built-in Capabilities | |--------------------------|----------------------------------------------------------------------| | Cluster Provisioning | Kind, K3d, Talos, VCluster (Vind), KWOK (kwokctl), EKS | | Container Orchestration | kubectl, Helm, Kustomize | | GitOps Engines | Flux, ArgoCD | | Secrets Management | SOPS with Age encryption | | Manifest Validation | Kubeconform | | Cluster Operations | K9s, backup & restore, multi-tenancy (`ksail tenant`) | | AI Integration | Chat assistant (Copilot SDK), MCP server, VS Code extension | | Infrastructure Providers | Docker (local), Kubernetes (nested), Hetzner Cloud, Sidero Omni, AWS | See the [feature overview](https://ksail.devantler.tech/features/) and [architecture guide](https://ksail.devantler.tech/architecture/) for details. ## Supported Platforms | OS | Architecture | |-----------------------------------------------|--------------| | 🐧 Linux | amd64, arm64 | | 🍎 macOS | arm64 | | ⊞ Windows (native untested; WSL2 recommended) | amd64, arm64 | | Provider | Vanilla | K3s | Talos | VCluster | KWOK | EKS | |------------|----------|---------|-------|----------|-------------|-----| | Docker | ✅ (Kind) | ✅ (K3d) | ✅ | ✅ (Vind) | ✅ (kwokctl) | — | | Kubernetes | ✅ | ✅ | ✅ | ✅ | ✅ | — | | Hetzner | — | — | ✅ | — | — | — | | Omni | — | — | ✅ | — | — | — | | AWS | — | — | — | — | — | 🚧 | ## Community & Support - 💬 **[GitHub Discussions](https://github.com/devantler-tech/ksail/discussions)** — questions, ideas, and community - 🐛 **[Issue Tracker](https://github.com/devantler-tech/ksail/issues)** — bugs and feature requests - 📖 **[Documentation](https://ksail.devantler.tech)** — guides, CLI reference, architecture - 🎓 **[Resources](https://ksail.devantler.tech/resources/)** — presentations, blog posts, tutorials - ⭐ **[Star the repo](https://github.com/devantler-tech/ksail)** — help others discover KSail ## Contributing Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for the development process, coding standards, and PR guidelines. Start with issues labeled [`good first issue`](https://github.com/devantler-tech/ksail/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). ## Related Projects | Project | Description | Type | |-----------------------------------------------------------------------|-----------------------------------------------|----------| | [devantler-tech/platform](https://github.com/devantler-tech/platform) | The maintainer's personal kubernetes platform | Platform | Using KSail in your project? Open a PR to add it here. ## License KSail is licensed under the **[PolyForm Shield License 1.0.0](LICENSE)**. You may use, modify, and distribute KSail for any purpose — except providing a product that competes with KSail. When redistributing, you must include the [license terms](LICENSE) and the required copyright notice. **What this means in practice:** - ✅ Use KSail as a CLI tool in any project (open-source or proprietary) - ✅ Embed or link KSail as a library in your own software - ✅ Fork and modify KSail for internal or non-competing use - ✅ Use any license for your own project — no copyleft requirement - ❌ Build and distribute a product that competes with KSail For the full license text including notice and non-compete details, see [LICENSE](LICENSE). For common questions, see the [Licensing FAQ](https://ksail.devantler.tech/faq/#licensing). ## Star History