brainclaw 0.19.12 → 0.20.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.
Files changed (40) hide show
  1. package/README.md +42 -11
  2. package/dist/cli.js +55 -1
  3. package/dist/commands/claude-desktop-extension.js +18 -0
  4. package/dist/commands/context.js +3 -1
  5. package/dist/commands/doctor.js +12 -5
  6. package/dist/commands/export.js +44 -0
  7. package/dist/commands/init.js +22 -6
  8. package/dist/commands/list-surface-tasks.js +39 -0
  9. package/dist/commands/mcp.js +86 -5
  10. package/dist/commands/reconcile.js +138 -0
  11. package/dist/commands/setup.js +19 -0
  12. package/dist/commands/status.js +17 -12
  13. package/dist/commands/surface-task-resource.js +35 -0
  14. package/dist/commands/surface-task.js +57 -0
  15. package/dist/commands/uninstall.js +145 -0
  16. package/dist/commands/update-surface-task.js +30 -0
  17. package/dist/core/agent-capability.js +184 -0
  18. package/dist/core/agent-context.js +24 -6
  19. package/dist/core/agent-files.js +18 -18
  20. package/dist/core/ai-surface-inventory.js +321 -0
  21. package/dist/core/ai-surface-tasks.js +40 -0
  22. package/dist/core/bootstrap.js +177 -0
  23. package/dist/core/claude-desktop-extension.js +224 -0
  24. package/dist/core/context.js +47 -24
  25. package/dist/core/ids.js +1 -0
  26. package/dist/core/instruction-templates.js +308 -0
  27. package/dist/core/io.js +1 -0
  28. package/dist/core/machine-profile.js +7 -1
  29. package/dist/core/migration.js +3 -1
  30. package/dist/core/schema.js +34 -0
  31. package/dist/core/setup-flow.js +191 -0
  32. package/dist/core/setup-state.js +30 -1
  33. package/dist/core/store-resolution.js +58 -0
  34. package/dist/core/workspace-projects.js +115 -0
  35. package/docs/architecture/project-refs.md +305 -0
  36. package/docs/cli.md +133 -1
  37. package/docs/integrations/agents.md +102 -150
  38. package/docs/integrations/overview.md +71 -45
  39. package/docs/quickstart.md +44 -111
  40. package/package.json +1 -1
@@ -1,182 +1,134 @@
1
- # Agent Integration Principles
2
-
3
- ## Core reality
4
-
5
- No agent should be assumed to obey a single instruction perfectly every time.
6
-
7
- That means brainclaw integration should not rely on only one mechanism such as:
8
-
9
- - a single instruction file
10
- - a single skill
11
- - a single startup command
12
-
13
- ## Better approach
14
-
15
- Use multiple points of contact:
16
-
17
- - lightweight system instructions
18
- - project-specific context retrieval through MCP when available
19
- - prompt-ready generated context
20
- - native agent files for local reminders
21
- - MCP tools for dynamic state
22
- - board and status views
23
- - workflow reminders around plans, claims, and handoffs
24
-
25
- ## Surface hierarchy
26
-
27
- The default order is:
28
-
29
- 1. MCP for live state
30
- 2. native agent files for local workflow guidance
31
- 3. readable files as fallback
32
- 4. CLI for setup, operator tasks, scripting, and fallback workflows
33
-
34
- This keeps dynamic state dynamic instead of trying to encode it permanently into static instructions.
35
-
36
- ## System instructions vs project instructions
37
-
38
- Keep these separate.
39
-
40
- ### System instructions
41
- How the agent should use brainclaw.
42
-
43
- Examples:
44
-
45
- - check workspace memory before significant changes
46
- - prefer MCP over manual CLI calls when MCP is available
47
- - bootstrap if the workspace is not initialized and the workflow allows it
48
- - respect file claims
49
- - update shared plan status when appropriate
50
-
51
- ### Project instructions
52
- What is true for the current workspace.
53
-
54
- Examples:
55
-
56
- - active constraints
57
- - recent decisions
58
- - known traps
59
- - current handoffs
60
- - relevant plan context
1
+ # Agent Integration
61
2
 
62
- ## Setting up agent integration
3
+ ## The problem brainclaw solves for agents
63
4
 
