opencode-beads 0.5.3 → 0.5.5
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 +2 -1
- package/package.json +1 -1
- package/vendor/agents/task-agent.md +3 -2
- package/vendor/commands/audit.md +1 -1
- package/vendor/commands/dep.md +1 -1
- package/vendor/commands/epic.md +2 -1
- package/vendor/commands/export.md +5 -8
- package/vendor/commands/import.md +2 -2
- package/vendor/commands/ready.md +1 -1
- package/vendor/commands/restore.md +3 -4
- package/vendor/commands/sync.md +9 -46
- package/vendor/commands/workflow.md +3 -4
package/README.md
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
> To minimize maintenance, this plugin defers to beads and limits its scope to bug fixes and syncing upstream vendor plugin content. Feature requests and additional customization are generally out of scope.
|
|
9
9
|
>
|
|
10
10
|
> If you want to customize behavior, the plugin surface area is small — forking or copying it locally is encouraged.
|
|
11
|
+
|
|
11
12
|
## Installation
|
|
12
13
|
|
|
13
14
|
Install the beads CLI:
|
|
@@ -32,7 +33,7 @@ Optionally, pin to a specific version for stability:
|
|
|
32
33
|
|
|
33
34
|
```json
|
|
34
35
|
{
|
|
35
|
-
"plugin": ["opencode-beads@0.5.
|
|
36
|
+
"plugin": ["opencode-beads@0.5.5"]
|
|
36
37
|
}
|
|
37
38
|
```
|
|
38
39
|
|
package/package.json
CHANGED
|
@@ -13,7 +13,7 @@ You are a task-completion agent for beads. Your goal is to find ready work and c
|
|
|
13
13
|
|
|
14
14
|
2. **Claim the Task**
|
|
15
15
|
- Use the `show` tool to get full task details
|
|
16
|
-
- Use the `
|
|
16
|
+
- Use the `claim` tool for atomic start-work semantics
|
|
17
17
|
- Report what you're working on
|
|
18
18
|
|
|
19
19
|
3. **Execute the Task**
|
|
@@ -39,7 +39,7 @@ You are a task-completion agent for beads. Your goal is to find ready work and c
|
|
|
39
39
|
|
|
40
40
|
# Important Guidelines
|
|
41
41
|
|
|
42
|
-
- Always claim before working (MCP:
|
|
42
|
+
- Always claim before working (MCP: `claim`; CLI: `--claim`) and close when done
|
|
43
43
|
- Link discovered work with `discovered-from` dependencies
|
|
44
44
|
- Don't close issues unless work is actually complete
|
|
45
45
|
- If blocked, use `update` to set status to `blocked` and explain why
|
|
@@ -50,6 +50,7 @@ You are a task-completion agent for beads. Your goal is to find ready work and c
|
|
|
50
50
|
Via beads MCP server:
|
|
51
51
|
- `ready` - Find unblocked tasks
|
|
52
52
|
- `show` - Get task details
|
|
53
|
+
- `claim` - Atomically claim task for work
|
|
53
54
|
- `update` - Update task status/fields
|
|
54
55
|
- `create` - Create new issues
|
|
55
56
|
- `dep` - Manage dependencies
|
package/vendor/commands/audit.md
CHANGED
|
@@ -23,6 +23,6 @@ Each line is one event. Labeling is done by appending a new `"label"` event refe
|
|
|
23
23
|
## Notes
|
|
24
24
|
|
|
25
25
|
- Audit entries are **append-only** (no in-place edits).
|
|
26
|
-
- `bd sync` includes `.beads/interactions.jsonl` in the commit allowlist
|
|
26
|
+
- `bd sync` includes `.beads/interactions.jsonl` in the commit allowlist.
|
|
27
27
|
|
|
28
28
|
|
package/vendor/commands/dep.md
CHANGED
|
@@ -71,7 +71,7 @@ The diagram colors are determined by your Mermaid theme (default, dark, forest,
|
|
|
71
71
|
|
|
72
72
|
## Examples
|
|
73
73
|
|
|
74
|
-
- `bd dep add bd-10 bd-20 --type blocks`: bd-10 blocks bd-
|
|
74
|
+
- `bd dep add bd-10 bd-20 --type blocks`: bd-10 depends on bd-20 (bd-20 blocks bd-10)
|
|
75
75
|
- `bd dep tree bd-20`: Show what blocks bd-20 (dependency tree going UP)
|
|
76
76
|
- `bd dep tree bd-1 --reverse`: Show what was discovered from bd-1 (dependent tree going DOWN)
|
|
77
77
|
- `bd dep tree bd-1 --reverse --max-depth 3`: Show discovery tree with depth limit
|
package/vendor/commands/epic.md
CHANGED
|
@@ -19,7 +19,8 @@ Manage epics (large features composed of multiple issues).
|
|
|
19
19
|
## Epic Workflow
|
|
20
20
|
|
|
21
21
|
1. Create epic: `bd create "Large Feature" -t epic -p 1`
|
|
22
|
-
2. Link subtasks: `bd dep add bd-
|
|
22
|
+
2. Link subtasks: `bd dep add bd-20 bd-10 --type parent-child` (task bd-20 is child of epic bd-10)
|
|
23
|
+
- Or at creation: `bd create "Subtask title" -t task --parent bd-10`
|
|
23
24
|
3. Track progress: `bd epic status`
|
|
24
25
|
4. Auto-close when done: `bd epic close-eligible`
|
|
25
26
|
|
|
@@ -13,12 +13,9 @@ Export all issues to JSON Lines format (one JSON object per line).
|
|
|
13
13
|
|
|
14
14
|
Issues are sorted by ID for consistent diffs, making git diffs readable.
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## When to Use
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
-
|
|
22
|
-
- Backup
|
|
23
|
-
- Sharing issues between repositories
|
|
24
|
-
- Data migration
|
|
18
|
+
Dolt is the primary storage backend, so manual export is rarely needed. Use `bd export` when you need:
|
|
19
|
+
- A JSONL snapshot for backup
|
|
20
|
+
- Data migration to another system
|
|
21
|
+
- Sharing issues outside the Dolt workflow
|
|
@@ -26,9 +26,9 @@ bd import -i issues.jsonl --dry-run
|
|
|
26
26
|
# Shows: new issues, updates, exact matches
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## When to Use
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Dolt is the primary storage backend, so manual import is rarely needed. Use `bd import` when you need to load data from an external JSONL file or migrate from a legacy JSONL-based setup.
|
|
32
32
|
|
|
33
33
|
## Options
|
|
34
34
|
|
package/vendor/commands/ready.md
CHANGED
|
@@ -10,6 +10,6 @@ Call the `ready` tool to get a list of unblocked issues. Then present them to th
|
|
|
10
10
|
- Priority
|
|
11
11
|
- Issue type
|
|
12
12
|
|
|
13
|
-
If there are ready tasks, ask the user which one they'd like to work on. If they choose one, use the `
|
|
13
|
+
If there are ready tasks, ask the user which one they'd like to work on. If they choose one, use the `claim` tool to start work atomically.
|
|
14
14
|
|
|
15
15
|
If there are no ready tasks, suggest checking `blocked` issues or creating a new issue with the `create` tool.
|
|
@@ -8,10 +8,9 @@ Restore full history of a compacted issue from git version control.
|
|
|
8
8
|
When an issue is compacted, the git commit hash is saved. This command:
|
|
9
9
|
|
|
10
10
|
1. Reads the compacted_at_commit from the database
|
|
11
|
-
2.
|
|
12
|
-
3.
|
|
13
|
-
4.
|
|
14
|
-
5. Returns to the current git state
|
|
11
|
+
2. Retrieves the full issue from Dolt history at that point
|
|
12
|
+
3. Displays the full issue history (description, events, etc.)
|
|
13
|
+
4. Returns to the current state
|
|
15
14
|
|
|
16
15
|
## Usage
|
|
17
16
|
|
package/vendor/commands/sync.md
CHANGED
|
@@ -1,54 +1,17 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: Synchronize issues
|
|
3
|
-
argument-hint:
|
|
2
|
+
description: Synchronize issues (deprecated — use bd dolt push/pull)
|
|
3
|
+
argument-hint: (deprecated)
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
`bd sync` is **deprecated** and is now a no-op.
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Use Dolt commands instead
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
5. Push local commits to remote
|
|
15
|
-
|
|
16
|
-
Wraps the entire git-based sync workflow for multi-device use.
|
|
17
|
-
|
|
18
|
-
## Usage
|
|
19
|
-
|
|
20
|
-
- **Basic sync**: `bd sync`
|
|
21
|
-
- **Preview**: `bd sync --dry-run`
|
|
22
|
-
- **Custom message**: `bd sync --message "Closed sprint issues"`
|
|
23
|
-
- **Pull only**: `bd sync --no-push`
|
|
24
|
-
- **Push only**: `bd sync --no-pull`
|
|
25
|
-
- **Flush only**: `bd sync --flush-only` (export to JSONL without git operations)
|
|
26
|
-
- **Import only**: `bd sync --import-only` (import from JSONL without git operations)
|
|
27
|
-
|
|
28
|
-
## Separate Branch Workflow
|
|
29
|
-
|
|
30
|
-
When using a separate sync branch (configured via `sync.branch`), additional commands are available:
|
|
31
|
-
|
|
32
|
-
- **Check status**: `bd sync --status` - Show diff between sync branch and main
|
|
33
|
-
- **Merge to main**: `bd sync --merge` - Merge sync branch back to main branch
|
|
34
|
-
- **Preview merge**: `bd sync --merge --dry-run` - Preview what would be merged
|
|
35
|
-
|
|
36
|
-
### Merge Workflow
|
|
37
|
-
|
|
38
|
-
When working with a protected main branch and separate sync branch:
|
|
39
|
-
|
|
40
|
-
1. Beads commits go to the sync branch (e.g., `beads-metadata`)
|
|
41
|
-
2. Use `bd sync --status` to review pending changes
|
|
42
|
-
3. When ready, use `bd sync --merge` to merge back to main
|
|
43
|
-
4. After merge, run `bd import` to update the database
|
|
44
|
-
5. Run `bd sync` to push changes to remote
|
|
45
|
-
|
|
46
|
-
The merge command includes safety checks:
|
|
47
|
-
- Verifies you're not on the sync branch
|
|
48
|
-
- Checks for uncommitted changes in working tree
|
|
49
|
-
- Detects and reports merge conflicts with resolution steps
|
|
50
|
-
- Uses `--no-ff` to create a merge commit for clear history
|
|
10
|
+
- **Push to remote**: `bd dolt push`
|
|
11
|
+
- **Pull from remote**: `bd dolt pull`
|
|
12
|
+
- **Commit pending changes**: `bd dolt commit`
|
|
13
|
+
- **Check connection**: `bd dolt show`
|
|
51
14
|
|
|
52
15
|
## Note
|
|
53
16
|
|
|
54
|
-
Most users should rely on the
|
|
17
|
+
Most users should rely on the Dolt server's automatic sync (with `dolt.auto-commit` enabled) instead of running manual sync commands.
|
|
@@ -14,7 +14,7 @@ Use `/beads:ready` or the `ready` MCP tool to see tasks with no blockers.
|
|
|
14
14
|
## 2. Claim Your Task
|
|
15
15
|
Claim the issue atomically (assignee + `in_progress` in one step):
|
|
16
16
|
- Via command: `/beads:update <id> --claim`
|
|
17
|
-
- Via MCP tool: `
|
|
17
|
+
- Via MCP tool: `claim` with `issue_id: "<id>"`
|
|
18
18
|
|
|
19
19
|
## 3. Work on It
|
|
20
20
|
Implement, test, and document the feature or fix.
|
|
@@ -39,8 +39,7 @@ After closing, check if other work became ready:
|
|
|
39
39
|
- **Priority levels**: 0=critical, 1=high, 2=medium, 3=low, 4=backlog
|
|
40
40
|
- **Issue types**: bug, feature, task, epic, chore
|
|
41
41
|
- **Dependencies**: Use `blocks` for hard dependencies, `related` for soft links
|
|
42
|
-
- **Auto-sync**: Changes
|
|
43
|
-
- **Git workflow**: After `git pull`, JSONL auto-imports if newer than DB
|
|
42
|
+
- **Auto-sync**: Changes are stored in Dolt and synced via `bd sync`
|
|
44
43
|
|
|
45
44
|
## Available Commands
|
|
46
45
|
- `/beads:ready` - Find unblocked work
|
|
@@ -52,7 +51,7 @@ After closing, check if other work became ready:
|
|
|
52
51
|
|
|
53
52
|
## MCP Tools Available
|
|
54
53
|
Use these via the beads MCP server:
|
|
55
|
-
- `ready`, `list`, `show`, `create`, `update`, `close`
|
|
54
|
+
- `ready`, `list`, `show`, `create`, `claim`, `update`, `close`
|
|
56
55
|
- `dep` (manage dependencies), `blocked`, `stats`
|
|
57
56
|
- `init` (initialize bd in a project)
|
|
58
57
|
|