box/docs/claudebox-recipe.md
claude-hdb 0c9971ecf8 Import claudebox: creds-free, trust-less Claude Code VMs
A CLI that mints trust-less, network-isolated Incus VMs with Claude Code
installed. Boxes are strictly creds-free — the operator logs into Claude
interactively inside; authenticated state is reused via snapshots. The tool
knows nothing about projects; a repo ships an optional agent-facing .claudebox/
runbook that Claude reads.

- bin/claudebox: new/shell/exec/snapshot/restore/down/start/rm/status; creds-free
  'new' (fresh launch or clone via --from <src>[/<snap>]).
- cloud-init: global ~/.claude/CLAUDE.md self-describing the box + .claudebox/ runbook.
- install.sh: curl-pipe-bash installer.
- host/: Incus isolation stack (claudenet + claude-isolate ACL + claude-dev
  profile + firewall).
- docs/: design + .claudebox/ convention.

Initial canonical import (prototyped separately; re-homed onto the heavy-duty fork).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-10 15:00:36 +00:00

3.2 KiB

The .claudebox/ convention

claudebox mints trust-less, creds-free, isolated VMs with Claude Code already installed (claudebox new/shell/snapshot/restore/exec/down/start/rm/status). The tool knows nothing about your project. There is no install step and no host-run setup script.

A project makes itself easy to stand up inside a box by shipping an optional .claudebox/ folder. This folder is agent-facing documentation — read and acted on by Claude Code (the reasoning agent) running inside the box. It is not shell that the host executes.

What it is / what it is not

  • Optional. No .claudebox/ is a perfectly valid state.
  • Agent-facing. You are writing instructions to a reasoning agent, not a machine. Prose is fine; the agent adapts.
  • Not a host contract. The host never parses, sources, or runs anything in here. There is no enforced schema and no required filenames.
  • Old model: a host-executed .devbox/setup.sh. New model: a runbook the agent reads and decides how to act on.

How it's consumed

Every box ships a global ~/.claude/CLAUDE.md telling Claude it is inside a claudebox and to treat a repo's .claudebox/ folder as its bootstrap runbook. So the whole flow is:

claudebox new           # get a box
claudebox shell         # get in
git clone <repo> && cd <repo>
claude                  # Claude reads .claudebox/ and brings the project up

The operator can also just say: "set this project up per .claudebox".

Suggested contents (all optional)

Author everything here for a reasoning agent.

  • .claudebox/SETUP.md — the prose runbook. Prerequisites, how to install deps, how to start services, how to template the env, how to seed data, and how to smoke-test. Written as instructions to Claude.
  • Helper scripts (e.g. .claudebox/dev-up.sh) that the runbook tells Claude to run. Claude decides to run them; the host never does.
  • .claudebox/env.template — example env the runbook explains how to fill. Staging values the operator pastes in. Never commit real secrets.
  • .claudebox/compose.yml — optional services the runbook starts.

Worked example

A minimal .claudebox/SETUP.md for a Node + Postgres app:

# Setup

This is a Node service backed by Postgres.

1. Install deps: `npm ci`
2. Start Postgres: `docker compose -f .claudebox/compose.yml up -d`
3. Create the env file: copy `.claudebox/env.template` to `.env` and ask the
   operator to fill in `DATABASE_URL` and `API_KEY` (staging values).
4. Run migrations: `npm run migrate`
5. Start the app: `npm run dev`
6. Smoke-test: `curl -sf localhost:3000/health` should return `{"ok":true}`.

That's it — Claude reads it top to bottom and adapts if reality differs.

Guidance

  • Keep it declarative and resilient. State intent and steps; let the agent adapt when the repo has drifted. Don't hard-code brittle assumptions.
  • Never put real credentials in .claudebox/. Templates and staging placeholders only. The operator pastes real values at runtime.
  • No .claudebox/ is fine. The operator can stand the project up by hand, or let Claude infer the steps from the repo's README / CLAUDE.md.