64
- ### Automatic detection
5
+ Coding agents are stateless. Each session starts from zero. They don't know:
65
6
 
66
- ```bash
67
- brainclaw init
68
- ```
69
-
70
- `setup` and `init` write the appropriate local agent config files for the detected integrations. Workspace-local generated files are also added to `.gitignore` automatically so agent-specific config does not pollute Git status.
7
+ - what other agents have been working on
8
+ - what files are being actively edited by someone else
9
+ - what decisions were made last week and why
10
+ - what traps to avoid in a specific part of the codebase
71
11
 
72
- ### Manual per-agent setup
12
+ Brainclaw gives every agent access to this shared context through a combination of surfaces adapted to what each agent can handle.
73
13
 
74
- ```bash
75
- brainclaw enable-agent claude-code
76
- brainclaw enable-agent cursor
77
- brainclaw enable-agent windsurf
78
- brainclaw enable-agent opencode
79
- brainclaw enable-agent antigravity
80
- ```
14
+ ## Multiple points of contact
81
15
 
82
- ### Export to a specific format
16
+ No single mechanism is enough. Agents don't always obey a single instruction file. They sometimes skip MCP calls. They forget between prompts.
83
17
 
84
- ```bash
85
- brainclaw export --format claude-md --write
86
- brainclaw export --format cursor-rules --write
87
- brainclaw export --format agents-md --write # Codex, OpenCode
88
- brainclaw export --format gemini-md --write # Antigravity / Gemini CLI
89
- brainclaw export --format claude-md --write --shared # only if you want the main instruction file versioned
90
- ```
91
-
92
- `--detect` auto-selects formats based on files found in the workspace:
18
+ That's why brainclaw uses every available surface:
93
19
 
94
- ```bash
95
- brainclaw export --detect --write
96
- ```
97
-
98
- By default, `--write` treats generated workspace files as local setup and adds them to `.gitignore`. `--shared` only keeps the main exported instruction file versionable; companion MCP/settings files remain local. OpenCode also gets a workspace MCP config in `opencode.json`. Antigravity/Gemini CLI gets a machine-local MCP config in `.gemini/antigravity/mcp_config.json` when `HOME` is available.
99
-
100
- If a repo already contains tracked local agent files from an older setup, `brainclaw session-start` warns at the beginning of work and `brainclaw doctor --fix-agent-ignore` can repair the missing `.gitignore` entries. Tracked files still need to be untracked manually with Git after the ignore rules are in place.
20
+ 1. **Instruction files** set the frame — "this project uses brainclaw, here's how"
21
+ 2. **Hooks** inject context automatically — the agent sees plans and claims without asking
22
+ 3. **MCP tools** provide on-demand access — the agent calls brainclaw when it needs more detail
23
+ 4. **Auto-approve** removes friction — no popup confirmation for each tool call
24
+ 5. **Skills/commands** give the developer a manual override force a context refresh when needed
101
25
 
102
- ## MCP server workflow
103
-
104
- The brainclaw MCP server exposes the dynamic Brainclaw workflow directly. For capable agents, this is the nominal runtime path.
26
+ The more surfaces are active, the more reliably the agent uses brainclaw.
105
27
 
106
- ### Starting the MCP server
28
+ ## What the instruction file contains
107
29
 
108
- ```bash
109
- brainclaw mcp
110
- ```
30
+ The instruction file (CLAUDE.md, .cursor/rules/, AGENTS.md, etc.) is the agent's first contact with brainclaw. Its content depends on the agent's capabilities:
111
31
 
