### Development setup Source: https://github.com/jordanhindo/beadboard/blob/main/CONTRIBUTING.md Steps to clone the repository, install dependencies, and start the development server. ```bash git clone https://github.com/zenchantlive/beadboard.git cd beadboard npm install npm run dev # http://localhost:3000 ``` -------------------------------- ### Step 2: Run tests to verify fail (Task 7) Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Commands to run installer CI contract and quickstart contract tests to verify failures. ```bash node --import tsx --test tests/scripts/installer-ci-contract.test.ts node --import tsx --test tests/docs/installer-quickstart-contract.test.ts ``` -------------------------------- ### bd help command Source: https://github.com/jordanhindo/beadboard/blob/main/help/cli/bd_help.txt Example of how to get help for a specific command. ```bash bd [command] --help ``` -------------------------------- ### Quick Start - Initialize Beads and Start Dashboard Source: https://github.com/jordanhindo/beadboard/blob/main/README.md Initializes Beads in a project and starts the BeadBoard dashboard with Dolt support. ```bash cd ~/my-project bd init # initialize Beads in your project beadboard start --dolt # start the dashboard with Dolt (recommended) ``` -------------------------------- ### Install from Source Source: https://github.com/jordanhindo/beadboard/blob/main/README.md Clones the repository, installs dependencies, and installs the BeadBoard CLI globally. ```bash git clone https://github.com/zenchantlive/beadboard.git cd beadboard npm install npm install -g . ``` -------------------------------- ### `bd mail` Delegate Setup Example Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/references/coordination-system.md Configuration command to set `bd mail` to delegate to the BeadBoard driver shim. ```bash bd config set mail.delegate "node /skills/beadboard-driver/scripts/bb-mail-shim.mjs" ``` -------------------------------- ### Step 2: Run targeted installer acceptance checks (Task 8) Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Commands to run specific installer acceptance checks. ```bash node --import tsx --test tests/lib/runtime-manager.test.ts node --import tsx --test tests/scripts/beadboard-launcher-runtime.test.ts node --import tsx --test tests/scripts/install-legacy-migration.test.ts node --import tsx --test tests/skills/beadboard-driver/resolve-bb.test.ts ``` -------------------------------- ### Query Syntax Examples Source: https://github.com/jordanhindo/beadboard/blob/main/help/cli/bd-query-help.txt Examples demonstrating the usage of the bd query command with various filters and operators. ```bash bd query "status=open AND priority>1" ``` ```bash bd query "status=open AND priority<=2 AND updated>7d" ``` ```bash bd query "(status=open OR status=blocked) AND priority<2" ``` ```bash bd query "type=bug AND label=urgent" ``` ```bash bd query "NOT status=closed" ``` ```bash bd query "assignee=none AND type=task" ``` ```bash bd query "created>30d AND status!=closed" ``` ```bash bd query "label=frontend OR label=backend" ``` ```bash bd query "title=authentication AND priority=0" ``` -------------------------------- ### Command Examples Source: https://github.com/jordanhindo/beadboard/blob/main/help/cli/state-help.txt Examples demonstrating how to use the 'bd set-state' command to change the operational state of an issue. ```bash bd set-state witness-abc patrol=muted --reason "Investigating stuck polecat" ``` ```bash bd set-state witness-abc mode=degraded --reason "High error rate detected" ``` ```bash bd set-state witness-abc health=healthy ``` -------------------------------- ### Example Swarm Creation Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/references/archetypes-templates-swarms.md Example of creating a swarm for a specific epic with a coordinator. ```bash bd swarm create beadboard-maf --coordinator beadboard/witness ``` -------------------------------- ### 4. Check Ready Status Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/references/creating-beads.md Example command to check the status of beads, showing which ones are ready to start and which are blocked. ```bash $ bd ready beadboard-pmt.1 [task] pmt.1: Stripe account setup ``` -------------------------------- ### Primary Install Flow Source: https://github.com/jordanhindo/beadboard/blob/main/docs/adr/2026-03-03-runtime-manager-global-install.md The recommended installation method using npm global. ```bash npm i -g beadboard ``` -------------------------------- ### Agent State Management Examples Source: https://github.com/jordanhindo/beadboard/blob/main/help/cli/agent-help.txt Examples demonstrating how to set and query agent states using the 'bd agent state' and 'bd agent heartbeat' commands. ```bash bd agent state gt-emma running ``` ```bash bd agent heartbeat gt-emma ``` ```bash bd agent show gt-emma ``` -------------------------------- ### Agent Quick Start Commands Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-02-28-ux-redesign-synthesis-prd.md Commands to get started with Phase 0 tasks in BeadBoard. ```bash bd ready # shows available Phase 0 tasks — start here bd show # read the full task before claiming it ``` -------------------------------- ### Quick Start - Create a Task Source: https://github.com/jordanhindo/beadboard/blob/main/README.md Creates a new task using the Beads CLI. ```bash bd create --title "My first task" --type task --priority 0 ``` -------------------------------- ### Task 4: Run wrapper tests Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Commands to execute all relevant tests for the installer wrappers after implementation. ```bash node --import tsx --test tests/scripts/install-wrappers-contract.test.ts node --import tsx --test tests/scripts/install-sh-smoke.test.ts node --import tsx --test tests/scripts/install-legacy-migration.test.ts ``` -------------------------------- ### Operator Install Paths Source: https://github.com/jordanhindo/beadboard/blob/main/docs/ops/global-install-rollout.md Commands to install beadboard globally or via fallback scripts. ```bash npm i -g beadboard ``` ```bash bash ./install/install.sh ``` ```powershell powershell -ExecutionPolicy Bypass -File .\install\install.ps1 ``` -------------------------------- ### Install BeadBoard Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/SKILL.md Clones the BeadBoard repository, installs its dependencies, and installs it globally. ```bash git clone https://github.com/zenchantlive/beadboard.git ~/beadboard cd ~/beadboard && npm install && npm install -g . ``` -------------------------------- ### Examples of 'bd dolt set' and 'bd dolt test' Source: https://github.com/jordanhindo/beadboard/blob/main/help/cli/bd-dolt-help.txt Illustrative examples of using 'bd dolt set' to configure settings and 'bd dolt test' to check connection. ```bash bd dolt set database myproject bd dolt set host 192.168.1.100 --update-config bd dolt set data-dir /home/user/.beads-dolt/myproject bd dolt test ``` -------------------------------- ### Example Description Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/references/creating-beads.md Example of creating a task bead with a detailed description including Scope, Out of Scope, and Success Criteria. ```bash bd create --title="xyz.2: API endpoint" --description="Scope: - POST /api/login endpoint - JWT token generation - Rate limiting (5 req/min) Out of Scope: - OAuth providers (in xyz.3) - Password reset flow Success Criteria: 1. Endpoint returns 200 with valid JWT 2. Returns 401 for invalid credentials 3. Rate limit enforced" --type=task --priority=2 --parent=beadboard-xyz ``` -------------------------------- ### Commit Example for Template Tool Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-07-phase-3-agent-orchestration.md Example of committing changes related to adding the template spawning tool. ```bash git add src/tui/tools/bb-spawn-template.ts src/lib/pi-daemon-adapter.ts git commit -m "feat: add template spawning tool" ``` -------------------------------- ### Worked HANDOFF Flow Example Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/references/coordination-system.md End-to-end example of sending a HANDOFF message, checking inbox, reading, and acknowledging. ```bash bb agent send \ --from silver-scribe \ --to graph-scout \ --bead beadboard-izs.4 \ --category HANDOFF \ --subject "Social badges complete" \ --body "Please validate edge cases and close" ``` ```bash bb agent inbox --agent graph-scout --state unread ``` ```bash bb agent read --agent graph-scout --message ``` ```bash bb agent ack --agent graph-scout --message ``` -------------------------------- ### POSIX Install Script Source: https://github.com/jordanhindo/beadboard/blob/main/README.md Alternative installation method for Linux/macOS using a provided script. ```bash bash ./install/install.sh # installs bb + beadboard shims to ~/.beadboard/bin ``` -------------------------------- ### Commit Example Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-07-phase-3-agent-orchestration.md Example of committing changes related to the orchestrator prompt. ```bash git add src/tui/system-prompt.ts git commit -m "feat: update orchestrator prompt for agent-based thinking" ``` -------------------------------- ### Install beads-cli Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/SKILL.md Installs the beads-cli package globally using npm. ```bash npm install -g beads-cli ``` -------------------------------- ### Verify CLI Installation Source: https://github.com/jordanhindo/beadboard/blob/main/README.md Verifies the installation of the BeadBoard CLI and the Beads CLI. ```bash beadboard --version bd --version ``` -------------------------------- ### Claim and track implementation bead(s) Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Commands to create and update an implementation bead for the global installer runtime manager. ```bash cd beadboard bd create --title="Global installer runtime manager implementation" --description="Implement npm-global-first runtime manager with migration from repo-path shims" --type=task --priority=1 --label="installation,cli,runtime" bd update --status in_progress --assignee ``` -------------------------------- ### Install Dolt using script Source: https://github.com/jordanhindo/beadboard/blob/main/CONTRIBUTING.md Alternative command to install Dolt using a curl script. ```bash curl -L https://github.com/dolthub/dolt/releases/latest/download/install.sh | bash ``` -------------------------------- ### Task 5: Write failing CLI tests Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md A TypeScript test case to verify the 'doctor --json' command returns structured install diagnostics. ```typescript import test from 'node:test'; import assert from 'node:assert/strict'; import { runCli } from '../../src/cli/beadboard-cli'; test('doctor returns structured install diagnostics', async () => { const out = await runCli(['doctor', '--json']); assert.equal(out.ok, true); assert.ok(out.installMode); }); ``` -------------------------------- ### Task 4: Run test to verify it fails Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Command to execute the TypeScript test for the installer's legacy migration. ```bash node --import tsx --test tests/scripts/install-legacy-migration.test.ts ``` -------------------------------- ### Install beadboard-driver skill Source: https://github.com/jordanhindo/beadboard/blob/main/CONTRIBUTING.md Installs the beadboard-driver for agents, providing the full operating contract. ```bash npx skills add zenchantlive/beadboard --skill beadboard-driver ``` -------------------------------- ### Task 3: Update launcher to run from managed runtime root - Failing test Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md A TypeScript test case to verify that the 'status --json' command reports runtime root and install mode. ```typescript import test from 'node:test'; import assert from 'node:assert/strict'; import { execFile } from 'node:child_process'; import { promisify } from 'node:util'; import path from 'node:path'; const execFileAsync = promisify(execFile); const launcherPath = path.resolve('install/beadboard.mjs'); test('status --json reports runtime root and install mode', async () => { const { stdout } = await execFileAsync(process.execPath, [launcherPath, 'status', '--json']); const payload = JSON.parse(stdout); assert.ok(payload.runtimeRoot); assert.ok(payload.installMode); }); ``` -------------------------------- ### Start Agent A Source: https://github.com/jordanhindo/beadboard/blob/main/docs/dispatch/launch-order.md Navigate to the agent-a directory in the terminal. ```powershell cd C:\Users\Zenchant\codex\beadboard\.worktrees\agent-a ``` -------------------------------- ### 1. Create Epic Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/references/creating-beads.md Example command to create an epic bead for payment integration. ```bash bd create --title="[EPIC] Payment Integration" --description="Add Stripe payment processing" --type=epic --priority=1 --label="feature,payments" Created beadboard-pmt (epic) ``` -------------------------------- ### Start Agent C Source: https://github.com/jordanhindo/beadboard/blob/main/docs/dispatch/launch-order.md Navigate to the agent-c directory in the terminal. ```powershell cd C:\Users\Zenchant\codex\beadboard\.worktrees\agent-c ``` -------------------------------- ### Task 4: Write failing migration test Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md A TypeScript test case to verify that the installer migrates legacy repo-bound shims to runtime-managed shims. ```typescript import test from 'node:test'; import assert from 'node:assert/strict'; // simulate legacy shim text and verify installer rewrites to runtime target test('installer migrates legacy repo-bound shim to runtime-managed shim', async () => { assert.fail('implement'); }); ``` -------------------------------- ### GET /api/sessions/[beadId]/conversation Response Source: https://github.com/jordanhindo/beadboard/blob/main/docs/api-reference.md Example JSON response for getting a bead's conversation thread. ```json { "comments": [...], "messages": [...] } ``` -------------------------------- ### GET /api/beads/read Response Source: https://github.com/jordanhindo/beadboard/blob/main/docs/api-reference.md Example JSON response for reading beads. ```json { "issues": [...], "projectRoot": "/path/to/project" } ``` -------------------------------- ### GET /api/projects Response Source: https://github.com/jordanhindo/beadboard/blob/main/docs/api-reference.md Example JSON response for listing all registered projects. ```json { "projects": [ { "key": "proj-1", "root": "/path/to/project", "name": "Project Name" } ] } ``` -------------------------------- ### GET /api/activity Response Source: https://github.com/jordanhindo/beadboard/blob/main/docs/api-reference.md Example JSON response for fetching recent activity events. ```json { "events": [ { "id": "evt-123", "beadId": "bb-abc", "kind": "status_changed", "actor": "agent-1", "timestamp": "2026-02-16T05:00:00Z", "changes": { "from": "todo", "to": "in_progress" } } ] } ``` -------------------------------- ### Fork Setup Steps Source: https://github.com/jordanhindo/beadboard/blob/main/docs/prompts/2026-02-19-beads-cgo-fix-pr.md Steps to fork the beads repository, clone it, create a new branch, make changes, and push for a pull request. ```bash git clone https://github.com/YOUR_USERNAME/beads.git git checkout -b fix/cgo-native-builds git push origin fix/cgo-native-builds ``` -------------------------------- ### GET /api/sessions Response Source: https://github.com/jordanhindo/beadboard/blob/main/docs/api-reference.md Example JSON response for fetching agent sessions task feed. ```json { "buckets": [ { "epic": { "id": "bb-epic", "title": "Epic Title", "status": "open" }, "tasks": [ { "id": "bb-task", "title": "Task Title", "epicId": "bb-epic", "status": "in_progress", "sessionState": "active", "owner": "agent-1", "lastActor": "agent-1", "lastActivityAt": "2026-02-16T05:00:00Z", "communication": { "unreadCount": 2, "pendingRequired": true, "latestSnippet": "Blocked on API" } } ] } ] } ``` -------------------------------- ### GET /api/agents/[agentId]/stats Response Source: https://github.com/jordanhindo/beadboard/blob/main/docs/api-reference.md Example JSON response for fetching agent productivity metrics. ```json { "activeTasks": 3, "completedTasks": 12, "handoffsSent": 8, "recentWins": [ { "id": "bb-xyz", "title": "Task title" } ] } ``` -------------------------------- ### Identity Check (Start of Session) Source: https://github.com/jordanhindo/beadboard/blob/main/docs/agent-session-flow.md Before claiming work, ensure your agent identity is registered and active. ```bash # Check if you are registered bb agent show --agent agent-ui-1 # If not, register (idempotent, use --force-update to change role/display) bb agent register --name agent-ui-1 --role ui --display "UI Agent 1" ``` -------------------------------- ### Start Commands Source: https://github.com/jordanhindo/beadboard/blob/main/NEXT_SESSION_PROMPT.md Commands to navigate to the beadboard directory, check git status, and prepare the beadboard session. ```bash cd beadboard git status bd show beadboard-v5a bd ready ``` -------------------------------- ### Step 2: Run test to verify it fails (Task 6) Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Commands to run tests for the beadboard driver session preflight to verify failures. ```bash node --import tsx --test tests/skills/beadboard-driver/resolve-bb.test.ts node --import tsx --test tests/skills/beadboard-driver/session-preflight.test.ts ``` -------------------------------- ### Install Dolt on macOS Source: https://github.com/jordanhindo/beadboard/blob/main/README.md Installs Dolt using Homebrew on macOS. ```bash # macOS brew install dolt ``` -------------------------------- ### Viewing Dependencies Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/references/creating-beads.md Commands to list all dependencies for a specific bead or to view beads that are ready to start. ```bash bd dep list beadboard-xyz # Show all dependencies bd ready # Show unblocked, ready-to-start beads ``` -------------------------------- ### Task 3: Commit changes Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Git commands to stage and commit the changes made for the launcher update. ```bash git add install/beadboard.mjs tests/scripts/beadboard-launcher.test.ts tests/scripts/beadboard-launcher-runtime.test.ts git commit -m "feat(launcher): add runtime-aware status metadata" ``` -------------------------------- ### Examples of bd-diff usage Source: https://github.com/jordanhindo/beadboard/blob/main/help/cli/bd-diff-help.txt Demonstrates how to compare different commits and branches using the bd-diff command. ```bash bd diff main feature-branch # Compare main to feature branch bd diff HEAD~5 HEAD # Show changes in last 5 commits bd diff abc123 def456 # Compare two specific commits ``` -------------------------------- ### Install Dolt on macOS Source: https://github.com/jordanhindo/beadboard/blob/main/CONTRIBUTING.md Command to install Dolt using Homebrew. ```bash brew install dolt ``` -------------------------------- ### Agent Workflow Steps Source: https://github.com/jordanhindo/beadboard/blob/main/AGENTS.md A step-by-step workflow for agents using the 'bd' command-line tool, including reading memory, finding work, creating agent beads, claiming tasks, implementing, verifying, recording evidence, and syncing. ```bash # 1. Read memory bd show beadboard-116 beadboard-60a beadboard-zas # hard rules # 2. Find work bd ready bd show # read full spec + acceptance criteria # 3. Create your agent bead (if not already done this session) bd create --title="Agent: " --type=task --priority=0 --label="gt:agent,role:" # 4. Claim bd update --status in_progress --assignee # 5. Implement (TDD: write failing test first, then code) # 6. Verify npm run typecheck && npm run lint && npm run test # 7. Record evidence + close bd update --notes "" bd close --reason "" # 8. Memory review # If reusable lesson → create/supersede canonical memory node # If no lesson → bd update --notes "Memory review: no new reusable memory." # 9. Sync bd dolt pull && bd dolt push ``` -------------------------------- ### Install Dolt on Linux/Windows Source: https://github.com/jordanhindo/beadboard/blob/main/README.md Installs Dolt on Linux or Windows using a curl script. ```bash # Linux / Windows curl -L https://github.com/dolthub/dolt/releases/latest/download/install.sh | bash ``` -------------------------------- ### Step 5: Commit changes (Task 8) Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Git command to commit changes to NEXT_SESSION_PROMPT.md. ```bash git add NEXT_SESSION_PROMPT.md git commit -m "chore: close runtime-manager rollout with verification evidence" ``` -------------------------------- ### Task 3: Run test to verify it fails Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Command to execute the TypeScript test for the launcher's status command. ```bash node --import tsx --test tests/scripts/beadboard-launcher-runtime.test.ts ``` -------------------------------- ### Agent ID Example Source: https://github.com/jordanhindo/beadboard/blob/main/docs/RFC-001-Agent-Coordination.md Example of a stable agent_id format. ```shell agent-ui-1 ``` -------------------------------- ### Step 5: Commit changes (Task 7) Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Git commands to add and commit modified files for CI, docs, and release readiness task. ```bash git add .github/workflows/installer-smoke.yml README.md docs/adr/2026-03-03-runtime-manager-global-install.md docs/ops/global-install-rollout.md tests/scripts/installer-ci-contract.test.ts tests/docs/installer-quickstart-contract.test.ts git commit -m "docs(ci): finalize global install runtime docs and smoke coverage" ``` -------------------------------- ### Recovery Playbook - Doctor Command Source: https://github.com/jordanhindo/beadboard/blob/main/docs/ops/global-install-rollout.md Command to diagnose beadboard installation issues. ```bash beadboard doctor --json ``` -------------------------------- ### Configuration commands Source: https://github.com/jordanhindo/beadboard/blob/main/help/cli/bd-dolt-help.txt Commands to view and set Dolt server configuration. ```bash bd dolt show Show current Dolt configuration with connection test bd dolt set Set a configuration value bd dolt test Test server connection ``` -------------------------------- ### Agent communication examples using bd mail Source: https://github.com/jordanhindo/beadboard/blob/main/README.md Examples of using the 'bd mail' command for sending and acknowledging messages. ```bash bd mail inbox bd mail send --to --bead --category HANDOFF --subject "Ready for review" bd mail ack ``` -------------------------------- ### Get swarm status Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-02-19-swarm-page-redesign.md Command to get the computed status of a swarm or epic, outputting in JSON format. ```bash bd swarm status --json ``` -------------------------------- ### State Transitions: Session Start Source: https://github.com/jordanhindo/beadboard/blob/main/skills/beadboard-driver/references/agent-state-liveness.md Commands to set an agent to 'spawning' and then 'running' state. ```bash bd agent state bb-silver-scribe spawning bd agent state bb-silver-scribe running ``` -------------------------------- ### Task 5: Commit changes Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Git commands to stage and commit the changes made for adding global CLI entrypoint commands. ```bash git add package.json bin/beadboard.js src/cli/beadboard-cli.ts tests/cli/beadboard-cli.test.ts git commit -m "feat(cli): add global entrypoint with doctor/update/uninstall commands" ``` -------------------------------- ### Step 3: Update beads with evidence (Task 8) Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-03-03-global-install-runtime-manager.md Commands to update bead issue notes with execution details. ```bash bd update --notes "" bd close --reason "" ``` -------------------------------- ### Social Card Footer Example Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-02-16-agent-social-redesign.md Example structure for the footer of the redesigned `SocialCard` (The Post). ```html
``` -------------------------------- ### Social Card Tags Example Source: https://github.com/jordanhindo/beadboard/blob/main/docs/plans/2026-02-16-agent-social-redesign.md Example structure for tags/dependencies in the redesigned `SocialCard` (The Post). ```html
#dependency1 #feature
```