KSail README
The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the KSail listing page.
🛥️🐳 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: https://ksail.devantler.tech
Quick Install
See the Installation Guide for binary downloads and more options.
AI Assistant Plugins
Install the ksail plugin for GitHub Copilot CLI or Claude Code to auto-register ksail's MCP server and a ksail expertise skill.
Copilot CLI:
Claude Code:
Requires ksail on PATH.
Quick Start
Continue with the Getting Started guide 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 and architecture guide 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 — questions, ideas, and community
- 🐛 Issue Tracker — bugs and feature requests
- 📖 Documentation — guides, CLI reference, architecture
- 🎓 Resources — presentations, blog posts, tutorials
- ⭐ Star the repo — help others discover KSail
Contributing
Contributions are welcome! See CONTRIBUTING.md for the development process, coding standards, and PR guidelines. Start with issues labeled good first issue.
Related Projects
| Project | Description | Type |
|---|---|---|
| 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. 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 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. For common questions, see the Licensing FAQ.