112
- Most agents pick this up via their MCP config file (`.mcp.json`, `~/.cursor/mcp.json`, etc.). brainclaw writes these during `init`.
113
-
114
- ### Available MCP tools
115
-
116
- | Tool | Description |
117
- |------|-------------|
118
- | `bclaw_get_context` | Full workspace context (constraints, decisions, traps, plans, handoffs) |
119
- | `bclaw_get_agent_board` | Live plan + claim board |
120
- | `bclaw_session_start` | Start an agent session (registers identity) |
121
- | `bclaw_session_end` | End session, optionally auto-release claims |
122
- | `bclaw_claim` | Claim a file scope |
123
- | `bclaw_release_claim` | Release a claim |
124
- | `bclaw_create_candidate` | Create a plan item |
125
- | `bclaw_accept` / `bclaw_reject` | Accept or reject a plan candidate |
126
- | `bclaw_write_note` | Write a runtime note |
127
- | `bclaw_search` | Search memory entries |
128
- | `bclaw_read_handoff` | Read a handoff document |
129
- | `bclaw_bootstrap` | Initialize the workspace if not already done |
130
- | `bclaw_get_execution_context` | Get execution context (identity, claims, active plans) |
131
-
132
- ## Session lifecycle
133
-
134
- ### Starting a session
135
-
136
- ```bash
137
- brainclaw session-start --agent my-agent --model claude-opus-4-5
138
- ```
32
+ ### For agents with MCP and hooks (Claude Code)
139
33
 
140
- This registers the agent's identity and optionally records the model being used. Other agents can see active sessions in `list-claims` and `board`.
34
+ Short and focused:
35
+ - Why brainclaw matters for this project
36
+ - The session protocol (hooks handle the rest)
37
+ - Active constraints and instructions
38
+ - Version check reminder
141
39
 
142
- ### During the session
143
-
144
- For MCP-capable agents, prefer the MCP equivalents of these actions. The CLI examples below are the operator and fallback form of the same lifecycle.
40
+ ### For agents with MCP but no hooks (Cursor, Codex, OpenCode, etc.)
145
41
 
