avivk5498/the-claude-protocol

create-beads-orchestration

Bootstrap lean multi-agent orchestration with beads task tracking.

Voir la source

Mode d’emploi

  1. Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
  2. Consultez le document original pour les outils, identifiants et environnements requis.
  3. Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/avivk5498/the-claude-protocol --skill create-beads-orchestration

Avant de commencer

  • L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
  • Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Document Skill original

Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.

Create Beads Orchestration

Set up lightweight multi-agent orchestration with git-native task tracking for Claude Code.

What This Skill Does

This skill bootstraps a complete multi-agent workflow where:

  • Orchestrator (you) investigates issues, manages tasks, delegates implementation
  • Supervisors (specialized agents) execute fixes in isolated worktrees
  • Beads CLI tracks all work with git-native task management
  • Hooks enforce workflow discipline automatically

Each task gets its own worktree at .worktrees/bd-{BEAD_ID}/, keeping main clean and enabling parallel work.

Beads Kanban UI

The setup will auto-detect Beads Kanban UI and configure accordingly. If not found, you'll be offered to install it.


Step 0: Detect Setup State (ALWAYS RUN FIRST)

<detection-phase> Before doing anything else, detect if this is a fresh setup or a resume after restart.

Check for bootstrap artifacts:

bash
ls .claude/agents/scout.md 2>/dev/null && echo "BOOTSTRAP_COMPLETE" || echo "FRESH_SETUP"

If `BOOTSTRAP_COMPLETE`:

  • Bootstrap already ran in a previous session
  • Skip directly to Step 4: Run Discovery
  • Do NOT ask for project info or run bootstrap again

If `FRESH_SETUP`:

  • This is a new installation
  • Proceed to Step 1: Get Project Info

</detection-phase>


Workflow Overview

<mandatory-workflow>

StepActionWhen to Run
0Detect setup stateALWAYS (determines path)
1Get project info from userFresh setup only
2Run bootstrapFresh setup only
3STOP - Instruct user to restartFresh setup only
4Run discovery agentAfter restart OR if bootstrap already complete

The setup is NOT complete until Step 4 (discovery) has run. </mandatory-workflow>


Step 1: Get Project Info (Fresh Setup Only)

<critical-step1> YOU MUST GET PROJECT INFO AND DETECT/ASK ABOUT KANBAN UI BEFORE PROCEEDING TO STEP 2.

  1. Project directory: Where to install (default: current working directory)
  2. Project name: For agent templates (will auto-infer from package.json/pyproject.toml if not provided)
  3. Kanban UI: Auto-detect, or ask the user to install

</critical-step1>

1.1 Get Project Directory and Name

Ask the user or auto-detect from package.json/pyproject.toml.

1.2 Detect or Install Kanban UI

bash
which bead-kanban 2>/dev/null && echo "KANBAN_FOUND" || echo "KANBAN_NOT_FOUND"

If KANBAN_FOUND → Use --with-kanban-ui flag. Tell the user:

Detected Beads Kanban UI. Configuring worktree management via API.

If KANBAN_NOT_FOUND → Ask:

AskUserQuestion(
  questions=[
    {
      "question": "Beads Kanban UI not detected. It adds a visual kanban board with dependency graphs and API-driven worktree management. Install it?",
      "header": "Kanban UI",
      "options": [
        {"label": "Yes, install it (Recommended)", "description": "Runs: npm install -g beads-kanban-ui"},
        {"label": "Skip", "description": "Use git worktrees directly. You can install later."}
      ],
      "multiSelect": false
    }
  ]
)
  • If "Yes" → Run npm install -g beads-kanban-ui, then use --with-kanban-ui flag
  • If "Skip" → do NOT use --with-kanban-ui flag

Step 2: Run Bootstrap

bash
# With Kanban UI:
npx beads-orchestration@latest bootstrap \
  --project-name "{{PROJECT_NAME}}" \
  --project-dir "{{PROJECT_DIR}}" \
  --with-kanban-ui

# Without Kanban UI (git worktrees only):
npx beads-orchestration@latest bootstrap \
  --project-name "{{PROJECT_NAME}}" \
  --project-dir "{{PROJECT_DIR}}"

The bootstrap script will:

  1. Install beads CLI (via brew, npm, or go)
  2. Initialize .beads/ directory
  3. Copy agent templates to .claude/agents/
  4. Copy hooks to .claude/hooks/
  5. Configure .claude/settings.json
  6. Create CLAUDE.md with orchestrator instructions
  7. Update .gitignore

