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

docs: Clarify Claude Code plugin installation requires bd CLI

Browse Source 
The plugin documentation now explicitly states that:
1. The bd CLI must be installed first (prerequisite)
2. Plugin installation is a multi-step process (marketplace add + install + restart)
3. Removed misleading 'one-command' and 'auto-configured' language

This completes the documentation fixes started in PR #35.
This commit is contained in:
Steve Yegge
2025-10-15 00:40:53 -07:00
parent 3dd3c8f09c
commit e1aeccfce6
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -97,19 +97,23 @@ Thanks to [@v4rgas](https://github.com/v4rgas) for maintaining the AUR package!
### Claude Code Plugin ### Claude Code Plugin
Prefer a one-command installation in Claude Code? Install the beads plugin for instant access via slash commands and MCP tools: For Claude Code users, the beads plugin provides slash commands and MCP tools.
**Prerequisites:**
1. First, install the bd CLI (see Quick Install Script above)
2. Then install the plugin:
```bash ```bash
# In Claude Code # In Claude Code
/plugin marketplace add steveyegge/beads /plugin marketplace add steveyegge/beads
/plugin install beads /plugin install beads
# Restart Claude Code
``` ```
The plugin includes: The plugin includes:
- Slash commands: `/bd-ready`, `/bd-create`, `/bd-show`, `/bd-update`, `/bd-close`, etc. - Slash commands: `/bd-ready`, `/bd-create`, `/bd-show`, `/bd-update`, `/bd-close`, etc.
- Full MCP server with all bd tools - Full MCP server with all bd tools
- Task agent for autonomous execution - Task agent for autonomous execution
- Auto-configured for instant use
See [PLUGIN.md](PLUGIN.md) for complete plugin documentation. See [PLUGIN.md](PLUGIN.md) for complete plugin documentation.