Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt

Use this file to discover all available pages before exploring further.

Skills are reusable workflows an AI coding agent can invoke by name. boxd ships four of them: one for everyday CLI usage and three for “wire-it-up-once” automation (deploy, golden VM, agent-driven fix-on-issue). The agent reads a short instruction file, runs the steps, and asks you to confirm before making any changes.
Currently only Claude Code is supported. The skills install at ~/.claude/skills/ and use Claude Code’s skill format. If you’d like the same workflows packaged for another agent (Codex, Cursor, OpenCode, …), reach out and we’ll prioritize.

​
What you get

SkillSlash commandWhat it does
boxd-cli(used implicitly)Teaches the agent how to drive the external boxd CLI: create/fork/destroy machines, run commands inside them, manage proxies, mint API keys. Loaded automatically whenever the agent is asked about boxd.
boxd-setup-deploy/boxd-setup-deployWires up GitHub Actions to deploy a repo to an existing boxd VM on every push to the default branch. One reviewable PR, no manual YAML editing.
boxd-setup-golden/boxd-setup-goldenProvisions a long-running “golden” boxd VM with your app installed and running. The golden becomes a fork source for per-issue agents, ephemeral previews, or any workflow that needs a warm copy of your app to fork from.
boxd-setup-fix-on-issue/boxd-setup-fix-on-issueThe full agent loop. Label any issue boxd-fix and GitHub Actions forks the golden, runs the agent inside the fork to fix it, opens a PR with a live preview URL, and destroys the fork on PR close. Calls boxd-setup-golden underneath when you don’t have a golden yet.

​
Install

All four skills ship with the external boxd CLI. The same installer drops both the binary and the skills: 
curl -fsSL https://boxd.sh/downloads/cli/install.sh | sh
What lands on disk:
  • boxd-cli skill → ~/.claude/skills/boxd-cli/SKILL.md
  • boxd-setup-{golden,deploy,fix-on-issue} skills → ~/.claude/skills/boxd-setup-*/ (each with its own SKILL.md plus an assets/ directory of workflow templates)
Re-run the installer any time to upgrade — it pulls the latest version of all four skills along with the CLI binary. The binary upgrade is idempotent, so this works even if only the skills changed.

​
Using a setup skill

Open your agent inside the repo you want to wire up, then invoke the slash command: 
/boxd-setup-deploy
/boxd-setup-golden
/boxd-setup-fix-on-issue
Each skill probes the repo’s existing state — secrets, labels, VMs — confirms a one-line plan with you, and only then makes changes. All file edits land in a reviewable PR; nothing is pushed straight to main.

​
What boxd-setup-fix-on-issue produces

After the skill’s setup PR is merged, your repo runs an end-to-end agent loop on every labeled issue: 
issue labeled boxd-fix → fork golden VM → claude runs inside the fork → PR + live preview
                                                                            ↓
                                                                   reviewer merges
                                                                            ↓
                                                                   fork destroyed on PR close
Live updates land on the issue comment as the agent works (📖 reading LoginPage.vue → ✏️ editing → 🌐 loading the preview → 📸 capturing the screenshot). The PR opens with a before/after visual diff and a clickable preview URL on *.boxd.sh. Required repo secrets (the skill walks you through both during setup):
SecretHow to mint
BOXD_API_KEYboxd keys create "fix-on-issue <owner>/<repo>" and pipe straight into gh secret set
CLAUDE_CODE_OAUTH_TOKENclaude setup-token on your laptop (one-year token, billed against your Pro/Max/Team/Enterprise subscription)
The PR is opened by your user account using a gh-CLI token persisted on the golden — no GitHub-Actions org-level “Allow Actions to create PRs” toggle needed.

​
Manual install (if you prefer)

If you don’t want to run the CLI installer, fetch just the skills: 
mkdir -p ~/.claude/skills/boxd-cli
curl -fsSL https://boxd.sh/downloads/cli/skill.md -o ~/.claude/skills/boxd-cli/SKILL.md
curl -fsSL https://boxd.sh/downloads/cli/skills.tar.gz | tar -xz -C ~/.claude/skills
Restart Claude Code (or run /skills to refresh) and the four skills appear with autocomplete on /boxd-setup-….