johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update skill names from /bd-* to /beads:* (#862)

Browse Source 
The Claude Code plugin uses beads:* prefix for slash commands, not bd-*.
Updated all documentation to reflect actual installed command names.

Files updated:
- docs/PLUGIN.md
- docs/INSTALLING.md
- website/docs/integrations/claude-code.md
- website/static/llms-full.txt
- commands/init.md, stats.md, workflow.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Executed-By: beads/crew/dave
Rig: beads
Role: crew
This commit is contained in:
beads/crew/dave
2026-01-02 17:07:49 -08:00
committed by Steve Yegge
parent e2931317c0
commit 1ffd1431b7
7 changed files with 55 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
commands/init.md
View File

@@ -12,7 +12,7 @@ Use the beads MCP `init` tool with the prefix parameter (if provided) to set up
After initialization: After initialization:
1. Show the database location 1. Show the database location
2. Show the issue prefix that will be used 2. Show the issue prefix that will be used
3. Explain the basic workflow (or suggest running `/bd-workflow`) 3. Explain the basic workflow (or suggest running `/beads:workflow`)
4. Suggest creating the first issue with `/bd-create` 4. Suggest creating the first issue with `/beads:create`
If beads is already initialized, inform the user and show project stats using the `stats` tool. If beads is already initialized, inform the user and show project stats using the `stats` tool.

6
commands/stats.md
View File

@@ -12,6 +12,6 @@ Use the beads MCP `stats` tool to retrieve project metrics and present them clea
- Recently updated issues - Recently updated issues
Optionally suggest actions based on the stats: Optionally suggest actions based on the stats:
- High number of blocked issues? Run `/bd-blocked` to investigate - High number of blocked issues? Run `/beads:blocked` to investigate
- No in_progress work? Run `/bd-ready` to find tasks - No in_progress work? Run `/beads:ready` to find tasks
- Many open issues? Consider prioritizing with `/bd-update` - Many open issues? Consider prioritizing with `/beads:update`

22
commands/workflow.md
View File

@@ -9,11 +9,11 @@ Display the beads workflow for AI agents and developers.
Beads is an issue tracker designed for AI-supervised coding workflows. Here's how to use it effectively: Beads is an issue tracker designed for AI-supervised coding workflows. Here's how to use it effectively:
## 1. Find Ready Work ## 1. Find Ready Work
Use `/bd-ready` or the `ready` MCP tool to see tasks with no blockers. Use `/beads:ready` or the `ready` MCP tool to see tasks with no blockers.
## 2. Claim Your Task ## 2. Claim Your Task
Update the issue status to `in_progress`: Update the issue status to `in_progress`:
- Via command: `/bd-update <id> in_progress` - Via command: `/beads:update <id> in_progress`
- Via MCP tool: `update` with `status: "in_progress"` - Via MCP tool: `update` with `status: "in_progress"`
## 3. Work on It ## 3. Work on It
@@ -21,18 +21,18 @@ Implement, test, and document the feature or fix.
## 4. Discover New Work ## 4. Discover New Work
As you work, you'll often find bugs, TODOs, or related work: As you work, you'll often find bugs, TODOs, or related work:
- Create issues: `/bd-create` or `create` MCP tool - Create issues: `/beads:create` or `create` MCP tool
- Link them: Use `dep` MCP tool with `type: "discovered-from"` - Link them: Use `dep` MCP tool with `type: "discovered-from"`
- This maintains context and work history - This maintains context and work history
## 5. Complete the Task ## 5. Complete the Task
Close the issue when done: Close the issue when done:
- Via command: `/bd-close <id> "Completed: <summary>"` - Via command: `/beads:close <id> "Completed: <summary>"`
- Via MCP tool: `close` with reason - Via MCP tool: `close` with reason
## 6. Check What's Unblocked ## 6. Check What's Unblocked
After closing, check if other work became ready: After closing, check if other work became ready:
- Use `/bd-ready` to see newly unblocked tasks - Use `/beads:ready` to see newly unblocked tasks
- Start the cycle again - Start the cycle again
## Tips ## Tips
@@ -43,12 +43,12 @@ After closing, check if other work became ready:
- **Git workflow**: After `git pull`, JSONL auto-imports if newer than DB - **Git workflow**: After `git pull`, JSONL auto-imports if newer than DB
## Available Commands ## Available Commands
- `/bd-ready` - Find unblocked work - `/beads:ready` - Find unblocked work
- `/bd-create` - Create new issue - `/beads:create` - Create new issue
- `/bd-show` - Show issue details - `/beads:show` - Show issue details
- `/bd-update` - Update issue - `/beads:update` - Update issue
- `/bd-close` - Close issue - `/beads:close` - Close issue
- `/bd-workflow` - Show this guide (you are here!) - `/beads:workflow` - Show this guide (you are here!)
## MCP Tools Available ## MCP Tools Available
Use these via the beads MCP server: Use these via the beads MCP server:

4
docs/INSTALLING.md
View File

@@ -9,7 +9,7 @@ Beads has several components - here's what they are and when you need them:
| Component | What It Is | When You Need It | | Component | What It Is | When You Need It |
|-----------|------------|------------------| |-----------|------------|------------------|
| **bd CLI** | Core command-line tool | Always - this is the foundation | | **bd CLI** | Core command-line tool | Always - this is the foundation |
| **Claude Code Plugin** | Slash commands + enhanced UX | Optional - if you want `/bd-ready`, `/bd-create` commands | | **Claude Code Plugin** | Slash commands + enhanced UX | Optional - if you want `/beads:ready`, `/beads:create` commands |
| **MCP Server (beads-mcp)** | Model Context Protocol interface | Only for MCP-only environments (Claude Desktop, Amp) | | **MCP Server (beads-mcp)** | Model Context Protocol interface | Only for MCP-only environments (Claude Desktop, Amp) |
**How they relate:** **How they relate:**
@@ -209,7 +209,7 @@ For enhanced UX with slash commands:
``` ```
The plugin adds: The plugin adds:
- Slash commands: `/bd-ready`, `/bd-create`, `/bd-show`, `/bd-update`, `/bd-close`, etc. - Slash commands: `/beads:ready`, `/beads:create`, `/beads:show`, `/beads:update`, `/beads:close`, etc.
- Task agent for autonomous execution - Task agent for autonomous execution
See [PLUGIN.md](PLUGIN.md) for complete plugin documentation. See [PLUGIN.md](PLUGIN.md) for complete plugin documentation.

54
docs/PLUGIN.md
View File

@@ -65,37 +65,37 @@ After installation, restart Claude Code to activate the MCP server.
```bash ```bash
# Initialize beads in your project # Initialize beads in your project
/bd-init /beads:init
# Create your first issue # Create your first issue
/bd-create "Set up project structure" feature 1 /beads:create "Set up project structure" feature 1
# See what's ready to work on # See what's ready to work on
/bd-ready /beads:ready
# Show full workflow guide # Show full workflow guide
/bd-workflow /beads:workflow
``` ```
## Available Commands ## Available Commands
### Version Management ### Version Management
- **`/bd-version`** - Check bd CLI, plugin, and MCP server versions - **`/beads:version`** - Check bd CLI, plugin, and MCP server versions
### Core Workflow Commands ### Core Workflow Commands
- **`/bd-ready`** - Find tasks with no blockers, ready to work on - **`/beads:ready`** - Find tasks with no blockers, ready to work on
- **`/bd-create [title] [type] [priority]`** - Create a new issue interactively - **`/beads:create [title] [type] [priority]`** - Create a new issue interactively
- **`/bd-show [issue-id]`** - Show detailed information about an issue - **`/beads:show [issue-id]`** - Show detailed information about an issue
- **`/bd-update [issue-id] [status]`** - Update issue status or other fields - **`/beads:update [issue-id] [status]`** - Update issue status or other fields
- **`/bd-close [issue-id] [reason]`** - Close a completed issue - **`/beads:close [issue-id] [reason]`** - Close a completed issue
### Project Management ### Project Management
- **`/bd-init`** - Initialize beads in the current project - **`/beads:init`** - Initialize beads in the current project
- **`/bd-workflow`** - Show the AI-supervised issue workflow guide - **`/beads:workflow`** - Show the AI-supervised issue workflow guide
- **`/bd-stats`** - Show project statistics and progress - **`/beads:stats`** - Show project statistics and progress
### Agents ### Agents
@@ -124,11 +124,11 @@ The plugin includes a full-featured MCP server with these tools:
The beads workflow is designed for AI agents but works great for humans too: The beads workflow is designed for AI agents but works great for humans too:
1. **Find ready work**: `/bd-ready` 1. **Find ready work**: `/beads:ready`
2. **Claim your task**: `/bd-update <id> in_progress` 2. **Claim your task**: `/beads:update <id> in_progress`
3. **Work on it**: Implement, test, document 3. **Work on it**: Implement, test, document
4. **Discover new work**: Create issues for bugs/TODOs found during work 4. **Discover new work**: Create issues for bugs/TODOs found during work
5. **Complete**: `/bd-close <id> "Done: <summary>"` 5. **Complete**: `/beads:close <id> "Done: <summary>"`
6. **Repeat**: Check for newly unblocked tasks 6. **Repeat**: Check for newly unblocked tasks
## Issue Types ## Issue Types
@@ -230,29 +230,29 @@ To customize, edit your Claude Code MCP settings or the plugin configuration.
```bash ```bash
# Create a high-priority bug # Create a high-priority bug
/bd-create "Fix authentication" bug 1 /beads:create "Fix authentication" bug 1
# See ready work # See ready work
/bd-ready /beads:ready
# Start working on bd-10 # Start working on bd-10
/bd-update bd-10 in_progress /beads:update bd-10 in_progress
# Complete the task # Complete the task
/bd-close bd-10 "Fixed auth token validation" /beads:close bd-10 "Fixed auth token validation"
``` ```
### Discovering Work During Development ### Discovering Work During Development
```bash ```bash
# Working on bd-10, found a related bug # Working on bd-10, found a related bug
/bd-create "Add rate limiting to API" feature 2 /beads:create "Add rate limiting to API" feature 2
# Link it to current work (via MCP tool) # Link it to current work (via MCP tool)
# Use `dep` tool: issue="bd-11", depends_on="bd-10", type="discovered-from" # Use `dep` tool: issue="bd-11", depends_on="bd-10", type="discovered-from"
# Close original task # Close original task
/bd-close bd-10 "Done, discovered bd-11 for rate limiting" /beads:close bd-10 "Done, discovered bd-11 for rate limiting"
``` ```
### Using the Task Agent ### Using the Task Agent
@@ -322,7 +322,7 @@ The MCP server **automatically checks** bd CLI version on startup and will fail
Check version compatibility manually: Check version compatibility manually:
```bash ```bash
/bd-version /beads:version
``` ```
This will show: This will show:
@@ -332,11 +332,11 @@ This will show:
- Compatibility warnings if versions mismatch - Compatibility warnings if versions mismatch
**Recommended update workflow:** **Recommended update workflow:**
1. Check versions: `/bd-version` 1. Check versions: `/beads:version`
2. Update bd CLI if needed (see above) 2. Update bd CLI if needed (see above)
3. Update plugin: `/plugin update beads` 3. Update plugin: `/plugin update beads`
4. Restart Claude Code 4. Restart Claude Code
5. Verify: `/bd-version` 5. Verify: `/beads:version`
### Version Numbering ### Version Numbering
@@ -363,7 +363,7 @@ Beads follows semantic versioning. The plugin version tracks the bd CLI version:
### Commands not working ### Commands not working
1. Make sure you're in a project with beads initialized: `/bd-init` 1. Make sure you're in a project with beads initialized: `/beads:init`
2. Check if database exists: `ls -la .beads/` 2. Check if database exists: `ls -la .beads/`
3. Try direct MCP tool access instead of slash commands 3. Try direct MCP tool access instead of slash commands
4. Check the beads CLI works: `bd --help` 4. Check the beads CLI works: `bd --help`
@@ -373,7 +373,7 @@ Beads follows semantic versioning. The plugin version tracks the bd CLI version:
1. Verify `bd` executable location: `BEADS_PATH` env var 1. Verify `bd` executable location: `BEADS_PATH` env var
2. Check `bd` works in terminal: `bd stats` 2. Check `bd` works in terminal: `bd stats`
3. Review MCP server logs in Claude Code 3. Review MCP server logs in Claude Code
4. Try reinitializing: `/bd-init` 4. Try reinitializing: `/beads:init`
## Learn More ## Learn More

10
website/docs/integrations/claude-code.md
View File

@@ -144,11 +144,11 @@ For enhanced UX with slash commands:
``` ```
Adds slash commands: Adds slash commands:
- `/bd-ready` - Show ready work - `/beads:ready` - Show ready work
- `/bd-create` - Create issue - `/beads:create` - Create issue
- `/bd-show` - Show issue - `/beads:show` - Show issue
- `/bd-update` - Update issue - `/beads:update` - Update issue
- `/bd-close` - Close issue - `/beads:close` - Close issue
## Troubleshooting ## Troubleshooting

10
website/static/llms-full.txt
View File

@@ -4425,11 +4425,11 @@ For enhanced UX with slash commands:
``` ```
Adds slash commands: Adds slash commands:
- `/bd-ready` - Show ready work - `/beads:ready` - Show ready work
- `/bd-create` - Create issue - `/beads:create` - Create issue
- `/bd-show` - Show issue - `/beads:show` - Show issue
- `/bd-update` - Update issue - `/beads:update` - Update issue
- `/bd-close` - Close issue - `/beads:close` - Close issue
## Troubleshooting ## Troubleshooting