brainclaw 0.19.7 → 0.19.11
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 +225 -126
- package/dist/cli.js +9 -3
- package/dist/commands/bootstrap.js +88 -3
- package/dist/commands/init.js +21 -0
- package/dist/commands/mcp.js +76 -3
- package/dist/core/bootstrap.js +945 -6
- package/dist/core/migration.js +6 -2
- package/dist/core/schema.js +97 -0
- package/docs/cli.md +26 -1
- package/docs/integrations/agents.md +42 -29
- package/docs/integrations/claude-code.md +4 -4
- package/docs/integrations/codex.md +5 -5
- package/docs/integrations/copilot.md +3 -2
- package/docs/integrations/cursor.md +4 -4
- package/docs/integrations/mcp.md +70 -24
- package/docs/integrations/overview.md +53 -40
- package/docs/mcp-schema-changelog.md +9 -0
- package/docs/product/positioning.md +17 -18
- package/docs/quickstart.md +102 -52
- package/package.json +7 -7
|
@@ -65,32 +65,31 @@ Local-first gives teams:
|
|
|
65
65
|
- Git history for shared project state
|
|
66
66
|
- compatibility with enterprise or offline environments
|
|
67
67
|
|
|
68
|
-
##
|
|
68
|
+
## License direction
|
|
69
69
|
|
|
70
|
-
brainclaw is published under the **Business Source License 1.1 (BSL 1.1)**.
|
|
70
|
+
Today, brainclaw is published under the **Business Source License 1.1 (BSL 1.1)**.
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
The direction after the closed beta is simpler:
|
|
73
73
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
| Personal use, open-source projects | Free |
|
|
77
|
-
| Internal team or company use | Free |
|
|
78
|
-
| Embedding brainclaw in a product or service you sell | Requires a commercial license |
|
|
79
|
-
| Competitive products that replicate brainclaw's core value | Requires a commercial license |
|
|
74
|
+
- the local-first brainclaw core is intended to move to MIT
|
|
75
|
+
- remote shared-memory, hosted collaboration, advanced dashboards, and related private add-ons will stay separate commercial products
|
|
80
76
|
|
|
81
|
-
|
|
77
|
+
The intended MIT core covers the local coordination layer:
|
|
82
78
|
|
|
83
|
-
|
|
79
|
+
- local project memory
|
|
80
|
+
- local MCP and CLI workflows
|
|
81
|
+
- onboarding and bootstrap
|
|
82
|
+
- plans, claims, handoffs, and runtime notes
|
|
83
|
+
- local agent integrations
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
The commercial side is meant to cover capabilities that go beyond the local-first core:
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
- shared memory through the cloud for agents working across machines
|
|
88
|
+
- hosted sync and collaboration services
|
|
89
|
+
- advanced dashboards
|
|
90
|
+
- private add-ons around those hosted features
|
|
88
91
|
|
|
89
|
-
The
|
|
90
|
-
|
|
91
|
-
### Commercial licensing
|
|
92
|
-
|
|
93
|
-
If your use case requires a commercial license, contact the project author. The intent is not to restrict legitimate internal use — it is to prevent competitive product embedding without a fair contribution back to the project.
|
|
92
|
+
The goal is not to ship a stripped-down teaser. The goal is to keep the public core complete and useful on its own, while keeping remote and hosted features in a separate product line.
|
|
94
93
|
|
|
95
94
|
## Positioning summary
|
|
96
95
|
|
package/docs/quickstart.md
CHANGED
|
@@ -1,30 +1,66 @@
|
|
|
1
1
|
# Quickstart
|
|
2
2
|
|
|
3
|
-
This guide
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
3
|
+
This guide is organized by entry path, because Brainclaw serves different surfaces with different roles.
|
|
4
|
+
|
|
5
|
+
Use this rule first:
|
|
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
|
|
10
|
+
|
|
11
|
+
## Important limitation for now
|
|
12
|
+
|
|
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
|
|
18
28
|
|
|
19
29
|
```bash
|
|
20
30
|
brainclaw setup --yes
|
|
21
31
|
brainclaw init
|
|
22
32
|
```
|
|
23
33
|
|
|
24
|
-
`setup` installs
|
|
25
|
-
If an AI coding agent is detected in the environment, brainclaw also writes to its native instruction file automatically.
|
|
34
|
+
`setup` installs machine-level prerequisites and agent integrations. `init` creates the workspace state, seeds stable identity, and prepares the project memory structure.
|
|
26
35
|
|
|
27
|
-
|
|
36
|
+
### Agent runtime pattern
|
|
37
|
+
|
|
38
|
+
After the workspace is initialized, the nominal flow is:
|
|
39
|
+
|
|
40
|
+
```text
|
|
41
|
+
bclaw_session_start -> open a session and return current board/context
|
|
42
|
+
bclaw_get_context -> fetch fresh prompt-ready context for the target path
|
|
43
|
+
bclaw_list_plans -> inspect active work
|
|
44
|
+
bclaw_claim -> claim scope before editing
|
|
45
|
+
bclaw_write_note -> record runtime observations
|
|
46
|
+
bclaw_session_end -> close session cleanly and hand work off
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
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.
|
|
50
|
+
|
|
51
|
+
## Path 2: CLI-Oriented Agent Or Fallback Workflow
|
|
52
|
+
|
|
53
|
+
Use this path when the agent does not have a good MCP integration yet, or when a human needs to drive the workflow directly.
|
|
54
|
+
|
|
55
|
+
### Bootstrap and inspect
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
brainclaw setup --yes
|
|
59
|
+
brainclaw init
|
|
60
|
+
brainclaw export --detect --write
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Record the first important facts
|
|
28
64
|
|
|
29
65
|
```bash
|
|
30
66
|
brainclaw memory create decision "OAuth migration now goes through auth-gateway" --tag auth
|
|
@@ -32,68 +68,82 @@ brainclaw memory create constraint "Payments module frozen until 2026-04-01" --t
|
|
|
32
68
|
brainclaw memory create trap "Checkout E2E tests are flaky on Windows" --severity high --tag tests
|
|
33
69
|
```
|
|
34
70
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
## 3. Create a shared plan
|
|
71
|
+
### Create and claim work
|
|
38
72
|
|
|
39
73
|
```bash
|
|
40
74
|
brainclaw plan create "Coordinate auth rollout" --priority high
|
|
41
|
-
brainclaw
|
|
75
|
+
brainclaw claim create "Take auth rollout" --scope src/auth/
|
|
42
76
|
```
|
|
43
77
|
|
|
44
|
-
|
|
78
|
+
### Refresh context before edits
|
|
45
79
|
|
|
46
80
|
```bash
|
|
47
|
-
brainclaw
|
|
48
|
-
brainclaw
|
|
81
|
+
brainclaw context --for src/auth/routes.ts --digest
|
|
82
|
+
brainclaw status
|
|
49
83
|
```
|
|
50
84
|
|
|
51
|
-
Claims reduce collisions, but they are not a substitute for isolated worktrees yet.
|
|
52
|
-
|
|
85
|
+
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.
|
|
86
|
+
|
|
87
|
+
## Path 3: Brownfield Onboarding
|
|
88
|
+
|
|
89
|
+
Use this path when you are adopting Brainclaw into an existing workspace and do not want to hand-author all memory from scratch.
|
|
53
90
|
|
|
54
|
-
|
|
91
|
+
### Build the initial bootstrap view
|
|
55
92
|
|
|
56
93
|
```bash
|
|
57
|
-
brainclaw
|
|
94
|
+
brainclaw setup --yes
|
|
95
|
+
brainclaw init
|
|
96
|
+
brainclaw bootstrap --json
|
|
58
97
|
```
|
|
59
98
|
|
|
60
|
-
|
|
99
|
+
### Fill the gaps
|
|
61
100
|
|
|
62
101
|
```bash
|
|
63
|
-
brainclaw
|
|
64
|
-
brainclaw
|
|
102
|
+
brainclaw bootstrap --interview --audience cli
|
|
103
|
+
brainclaw bootstrap --interview --audience ide_chat
|
|
65
104
|
```
|
|
66
105
|
|
|
67
|
-
Use
|
|
106
|
+
Use the returned question IDs to prepare a small JSON answers file when the interview needs to confirm durable memory:
|
|
107
|
+
|
|
108
|
+
```json
|
|
109
|
+
[
|
|
110
|
+
{
|
|
111
|
+
"question_id": "biq_example",
|
|
112
|
+
"response_items": ["Use agents sequentially in one checkout."],
|
|
113
|
+
"suggestions": []
|
|
114
|
+
}
|
|
115
|
+
]
|
|
116
|
+
```
|
|
68
117
|
|
|
69
|
-
|
|
118
|
+
Preview the enriched import proposal:
|
|
70
119
|
|
|
71
120
|
```bash
|
|
72
|
-
brainclaw
|
|
73
|
-
brainclaw export --format claude-md --write # writes CLAUDE.md and gitignores it by default
|
|
74
|
-
brainclaw export --format cursor-rules --write # writes .cursor/rules/brainclaw.md and gitignores it by default
|
|
75
|
-
brainclaw export --format claude-md --write --shared # only if you intentionally want to commit it
|
|
121
|
+
brainclaw bootstrap --answers-file ./bootstrap-answers.json --json
|
|
76
122
|
```
|
|
77
123
|
|
|
78
|
-
|
|
124
|
+
### Apply or rollback managed imports
|
|
79
125
|
|
|
80
126
|
```bash
|
|
81
|
-
brainclaw
|
|
82
|
-
brainclaw
|
|
127
|
+
brainclaw bootstrap --answers-file ./bootstrap-answers.json --apply
|
|
128
|
+
brainclaw bootstrap --uninstall
|
|
83
129
|
```
|
|
84
130
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
1. initialize the workspace
|
|
88
|
-
2. record 3–5 important decisions or traps
|
|
89
|
-
3. create one shared plan
|
|
90
|
-
4. use claims for touched folders
|
|
91
|
-
5. generate context before edits
|
|
92
|
-
6. hand off explicitly when switching between agents
|
|
131
|
+
Use this path when the repo already has native instruction files, partial docs, or conventions that Brainclaw should adopt selectively instead of replacing blindly.
|
|
93
132
|
|
|
94
|
-
##
|
|
133
|
+
## Recommended First Workflow
|
|
95
134
|
|
|
96
|
-
|
|
135
|
+
1. initialize the workspace
|
|
136
|
+
2. choose the correct entry path for your surface
|
|
137
|
+
3. record or import 3-5 high-signal facts
|
|
138
|
+
4. create one shared plan
|
|
139
|
+
5. claim scope before editing
|
|
140
|
+
6. refresh context before significant edits
|
|
141
|
+
7. hand off explicitly when switching between agents
|
|
142
|
+
|
|
143
|
+
## Next Reads
|
|
144
|
+
|
|
145
|
+
- [integrations/overview.md](integrations/overview.md) — integration model by surface
|
|
146
|
+
- [integrations/mcp.md](integrations/mcp.md) — nominal dynamic path for capable agents
|
|
147
|
+
- [cli.md](cli.md) — operator and fallback reference
|
|
97
148
|
- [concepts/memory.md](concepts/memory.md)
|
|
98
149
|
- [concepts/plans-and-claims.md](concepts/plans-and-claims.md)
|
|
99
|
-
- [integrations/overview.md](integrations/overview.md)
|
package/package.json
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "brainclaw",
|
|
3
|
-
"version": "0.19.
|
|
3
|
+
"version": "0.19.11",
|
|
4
4
|
"description": "Shared project memory for humans and coding agents.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"brainclaw": "dist/cli.js",
|
|
8
8
|
"bclaw": "dist/cli.js"
|
|
9
9
|
},
|
|
10
|
-
"files": [
|
|
11
|
-
"dist/**/*.js",
|
|
12
|
-
"docs/**/*.md",
|
|
13
|
-
"README.md",
|
|
14
|
-
"LICENSE"
|
|
15
|
-
],
|
|
10
|
+
"files": [
|
|
11
|
+
"dist/**/*.js",
|
|
12
|
+
"docs/**/*.md",
|
|
13
|
+
"README.md",
|
|
14
|
+
"LICENSE"
|
|
15
|
+
],
|
|
16
16
|
"scripts": {
|
|
17
17
|
"build": "tsc",
|
|
18
18
|
"dev": "tsc && node dist/cli.js",
|