Quickstart
Zero to a running app — publicly accessible on the internet — in 5 minutes.
Install
brew install kindling-sh/tap/kindling
This installs kindling, kind, and kubectl automatically. That's it — one command, all dependencies handled.
Bootstrap
kindling init
Creates a local Kubernetes cluster with an in-cluster container registry, ingress controller, and the kindling operator — all in one shot.
Connect a GitHub repo
You need a GitHub Personal Access Token with the repo scope.
kindling runners -u <github-user> -r <owner/repo> -t <pat>
This registers a self-hosted GitHub Actions runner in your cluster, bound to your repo.
Generate a workflow
kindling generate -k <openai-api-key> -r /path/to/your-app
Scans your repo — Dockerfiles, docker-compose, Helm charts, source code — and writes a complete .github/workflows/dev-deploy.yml using AI.
Works with OpenAI (default) or Anthropic (--provider anthropic). Your app needs a working Dockerfile.
Push and deploy
cd /path/to/your-app
git add -A && git commit -m "add kindling workflow" && git push
Your laptop builds the image, deploys it with auto-provisioned dependencies (Postgres, Redis, etc.), and wires up ingress — all locally.
Access your app
curl http://<your-user>-<your-app>.localhost
Want a public URL?
kindling expose
Instantly creates an HTTPS tunnel. Share the URL with anyone.
What just happened?
brew install → kindling init → kindling runners → kindling generate → git push → app running
↓ ↓ ↓ ↓ ↓ ↓
CLI + deps K8s cluster GH Actions runner AI workflow Local build localhost + tunnel
Every subsequent git push rebuilds and redeploys automatically. No cloud CI minutes. No Docker Hub. No YAML to write.
Next steps
| Want to... | Guide |
|---|---|
| Manage API keys and secrets | Secrets Management |
| Set up OAuth callbacks | OAuth & Tunnels |
| Deploy without GitHub Actions | Manual Deploy |
| See all 15 dependency types | Dependency Reference |
| Understand the internals | Architecture |