opencode-beads 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -2
- package/package.json +1 -1
- package/src/vendor.ts +6 -3
- package/vendor/commands/compact.md +5 -5
- package/vendor/commands/daemon.md +5 -5
- package/vendor/commands/init.md +2 -2
- package/vendor/commands/quickstart.md +3 -7
- package/vendor/commands/stats.md +3 -3
- package/vendor/commands/version.md +1 -1
- package/vendor/commands/workflow.md +11 -11
package/README.md
CHANGED
|
@@ -16,13 +16,21 @@ Add to your OpenCode config (`~/.config/opencode/opencode.json`):
|
|
|
16
16
|
|
|
17
17
|
```json
|
|
18
18
|
{
|
|
19
|
-
"plugin": ["opencode-beads
|
|
19
|
+
"plugin": ["opencode-beads"]
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
Restart OpenCode and you're ready to go.
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Optionally, pin to a specific version for stability:
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"plugin": ["opencode-beads@0.4.0"]
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
OpenCode fetches unpinned plugins from npm on each startup; pinned versions are cached and require a manual version bump to update.
|
|
26
34
|
|
|
27
35
|
## Features
|
|
28
36
|
|
package/package.json
CHANGED
package/src/vendor.ts
CHANGED
|
@@ -86,9 +86,12 @@ async function listVendorFiles(relativePath: string): Promise<string[]> {
|
|
|
86
86
|
|
|
87
87
|
const BEADS_CLI_USAGE = `## CLI Usage
|
|
88
88
|
|
|
89
|
-
**
|
|
89
|
+
**IMPORTANT:** There is no \`bd\` tool in this environment. You must use the \`bash\` tool to run the \`bd\` command.
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
**Do not try to call a tool named \`bd\` directly.** It does not exist.
|
|
92
|
+
**Do not try to call MCP tools (like \`ready\`, \`create\`) directly.** They do not exist.
|
|
93
|
+
|
|
94
|
+
Instead, use the \`bash\` tool for all beads operations:
|
|
92
95
|
|
|
93
96
|
- \`bd init [prefix]\` - Initialize beads
|
|
94
97
|
- \`bd ready --json\` - List ready tasks
|
|
@@ -180,7 +183,7 @@ export async function loadCommands(): Promise<Config["command"]> {
|
|
|
180
183
|
const parsed = parseMarkdownWithFrontmatter(content);
|
|
181
184
|
if (!parsed) continue;
|
|
182
185
|
|
|
183
|
-
const name = `
|
|
186
|
+
const name = `beads:${file.replace(".md", "")}`;
|
|
184
187
|
|
|
185
188
|
const argHint = parsed.frontmatter["argument-hint"];
|
|
186
189
|
const baseDescription = parsed.frontmatter.description ?? name;
|
|
@@ -12,11 +12,11 @@ Reduce database size by summarizing closed issues no longer actively referenced.
|
|
|
12
12
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
|
-
- **Preview candidates**: `bd compact --dry-run`
|
|
16
|
-
- **Compact all eligible**: `bd compact --all`
|
|
17
|
-
- **Compact specific issue**: `bd compact --id bd-42`
|
|
18
|
-
- **Force compact**: `bd compact --id bd-42 --force` (bypass age checks)
|
|
19
|
-
- **View statistics**: `bd compact --stats`
|
|
15
|
+
- **Preview candidates**: `bd admin compact --dry-run`
|
|
16
|
+
- **Compact all eligible**: `bd admin compact --all`
|
|
17
|
+
- **Compact specific issue**: `bd admin compact --id bd-42`
|
|
18
|
+
- **Force compact**: `bd admin compact --id bd-42 --force` (bypass age checks)
|
|
19
|
+
- **View statistics**: `bd admin compact --stats`
|
|
20
20
|
|
|
21
21
|
## Options
|
|
22
22
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
description: Manage background sync daemon
|
|
3
|
-
argument-hint: [
|
|
3
|
+
argument-hint: [start] [stop] [status]
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
Manage the per-project background daemon that handles database connections and syncs with git.
|
|
@@ -39,10 +39,10 @@ Each project runs its own daemon at `.beads/bd.sock` for complete database isola
|
|
|
39
39
|
|
|
40
40
|
## Common Operations
|
|
41
41
|
|
|
42
|
-
- **Start**: `bd daemon
|
|
43
|
-
- **Stop**: `bd daemon
|
|
44
|
-
- **Status**: `bd daemon
|
|
45
|
-
- **Health**: `bd daemon --
|
|
42
|
+
- **Start**: `bd daemon start` (or auto-starts on first `bd` command)
|
|
43
|
+
- **Stop**: `bd daemon stop`
|
|
44
|
+
- **Status**: `bd daemon status`
|
|
45
|
+
- **Health**: `bd daemon status --all` - shows uptime, cache stats, performance metrics
|
|
46
46
|
- **Metrics**: `bd daemon --metrics` - detailed operational telemetry
|
|
47
47
|
|
|
48
48
|
## Sync Options
|
package/vendor/commands/init.md
CHANGED
|
@@ -12,7 +12,7 @@ Use the beads MCP `init` tool with the prefix parameter (if provided) to set up
|
|
|
12
12
|
After initialization:
|
|
13
13
|
1. Show the database location
|
|
14
14
|
2. Show the issue prefix that will be used
|
|
15
|
-
3. Explain the basic workflow (or suggest running `/
|
|
16
|
-
4. Suggest creating the first issue with `/
|
|
15
|
+
3. Explain the basic workflow (or suggest running `/beads:workflow`)
|
|
16
|
+
4. Suggest creating the first issue with `/beads:create`
|
|
17
17
|
|
|
18
18
|
If beads is already initialized, inform the user and show project stats using the `stats` tool.
|
|
@@ -1,17 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: Quick start guide for bd workflows
|
|
2
|
+
description: Quick start guide for bd workflows (deprecated)
|
|
3
3
|
argument-hint: []
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
**Note:** The `bd quickstart` command is deprecated. See [docs/QUICKSTART.md](../docs/QUICKSTART.md) instead.
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
The quickstart documentation covers:
|
|
9
9
|
- Getting started with bd
|
|
10
10
|
- Common workflow patterns
|
|
11
11
|
- Basic commands
|
|
12
12
|
- Dependency management
|
|
13
13
|
- Git integration
|
|
14
|
-
|
|
15
|
-
This is an interactive tutorial that walks through the essential bd commands and concepts for new users.
|
|
16
|
-
|
|
17
|
-
No arguments needed - just run `bd quickstart` to see the full guide.
|
package/vendor/commands/stats.md
CHANGED
|
@@ -12,6 +12,6 @@ Use the beads MCP `stats` tool to retrieve project metrics and present them clea
|
|
|
12
12
|
- Recently updated issues
|
|
13
13
|
|
|
14
14
|
Optionally suggest actions based on the stats:
|
|
15
|
-
- High number of blocked issues? Run `/
|
|
16
|
-
- No in_progress work? Run `/
|
|
17
|
-
- Many open issues? Consider prioritizing with `/
|
|
15
|
+
- High number of blocked issues? Run `/beads:blocked` to investigate
|
|
16
|
+
- No in_progress work? Run `/beads:ready` to find tasks
|
|
17
|
+
- Many open issues? Consider prioritizing with `/beads:update`
|
|
@@ -19,7 +19,7 @@ Display:
|
|
|
19
19
|
- Compatibility status (✓ compatible or ⚠️ update needed)
|
|
20
20
|
|
|
21
21
|
If versions are mismatched, provide instructions:
|
|
22
|
-
- Update bd CLI: `curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/install.sh | bash`
|
|
22
|
+
- Update bd CLI: `curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash`
|
|
23
23
|
- Update plugin: `/plugin update beads`
|
|
24
24
|
- Restart Claude Code after updating
|
|
25
25
|
|
|
@@ -9,11 +9,11 @@ Display the beads workflow for AI agents and developers.
|
|
|
9
9
|
Beads is an issue tracker designed for AI-supervised coding workflows. Here's how to use it effectively:
|
|
10
10
|
|
|
11
11
|
## 1. Find Ready Work
|
|
12
|
-
Use `/
|
|
12
|
+
Use `/beads:ready` or the `ready` MCP tool to see tasks with no blockers.
|
|
13
13
|
|
|
14
14
|
## 2. Claim Your Task
|
|
15
15
|
Update the issue status to `in_progress`:
|
|
16
|
-
- Via command: `/
|
|
16
|
+
- Via command: `/beads:update <id> in_progress`
|
|
17
17
|
- Via MCP tool: `update` with `status: "in_progress"`
|
|
18
18
|
|
|
19
19
|
## 3. Work on It
|
|
@@ -21,18 +21,18 @@ Implement, test, and document the feature or fix.
|
|
|
21
21
|
|
|
22
22
|
## 4. Discover New Work
|
|
23
23
|
As you work, you'll often find bugs, TODOs, or related work:
|
|
24
|
-
- Create issues: `/
|
|
24
|
+
- Create issues: `/beads:create` or `create` MCP tool
|
|
25
25
|
- Link them: Use `dep` MCP tool with `type: "discovered-from"`
|
|
26
26
|
- This maintains context and work history
|
|
27
27
|
|
|
28
28
|
## 5. Complete the Task
|
|
29
29
|
Close the issue when done:
|
|
30
|
-
- Via command: `/
|
|
30
|
+
- Via command: `/beads:close <id> "Completed: <summary>"`
|
|
31
31
|
- Via MCP tool: `close` with reason
|
|
32
32
|
|
|
33
33
|
## 6. Check What's Unblocked
|
|
34
34
|
After closing, check if other work became ready:
|
|
35
|
-
- Use `/
|
|
35
|
+
- Use `/beads:ready` to see newly unblocked tasks
|
|
36
36
|
- Start the cycle again
|
|
37
37
|
|
|
38
38
|
## Tips
|
|
@@ -43,12 +43,12 @@ After closing, check if other work became ready:
|
|
|
43
43
|
- **Git workflow**: After `git pull`, JSONL auto-imports if newer than DB
|
|
44
44
|
|
|
45
45
|
## Available Commands
|
|
46
|
-
- `/
|
|
47
|
-
- `/
|
|
48
|
-
- `/
|
|
49
|
-
- `/
|
|
50
|
-
- `/
|
|
51
|
-
- `/
|
|
46
|
+
- `/beads:ready` - Find unblocked work
|
|
47
|
+
- `/beads:create` - Create new issue
|
|
48
|
+
- `/beads:show` - Show issue details
|
|
49
|
+
- `/beads:update` - Update issue
|
|
50
|
+
- `/beads:close` - Close issue
|
|
51
|
+
- `/beads:workflow` - Show this guide (you are here!)
|
|
52
52
|
|
|
53
53
|
## MCP Tools Available
|
|
54
54
|
Use these via the beads MCP server:
|