146
- ```bash
147
- brainclaw context --json # load fresh project state
148
- brainclaw claim list # check for conflicts
149
- brainclaw claim create "desc" --scope src/feature/
150
- brainclaw plan create "implement X" --estimate 60
151
- brainclaw plan update <id> --status in_progress
152
- ```
42
+ More directive:
43
+ - Same core sections as above, with stronger language ("REQUIRED", "MUST")
44
+ - The top 5 most critical traps (the agent won't see them otherwise)
45
+ - Explicit step-by-step protocol with all MCP calls listed
46
+
47
+ ### For agents without MCP (Copilot)
48
+
49
+ Full static context:
50
+ - All of the above
51
+ - Active plans with status and assignees
52
+ - All shared traps
53
+ - Recent architectural decisions
54
+
55
+ ## Setting up agent integration
153
56
 
154
- ### Ending the session
57
+ ### Automatic (recommended)
155
58
 
156
59
  ```bash
157
- brainclaw session-end --auto-release
60
+ brainclaw setup # machine-level: detects agents, creates global configs
61
+ brainclaw init # project-level: creates .brainclaw/, writes agent files
158
62
  ```
159
63
 
160
- This releases all active claims held by the current agent and updates plan statuses.
64
+ Or ask your coding agent to do it:
161
65
 
162
- ## Generated files are local-only
66
+ ```
67
+ "Install and initialize brainclaw in this project"
68
+ ```
163
69
 
164
- Agent config files generated by brainclaw — `CLAUDE.md`, `AGENTS.md`, `GEMINI.md`, `.cursor/rules/brainclaw.md`, `.windsurfrules`, `.github/copilot-instructions.md` are **not committed to Git**.
70
+ The agent can use `bclaw_setup` to walk through the process interactively.
165
71
 
166
- Each developer regenerates them locally from their own `.brainclaw/` store:
72
+ ### Per-agent manual setup
73
+
74
+ ```bash
75
+ brainclaw enable-agent claude-code
76
+ brainclaw enable-agent cursor
77
+ brainclaw export --format claude-md --write
78
+ brainclaw export --detect --write # auto-detect and write all formats
79
+ ```
80
+
81
+ ### Regenerating after changes
82
+
83
+ When brainclaw memory changes (new constraints, resolved traps, updated plans), regenerate instruction files:
167
84
 
168
85
  ```bash
169
86
  brainclaw export --detect --write
170
87
  ```
171
88
 
89
+ For agents without MCP (Copilot), this is especially important — the instruction file is their only source of project context.
90
+
91
+ ## Generated files are local
92
+
93
+ Agent config files generated by brainclaw are **not committed to Git**. Each developer regenerates them locally from the shared `.brainclaw/` store.
94
+
172
95
  This ensures:
173
- - no private project notes leak into the shared repo
174
- - each developer's local agent sees the right instructions for their setup
175
- - instructions stay in sync with the current brainclaw store, not a stale committed version
96
+ - No machine-specific traps leak into the shared repo
97
+ - Each developer's agent sees instructions tailored to their setup
98
+ - Instructions stay in sync with current memory, not a stale committed version
99
+
100
+ brainclaw adds all generated files to `.gitignore` automatically during init.
101
+
102
+ Exception: use `--shared` if you intentionally want the main instruction file (e.g., CLAUDE.md) versioned for the whole team.
103
+
104
+ ## Session lifecycle
105
+
106
+ ### Starting work
107
+
108
+ ```
109
+ bclaw_session_start → identify yourself, see the board
110
+ bclaw_get_context(target: "src/auth/") → load relevant memory
111
+ bclaw_get_execution_context → check for brainclaw updates
112
+ ```
113
+
114
+ ### During work
115
+
116
+ ```
117
+ bclaw_claim(scope: "src/auth/") → signal what you're editing
118
+ bclaw_write_note("Found a race condition in AuthService") → record observations
119
+ bclaw_create_plan("Fix race condition", estimate: 30) → track work
120
+ ```
121
+
122
+ ### Finishing work
123
+
124
+ ```
125
+ bclaw_session_end(auto_release: true) → release claims, update plans
126
+ ```
127
+
128
+ ### Plans and estimation
176
129
 
177
- brainclaw adds all generated files to `.gitignore` automatically during `init`.
130
+ Always estimate duration in minutes when creating a plan or step. When completing, report actual effort. This builds a calibration history that helps improve future estimates — agents are typically poor at estimation, and this feedback loop helps.
178
131
 
179
- ## Goal
132
+ ## Version awareness
180
133
 
181
- The goal is not perfect enforcement.
182
- The goal is to make brainclaw the natural path for fresh workspace context and coordination.
134
+ Agents should call `bclaw_get_execution_context` at session start. If a newer brainclaw version is available, it tells the agent, who can then inform the developer and suggest updating. Updates may include new features, new MCP tools, and improved coordination.
@@ -1,74 +1,100 @@
1
1
  # Integration Overview
2
2
 
3
- Brainclaw is designed to work with existing coding agents, not replace them.
3
+ Brainclaw works alongside your existing coding agents. It does not replace them — it gives them a shared memory and coordination layer they can all read from and write to.
4
4
 
5
- The key integration rule is simple:
5
+ ## How agents connect to brainclaw
6
6
 
7
- 1. use MCP for dynamic shared state when the agent supports it
8
- 2. use native agent files for local behavioral guidance
9
- 3. use the CLI for setup, operator workflows, scripting, and fallback access
7
+ Brainclaw reaches each agent through multiple surfaces. Not every agent supports every surface, and that's fine — brainclaw adapts what it writes based on what the agent can handle.
10
8
 
11
- ## Current Limitation
9
+ | Surface | What it does | When it activates |
10
+ |---|---|---|
11
+ | **MCP tools** | The agent calls brainclaw directly to read context, create plans, claim files, and coordinate. This is the richest integration. | During every prompt, when the agent decides to call a tool |
12
+ | **Instruction file** | A markdown file in the agent's native format that explains how to use brainclaw and lists active project constraints. | Read once at session start |
13
+ | **Hooks** | Brainclaw injects fresh context into the agent's prompt automatically, without the agent asking. | Every prompt (where supported) |
14
+ | **Auto-approve** | MCP tool calls are pre-approved so the agent doesn't have to ask the developer for permission each time. | Every MCP call (where supported) |
15
+ | **Skills / Commands** | A shortcut the developer can trigger manually to refresh brainclaw context. | On demand |
12
16
 
13
- For now, Brainclaw should be used for sequential multi-agent collaboration, not true parallel editing in the same checkout.
17
+ ## What goes where: core vs run
14
18
 
15
- One agent can hand work to another, and the next agent can recover good project context through shared memory, plans, claims, and handoffs. But without dedicated Git worktrees per agent/session, running several coding agents concurrently on the same project checkout is still risky and can create conflicts or unstable local state.
19
+ Instruction files contain **core** content things that don't change between prompts:
16
20
 
17
- ## Integration Surfaces
21
+ - Why brainclaw matters for this project
22
+ - The session protocol (what to call and when)
23
+ - Active constraints
24
+ - Project instructions
18
25
 
19
- brainclaw can integrate through several surfaces, but they do not have the same role.
26
+ Everything else is **run** content it changes constantly and belongs in the dynamic context delivered through MCP or hooks:
20
27
 
21
- | Surface | Role |
22
- |---|---|
23
- | **MCP tools** | primary dynamic access path for context, plans, claims, board views, and runtime writes |
24
- | **Native agent files** | local guidance in the agent's own surface: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md`, `.cursor/rules/brainclaw.md`, `.windsurfrules`, etc. |
25
- | **Readable files** | fallback readable state such as `.brainclaw/project.md` |
26
- | **CLI commands** | setup, scripting, release, inspection, and fallback workflows |
27
- | **System/project instructions** | static reminders about how Brainclaw should be used in this workspace |
28
+ - Active plans and their status
29
+ - Who is working where (claims)
30
+ - Known traps (scored by relevance to the current file)
31
+ - Handoffs between agents
32
+ - Runtime notes
28
33
 
29
- ## Recommended Pattern
34
+ This separation keeps instruction files clean and focused. The agent gets the stable rules from the file and the live state from MCP.
30
35
 
31
- A good default pattern is:
36
+ ## Three levels of integration
32
37
 
33
- 1. give the agent lightweight static instructions about how to use Brainclaw
34
- 2. let it retrieve fresh workspace state through MCP before significant edits
35
- 3. rely on plans, claims, and handoffs during execution
36
- 4. keep native files and readable project state available as fallback context
37
- 5. use hooks or repeated reminders where the host surface supports them
38
+ Brainclaw adapts its instruction file content based on what each agent can do:
38
39
 
39
- ## Native Files Are Support, Not The Live Source Of Truth
40
+ ### Full integration (MCP + hooks)
40
41
 
41
- Generated files such as `CLAUDE.md` or `.cursor/rules/brainclaw.md` are useful because they keep Brainclaw visible inside the agent surface already in use.
42
+ The agent gets dynamic context injected at every prompt. The instruction file can be lightweight just the protocol and constraints. Everything else comes through hooks and MCP calls.
42
43
 
43
- They are not meant to replace:
44
+ **Today:** Claude Code
44
45
 
45
- - fresh context retrieval
46
- - live board state
47
- - current claims
48
- - recent runtime notes
49
- - current handoffs
46
+ ### Standard integration (MCP, no hooks)
50
47
 
51
- For those, use MCP when available.
48
+ The agent can call brainclaw tools but doesn't get automatic context injection. The instruction file is more directive — it tells the agent it MUST call specific tools before working, and includes the most critical traps statically.
52
49
 
53
- ## Getting The Native File Written Automatically
50
+ **Today:** Cursor, Windsurf, Cline, Roo, Continue, OpenCode, Codex, Antigravity/Gemini CLI
54
51
 
55
- Run `brainclaw init` and Brainclaw will detect the current agent surface and write the appropriate local file automatically.
52
+ ### Limited integration (no MCP)
56
53
 
57
- That includes OpenCode (`AGENTS.md` + `opencode.json`) and Antigravity/Gemini CLI (`GEMINI.md` + machine-local MCP config) when those environments are present.
54
+ The agent cannot call brainclaw tools at all. The instruction file becomes the only source of project context, so it includes everything: constraints, traps, active plans, recent decisions.
58
55
 
59
- Or at any time:
56
+ **Today:** GitHub Copilot (uses skills as a partial workaround)
60
57
 
61
- ```bash
62
- brainclaw export --detect --write
63
- ```
58
+ ## Agent integration matrix
64
59
 
65
- By default, generated workspace files are treated as local setup and added to `.gitignore`. `--shared` should only be used when you intentionally want the main exported instruction file to be versioned.
60
+ | Agent | MCP | Instruction file | Hooks | Auto-approve | Skills |
61
+ |---|---|---|---|---|---|
62
+ | **Claude Code** | ✔ project + global | CLAUDE.md | ✔ pre-prompt + stop | ✔ permissions | ✔ /brainclaw |
63
+ | **Cursor** | ✔ global | .cursor/rules/ + MDC | ◐ alwaysApply MDC | — | — |
64
+ | **Windsurf** | ✔ global | .windsurfrules | ◐ session trigger | — | — |
65
+ | **Cline** | ✔ project | .clinerules/ | — | ✔ autoApprove | — |
66
+ | **Roo** | ✔ project | .roo/rules/ | — | ✔ alwaysAllow | — |
67
+ | **Continue** | ✔ both | .continue/rules/ | — | — | — |
68
+ | **OpenCode** | ✔ project | AGENTS.md | — | — | — |
69
+ | **Codex** | ✔ global | AGENTS.md | — | — | — |
70
+ | **Gemini CLI** | ✔ global | GEMINI.md | — | — | — |
71
+ | **Copilot** | — | .github/copilot-instructions.md | — | — | ✔ brainclaw-context |
66
72
 
67
- ## Choose Your Next Page
73
+ **Legend:** = fully supported, ◐ = partial (static trigger, not dynamic injection), — = not available
68
74
 
69
- - [mcp.md](mcp.md) the nominal path for capable agents
70
- - [agents.md](agents.md) — integration principles that apply to every agent
75
+ ## Why maximum integration by default
76
+
77
+ Without active pressure, agents ignore brainclaw. This is a consistent finding from real usage: if brainclaw only declares an MCP server and doesn't push the agent to use it, the agent never calls it.
78
+
79
+ That's why brainclaw activates **all available surfaces** by default during setup:
80
+
81
+ - The MCP server and instruction file are always configured (non-negotiable)
82
+ - Auto-approve and hooks are enabled where supported (opt-out possible)
83
+ - The instruction file includes a "why this matters" section so the agent understands why it should care
84
+
85
+ The developer can dial back individual surfaces if needed, but the default is full integration because that's what works.
86
+
87
+ ## Sequential collaboration, not parallel editing
88
+
89
+ For now, brainclaw works best when one agent works at a time in a given checkout. The next agent can pick up where the previous one stopped, using shared plans, claims, handoffs, and memory.
90
+
91
+ Running multiple agents in parallel on the same checkout will create conflicts. Git worktree isolation per agent is planned but not yet available.
92
+
93
+ ## Next reads
94
+
95
+ - [mcp.md](mcp.md) — the dynamic runtime path for capable agents
96
+ - [agents.md](agents.md) — integration principles and setup details
71
97
  - [claude-code.md](claude-code.md)
72
- - [codex.md](codex.md)
73
98
  - [cursor.md](cursor.md)
99
+ - [codex.md](codex.md)
74
100
  - [copilot.md](copilot.md)
@@ -1,152 +1,85 @@
1
1
  # Quickstart
2
2
 
3
- This guide is organized by entry path, because Brainclaw serves different surfaces with different roles.
3
+ ## The fastest way to start
4
4
 
5
- Use this rule first:
5
+ Ask your coding agent:
6
6
 
7
- - capable agent with MCP support: prefer MCP for dynamic state
8
- - agent surface driven mainly by local instruction files: use generated native files plus CLI fallback
9
- - human operator or maintainer: use the CLI directly
7
+ > "Install brainclaw and initialize it in this project."
10
8
 
11
- ## Important limitation for now
9
+ The agent will run `brainclaw setup` and `brainclaw init`, detect your environment, write the right config files, and activate MCP. After reloading, brainclaw tools become available.
12
10
 
13
- Do not run multiple coding agents in parallel on the same project checkout yet.
14
-
15
- Brainclaw is already useful for sequential collaboration: one agent can pick up where another stopped, inspect shared context, and continue from explicit plans, claims, traps, and handoffs. But until Brainclaw supports dedicated Git worktrees per agent/session, parallel edits in the same checkout are still likely to create more Git and workspace problems than they solve.
16
-
17
- For now, prefer:
18
-
19
- 1. one active editing agent per checkout
20
- 2. explicit handoffs between agents
21
- 3. claims and context to keep continuity between sessions
22
-
23
- ## Path 1: Agent-First With MCP
24
-
25
- Use this path when the agent can call Brainclaw through MCP.
26
-
27
- ### Operator bootstrap
11
+ If you prefer doing it manually:
28
12
 
29
13
  ```bash
30
- brainclaw setup --yes
14
+ npm install -g brainclaw
31
15
  brainclaw init
32
16
  ```
33
17
 
34
- `setup` installs machine-level prerequisites and agent integrations. `init` creates the workspace state, seeds stable identity, and prepares the project memory structure.
35
-
36
- ### Agent runtime pattern
18
+ `init` creates the user store if needed (no separate `setup` step required), initializes the project, detects your agent, and writes all integration files.
37
19
 
38
- After the workspace is initialized, the nominal flow is:
20
+ ## What happens after init
39
21
 
40
- ```text
41
- bclaw_session_start -> open a session and return current board/context
42
- bclaw_get_execution_context -> inspect local tooling and notice package updates
43
- bclaw_get_context -> fetch fresh prompt-ready context for the target path
44
- bclaw_list_plans -> inspect active work
45
- bclaw_claim -> claim scope before editing
46
- bclaw_write_note -> record runtime observations
47
- bclaw_session_end -> close session cleanly and hand work off
48
- ```
22
+ Once initialized, your agent can:
49
23
 
50
- Use native agent files such as `AGENTS.md`, `CLAUDE.md`, or Cursor rules as local workflow guidance, not as the only source of live state.
24
+ 1. **See project context** constraints, decisions, traps, plans, handoffs
25
+ 2. **Coordinate with other agents** — claim files before editing, check who's working where
26
+ 3. **Build shared memory** — record observations, create plans, track work
27
+ 4. **Resume across sessions** — the next agent (or the same one tomorrow) picks up where you left off
51
28
 
52
- Unless the project overrides `brainclaw_update_source`, `bclaw_get_execution_context` checks the public npm `latest` channel so the agent can notice when a newer Brainclaw release is available.
29
+ ## For agents with MCP (most agents)
53
30
 
54
- ## Path 2: CLI-Oriented Agent Or Fallback Workflow
31
+ This is the primary path. The agent calls brainclaw tools directly.
55
32
 
56
- Use this path when the agent does not have a good MCP integration yet, or when a human needs to drive the workflow directly.
57
-
58
- ### Bootstrap and inspect
59
-
60
- ```bash
61
- brainclaw setup --yes
62
- brainclaw init
63
- brainclaw export --detect --write
33
+ ```text
34
+ bclaw_session_start → identify yourself, see the board
35
+ bclaw_get_context → load relevant memory for your target scope
36
+ bclaw_claim → signal what you're about to edit
37
+ bclaw_write_note → record observations during work
38
+ bclaw_session_end → clean up claims and update plans
64
39
  ```
65
40
 
66
- ### Record the first important facts
41
+ Instruction files like `CLAUDE.md` or `.cursor/rules/brainclaw.md` provide the protocol and constraints. The live state (plans, claims, traps) comes through MCP.
67
42
 
68
- ```bash
69
- brainclaw memory create decision "OAuth migration now goes through auth-gateway" --tag auth
70
- brainclaw memory create constraint "Payments module frozen until 2026-04-01" --tag payments
71
- brainclaw memory create trap "Checkout E2E tests are flaky on Windows" --severity high --tag tests
72
- ```
43
+ ## For agents without MCP (Copilot)
73
44
 
74
- ### Create and claim work
45
+ The instruction file (`.github/copilot-instructions.md`) contains everything: constraints, active plans, traps, and decisions. Use the brainclaw-context skill to refresh.
75
46
 
76
- ```bash
77
- brainclaw plan create "Coordinate auth rollout" --priority high
78
- brainclaw claim create "Take auth rollout" --scope src/auth/
79
- ```
80
-
81
- ### Refresh context before edits
47
+ Regenerate the instruction file when project memory changes:
82
48
 
83
49
  ```bash
84
- brainclaw context --for src/auth/routes.ts --digest
85
- brainclaw status
50
+ brainclaw export --detect --write
86
51
  ```
87
52
 
88
- Claims reduce collisions, but they are not a substitute for isolated worktrees yet. Use them mainly to coordinate sequential work or human/agent awareness in the same repo.
89
-
90
- ## Path 3: Brownfield Onboarding
91
-
92
- Use this path when you are adopting Brainclaw into an existing workspace and do not want to hand-author all memory from scratch.
93
-
94
- ### Build the initial bootstrap view
95
-
96
- ```bash
97
- brainclaw setup --yes
98
- brainclaw init
99
- brainclaw bootstrap --json
100
- ```
53
+ ## Onboarding an existing project
101
54
 
102
- ### Fill the gaps
55
+ If the repo already has code, brainclaw can extract context from it:
103
56
 
104
57
  ```bash
105
- brainclaw bootstrap --interview --audience cli
106
- brainclaw bootstrap --interview --audience ide_chat
107
- ```
108
-
109
- Use the returned question IDs to prepare a small JSON answers file when the interview needs to confirm durable memory:
110
-
111
- ```json
112
- [
113
- {
114
- "question_id": "biq_example",
115
- "response_items": ["Use agents sequentially in one checkout."],
116
- "suggestions": []
117
- }
118
- ]
58
+ brainclaw bootstrap --json # see what brainclaw detected
59
+ brainclaw bootstrap --apply # import into memory
119
60
  ```
120
61
 
121
- Preview the enriched import proposal:
62
+ Or let your agent drive the conversation it can call `bclaw_bootstrap`, review the detected signals, ask you about gaps, and structure the results into brainclaw memory.
122
63
 
123
- ```bash
124
- brainclaw bootstrap --answers-file ./bootstrap-answers.json --json
125
- ```
64
+ ## Desktop AI surfaces
126
65
 
127
- ### Apply or rollback managed imports
66
+ brainclaw can also track work for desktop AI tools on your machine (ChatGPT Desktop, Claude Desktop, Gemini CLI) as a project-scoped task queue:
128
67
 
129
68
  ```bash
130
- brainclaw bootstrap --answers-file ./bootstrap-answers.json --apply
131
- brainclaw bootstrap --uninstall
69
+ brainclaw surface-task create "Generate hero visual" --target chatgpt --kind visual_asset
70
+ brainclaw surface-task list
132
71
  ```
133
72
 
134
- Use this path when the repo already has native instruction files, partial docs, or conventions that Brainclaw should adopt selectively instead of replacing blindly.
73
+ This keeps non-code work visible to the project without overloading the active coding agent.
135
74
 
136
- ## Recommended First Workflow
75
+ ## Important: one agent at a time
137
76
 
138
- 1. initialize the workspace
139
- 2. choose the correct entry path for your surface
140
- 3. record or import 3-5 high-signal facts
141
- 4. create one shared plan
142
- 5. claim scope before editing
143
- 6. refresh context before significant edits
144
- 7. hand off explicitly when switching between agents
77
+ For now, use brainclaw for sequential collaboration. One agent works, finishes, and the next one picks up from shared context. Running multiple agents in parallel on the same checkout will cause conflicts.
145
78
 
146
- ## Next Reads
79
+ ## Next reads
147
80
 
148
- - [integrations/overview.md](integrations/overview.md) — integration model by surface
149
- - [integrations/mcp.md](integrations/mcp.md) — nominal dynamic path for capable agents
150
- - [cli.md](cli.md) — operator and fallback reference
151
- - [concepts/memory.md](concepts/memory.md)
152
- - [concepts/plans-and-claims.md](concepts/plans-and-claims.md)
81
+ - [integrations/overview.md](integrations/overview.md) — how brainclaw adapts to each agent
82
+ - [integrations/mcp.md](integrations/mcp.md) — the dynamic runtime path
83
+ - [concepts/memory.md](concepts/memory.md) — what project memory includes
84
+ - [concepts/plans-and-claims.md](concepts/plans-and-claims.md) — coordination layer
85
+ - [cli.md](cli.md) — full CLI reference
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "brainclaw",
3
- "version": "0.19.12",
3
+ "version": "0.20.0",
4
4
  "description": "Shared project memory for humans and coding agents.",
5
5
  "type": "module",
6
6
  "bin": {