Verify bootstrap completed successfully before proceeding.


Step 3: STOP - User Must Restart

<critical> YOU MUST STOP HERE AND INSTRUCT THE USER TO RESTART CLAUDE CODE.

Tell the user:

Setup phase complete. You MUST restart Claude Code now. The new hooks and MCP configuration will only load after restart. After restarting: 1. Open this same project directory 2. Tell me "Continue orchestration setup" or run /create-beads-orchestration again 3. I will run the discovery agent to complete setup Do not skip this restart - the orchestration will not work without it.

DO NOT proceed to Step 4 in this session. The restart is mandatory. </critical>


Step 4: Run Discovery (After Restart OR Detection)

<post-restart> Run this step if:

  • Step 0 detected BOOTSTRAP_COMPLETE, OR
  • User returned after restart and said "continue setup" or ran /create-beads-orchestration again
  1. Verify bootstrap completed (check for .claude/agents/scout.md) - already done in Step 0
  2. Run the discovery agent:
python
Task(
    subagent_type="discovery",
    prompt="Detect tech stack and create supervisors for this project"
)

Discovery will:

  • Scan package.json, requirements.txt, Dockerfile, etc.
  • Fetch specialist agents from external directory
  • Inject beads workflow into each supervisor
  • Write supervisors to .claude/agents/
  1. After discovery completes, tell the user:
Orchestration setup complete! Created supervisors: [list what discovery created] You can now use the orchestration workflow: - Create tasks with bd create "Task name" -d "Description" - The orchestrator will delegate to appropriate supervisors - All work requires code review before completion

</post-restart>


What This Creates

  • Beads CLI for git-native task tracking (one bead = one worktree = one task)
  • Core agents: scout, detective, architect, scribe, code-reviewer (all run via Claude Task)
  • Discovery agent: Auto-detects tech stack and creates specialized supervisors
  • Hooks: Enforce orchestrator discipline, code review gates, concise responses
  • Worktree-per-task workflow: Isolated development in .worktrees/bd-{BEAD_ID}/

With `--with-kanban-ui`:

  • Worktrees created via API (localhost:3008) with git fallback
  • Requires Beads Kanban UI running

Without `--with-kanban-ui`:

  • Worktrees created via raw git commands

Epic Workflow (Cross-Domain Features)

For features requiring multiple supervisors (e.g., DB + API + Frontend), use the epic workflow:

When to Use Epics

Task TypeWorkflow
Single-domain (one supervisor)Standalone bead
Cross-domain (multiple supervisors)Epic with children

Epic Workflow Steps

  1. Create epic: bd create "Feature name" -d "Description" --type epic
  2. Create design doc (if needed): Dispatch architect to create .designs/{EPIC_ID}.md
  3. Link design: bd update {EPIC_ID} --design ".designs/{EPIC_ID}.md"
  4. Create children with dependencies:
bash
   bd create "DB schema" -d "..." --parent {EPIC_ID}              # BD-001.1
   bd create "API endpoints" -d "..." --parent {EPIC_ID} --deps BD-001.1  # BD-001.2
   bd create "Frontend" -d "..." --parent {EPIC_ID} --deps BD-001.2       # BD-001.3
  1. Dispatch sequentially: Use bd ready to find unblocked tasks (each child gets own worktree)
  2. User merges each PR: Wait for child's PR to merge before dispatching next
  3. Close epic: bd close {EPIC_ID} after all children merged

Design Docs

Design docs ensure consistency across epic children:

  • Schema definitions (exact column names, types)
  • API contracts (endpoints, request/response shapes)
  • Shared constants/enums
  • Data flow between layers

Key rule: Orchestrator dispatches architect to create design docs. Orchestrator never writes design docs directly.

Hooks Enforce Epic Workflow

  • enforce-sequential-dispatch.sh: Blocks dispatch if task has unresolved blockers
  • enforce-bead-for-supervisor.sh: Requires BEAD_ID for all supervisors
  • validate-completion.sh: Verifies worktree, push, bead status before supervisor completes

Requirements

  • beads CLI: Installed automatically by bootstrap (via brew, npm, or go)

More Information

See the full documentation: https://github.com/AvivK5498/The-Claude-Protocol

Tâches connexes