Documentation (main)
Docs from the main branch (may include unreleased features).
These pages track git main and may describe unreleased features. Prefer the latest release unless you are developing grain itself.
| Want… | Go here |
|---|---|
| Desktop GUI | Grain Desktop — sandboxes, recipes, warm pool, activity, multi-Run |
| Recipe library | Sandbox recipes — ~/.grain/recipes, official catalog, deploy |
| Fast creates | Lifecycle / warm pool — --from, --from-pool, suspend |
| Firecracker | Firecracker on Linux · Hypervisor matrix |
| First shell | Quick start · First sandbox |
| act / k3s | act · k3s |
| MCP agents | MCP overview |
- Developer — Maintainer notes — cutting releases, versioning, and packaging.
- Explain — Design notes — architecture, agent vs SSH, readiness, security, and hypervisor parity.
- Get started — Install grain, open a first sandbox, recipes, or jump to Desktop / Firecracker.
- Guides (how-tos by job) — Problem-oriented how-tos for everyday use and operating grain in production-like setups.
- MCP server (coding agents) — Connect Claude Code, Cursor, Codex, Grok Build, and other MCP hosts to grain sandboxes.
- Reference (CLI, API, SDKs, config) — CLI, daemon HTTP API, OpenAPI, SDKs, config keys, metrics, and agent protocol.