beads/integrations/junie
Amp a333dcaa75 fix(docs): purge stale bd sync/import/--branch refs + add CI doc validation (GH#2522)
Systematic cleanup of stale documentation references left over from the
Dolt migration:

- Replace all 'bd sync' → 'bd dolt push' / 'bd dolt pull' across 40+ files
- Replace all 'bd import' → 'bd init --from-jsonl' or remove
- Replace 'bd init --branch' → note about refs/dolt/data separation
- Fix AGENT_INSTRUCTIONS.md (highest impact: agents read this directly)
- Fix npm-package, claude-plugin, integrations, examples, website docs

Add scripts/check-doc-flags.sh to catch stale doc references:
- Checks for removed commands (bd sync, bd import)
- Checks for removed flags (bd init --branch)
- Warns on legacy SQLite/beads.db references
- Compares CLI_REFERENCE.md against bd help --all

Add CI job (check-doc-flags) and Makefile target (check-docs) to gate
PRs against doc freshness.

Prior art: feat/help-doc-generator branch has bd help --doc/--list for
generating docs FROM CLI output. This script validates docs AGAINST CLI
output — complementary approaches.

Amp-Thread-ID: https://ampcode.com/threads/T-019cde77-0722-7353-b63a-1779a5773ca6
Co-authored-by: Amp <amp@ampcode.com>
2026-03-11 13:25:40 -07:00
..
README.md fix(docs): purge stale bd sync/import/--branch refs + add CI doc validation (GH#2522) 2026-03-11 13:25:40 -07:00

Junie Integration for Beads

Integration for Junie (JetBrains AI Agent) with beads issue tracking.

Prerequisites

# Install beads
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash

# Initialize beads in your project
bd init

Installation

bd setup junie

This creates:

  • .junie/guidelines.md - Agent instructions for beads workflow
  • .junie/mcp/mcp.json - MCP server configuration

What Gets Installed

Guidelines (.junie/guidelines.md)

Junie automatically reads this file on session start. It contains:

  • Core workflow rules for using beads
  • Command reference for the bd CLI
  • Issue types and priorities
  • MCP tool documentation

MCP Config (.junie/mcp/mcp.json)

Configures the beads MCP server so Junie can use beads tools directly:

{
  "mcpServers": {
    "beads": {
      "command": "bd",
      "args": ["mcp"]
    }
  }
}

Usage

Once installed, Junie will:

  1. Read workflow instructions from .junie/guidelines.md
  2. Have access to beads MCP tools for direct issue management
  3. Be able to use bd CLI commands

MCP Tools Available

  • mcp_beads_ready - Find tasks ready for work
  • mcp_beads_list - List issues with filters
  • mcp_beads_show - Show issue details
  • mcp_beads_create - Create new issues
  • mcp_beads_update - Update issue status/priority
  • mcp_beads_close - Close completed issues
  • mcp_beads_dep - Manage dependencies
  • mcp_beads_blocked - Show blocked issues
  • mcp_beads_stats - Get issue statistics

Verification

bd setup junie --check

Removal

bd setup junie --remove
  • bd prime - Get full workflow context
  • bd ready - Find unblocked work
  • bd dolt push - Push issue changes to Dolt remote (run at session end)

License

Same as beads (see repository root).