@andespindola/brainlink 0.1.0-beta.8 → 0.1.0-beta.81
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/AGENTS.md +8 -5
- package/CHANGELOG.md +58 -2
- package/CONTRIBUTING.md +2 -2
- package/COPYRIGHT.md +5 -0
- package/README.md +266 -20
- package/SECURITY.md +1 -1
- package/dist/application/add-note.js +62 -13
- package/dist/application/analyze-vault.js +95 -8
- package/dist/application/build-context.js +56 -1
- package/dist/application/dedupe-notes.js +226 -0
- package/dist/application/frontend/client-css.js +138 -103
- package/dist/application/frontend/client-html.js +47 -41
- package/dist/application/frontend/client-js.js +2449 -156
- package/dist/application/frontend/client-worker-js.js +66 -0
- package/dist/application/get-graph-layout.js +18 -6
- package/dist/application/get-graph-node.js +12 -0
- package/dist/application/get-graph-summary.js +12 -0
- package/dist/application/get-graph.js +3 -3
- package/dist/application/import-legacy-sqlite.js +296 -0
- package/dist/application/index-vault.js +252 -19
- package/dist/application/list-agents.js +3 -3
- package/dist/application/list-links.js +5 -5
- package/dist/application/migrate-vault.js +46 -16
- package/dist/application/offline-pack-backup.js +44 -0
- package/dist/application/search-graph-node-ids.js +12 -0
- package/dist/application/search-knowledge.js +75 -5
- package/dist/application/server/routes.js +102 -1
- package/dist/application/start-server.js +75 -4
- package/dist/application/watch-vault.js +23 -2
- package/dist/benchmarks/large-vault.js +1 -1
- package/dist/cli/commands/agent-commands.js +419 -0
- package/dist/cli/commands/config-commands.js +167 -0
- package/dist/cli/commands/read-commands.js +25 -8
- package/dist/cli/commands/write-commands.js +973 -10
- package/dist/cli/main.js +4 -0
- package/dist/cli/runtime.js +5 -2
- package/dist/domain/context.js +53 -11
- package/dist/domain/embeddings.js +2 -1
- package/dist/domain/graph-layout.js +67 -16
- package/dist/domain/markdown.js +36 -4
- package/dist/domain/middle-out.js +18 -0
- package/dist/infrastructure/config.js +132 -8
- package/dist/infrastructure/file-index.js +358 -0
- package/dist/infrastructure/file-system-vault.js +15 -0
- package/dist/infrastructure/index-state.js +56 -0
- package/dist/infrastructure/paths.js +9 -1
- package/dist/infrastructure/private-pack-codec.js +134 -0
- package/dist/infrastructure/search-packs.js +452 -0
- package/dist/infrastructure/session-state.js +172 -0
- package/dist/mcp/main.js +11 -3
- package/dist/mcp/server.js +27 -2
- package/dist/mcp/startup.js +35 -0
- package/dist/mcp/tools.js +633 -19
- package/docs/AGENT_USAGE.md +177 -15
- package/docs/ARCHITECTURE.md +37 -26
- package/docs/QUICKSTART.md +111 -0
- package/package.json +6 -4
- package/dist/infrastructure/sqlite/document-writer.js +0 -51
- package/dist/infrastructure/sqlite/graph-reader.js +0 -120
- package/dist/infrastructure/sqlite/schema.js +0 -111
- package/dist/infrastructure/sqlite/search-reader.js +0 -156
- package/dist/infrastructure/sqlite/types.js +0 -1
- package/dist/infrastructure/sqlite-index.js +0 -25
package/docs/AGENT_USAGE.md
CHANGED
|
@@ -18,7 +18,7 @@ The correct dependency direction is:
|
|
|
18
18
|
agent -> Brainlink CLI -> Markdown vault + derived index
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Agents should never depend on
|
|
21
|
+
Agents should never depend on internal index persistence files as a public API.
|
|
22
22
|
|
|
23
23
|
The installed CLI exposes two equivalent binaries:
|
|
24
24
|
|
|
@@ -39,9 +39,21 @@ $HOME/.brainlink/vault
|
|
|
39
39
|
|
|
40
40
|
`blink server` follows the same rule, so it serves the default Brainlink vault instead of the current working directory.
|
|
41
41
|
|
|
42
|
-
Use `--vault <path>` for a one-off custom vault, or set `vault` in
|
|
42
|
+
Use `--vault <path>` for a one-off custom vault, or set `vault` in config for a persistent default.
|
|
43
|
+
Configuration precedence is:
|
|
44
|
+
|
|
45
|
+
1. global: `$BRAINLINK_HOME/brainlink.config.json` (or `$HOME/.brainlink/brainlink.config.json`)
|
|
46
|
+
2. local: `./brainlink.config.json`
|
|
47
|
+
3. local legacy: `./.brainlink.json`
|
|
48
|
+
|
|
49
|
+
Set `BRAINLINK_HOME` when the whole Brainlink home directory should live somewhere else.
|
|
50
|
+
|
|
51
|
+
Use `blink config where` and `blink config doctor` to inspect active paths and effective source.
|
|
43
52
|
|
|
44
53
|
You can also set `defaultAgent` in `brainlink.config.json` / `.brainlink.json` (for example `"defaultAgent": "coding-agent"`). When set, CLI commands and MCP calls reuse it when `--agent`/`agent` is not passed.
|
|
54
|
+
You can set `agentProfiles` to define per-agent defaults for `defaultSearchMode`, `defaultSearchLimit` and `defaultContextTokens`.
|
|
55
|
+
You can tune search-pack compression with `searchPack.rowChunkSize`, `searchPack.compressionLevel` and `searchPack.useDictionary`.
|
|
56
|
+
Guardrails for benchmark acceptance are configured with `searchPack.guardrailMinSavingsPercent` and `searchPack.guardrailMaxLatencyRegressionPercent`.
|
|
45
57
|
|
|
46
58
|
`autoIndexOnWrite` (default: `true`) controls whether `add` and MCP write tools index right after writing.
|
|
47
59
|
|
|
@@ -170,16 +182,16 @@ Required write behavior:
|
|
|
170
182
|
Good linked note:
|
|
171
183
|
|
|
172
184
|
```bash
|
|
173
|
-
blink add "
|
|
185
|
+
blink add "Index Rebuild" \
|
|
174
186
|
--agent coding-agent \
|
|
175
|
-
--content "
|
|
187
|
+
--content "Derived index artifacts are rebuildable and disposable. Related: [[Architecture]], [[Agent Namespaces]]. #index #architecture #decision"
|
|
176
188
|
blink validate --agent coding-agent
|
|
177
189
|
```
|
|
178
190
|
|
|
179
191
|
Poor disconnected note:
|
|
180
192
|
|
|
181
193
|
```bash
|
|
182
|
-
blink add "
|
|
194
|
+
blink add "Index Rebuild" \
|
|
183
195
|
--agent coding-agent \
|
|
184
196
|
--content "We rebuild old indexes now."
|
|
185
197
|
```
|
|
@@ -246,7 +258,7 @@ cp docs/templates/agent-note-template.md /tmp/agent-note.md
|
|
|
246
258
|
When using MCP, use this compact sequence for the same memory discipline:
|
|
247
259
|
|
|
248
260
|
1. Bootstrap context:
|
|
249
|
-
- `
|
|
261
|
+
- `brainlink_bootstrap` with `agent`, optional `query`, `mode: hybrid`, `limit`.
|
|
250
262
|
2. Capture durable decisions:
|
|
251
263
|
- `brainlink_add_note` or `brainlink_add_file` with explicit `[[wiki links]]` and `#tags`.
|
|
252
264
|
3. Run maintenance before handoff or before the next step:
|
|
@@ -343,6 +355,69 @@ $HOME/.brainlink/vault/
|
|
|
343
355
|
|
|
344
356
|
`blink init ./vault` creates a custom vault instead. If the custom vault is empty and the default `$HOME/.brainlink/vault` already has Markdown memory, Brainlink copies that content into the custom vault and reindexes it. Use `blink init ./vault --no-migrate-existing` to intentionally start empty, or `blink init ./vault --migrate-from <old-vault>` to migrate from a specific previous vault. Existing target files are not overwritten; conflicting source files are preserved with a `.conflict-<timestamp>` suffix.
|
|
345
357
|
|
|
358
|
+
### Configure Defaults
|
|
359
|
+
|
|
360
|
+
```bash
|
|
361
|
+
blink config where
|
|
362
|
+
blink config get vault
|
|
363
|
+
blink config doctor
|
|
364
|
+
blink config doctor --fix
|
|
365
|
+
blink config set-vault /absolute/path/to/vault
|
|
366
|
+
blink config set-vault /absolute/path/to/vault --global
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
`config set-vault` updates Brainlink config through CLI. By default it writes local `brainlink.config.json`, appends the vault to `allowedVaults`, and migrates markdown when the target is empty.
|
|
370
|
+
|
|
371
|
+
### Migrate Vaults Explicitly
|
|
372
|
+
|
|
373
|
+
```bash
|
|
374
|
+
blink migrate-vault --from ~/.brainlink/vault --to ./team-vault --dry-run
|
|
375
|
+
blink migrate-vault --from ~/.brainlink/vault --to ./team-vault
|
|
376
|
+
blink migrate-vault --from ~/.brainlink/vault --to "s3://my-memory-bucket/brainlink"
|
|
377
|
+
blink migrate-vault --from ~/.brainlink/vault --to ./team-vault --report ./migration-report.json
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
Use `--dry-run` to preview `copied`, `conflicted`, `unchanged` before writing files.
|
|
381
|
+
|
|
382
|
+
### Import Legacy SQLite DB
|
|
383
|
+
|
|
384
|
+
```bash
|
|
385
|
+
blink db-import --vault ./team-vault
|
|
386
|
+
blink db-import --vault ./team-vault --db ./legacy/brainlink.db
|
|
387
|
+
blink db-import --vault ./team-vault --db ./legacy/brainlink.db --table legacy_notes --dry-run
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
`db-import` migrates rows from legacy SQLite memory into Markdown notes in the current vault and indexes the result by default.
|
|
391
|
+
Without `--db`, Brainlink auto-detects common legacy database paths.
|
|
392
|
+
Use `--agent` to force namespace, `--limit` for staged migration, `--dry-run` to preview writes, and `--no-index` to postpone indexing.
|
|
393
|
+
|
|
394
|
+
### Install Agent Integration
|
|
395
|
+
|
|
396
|
+
```bash
|
|
397
|
+
blink agent install
|
|
398
|
+
blink agent install --self-test
|
|
399
|
+
blink agent upgrade
|
|
400
|
+
blink agent policy --preset fully-auto
|
|
401
|
+
blink agent policy --preset strict
|
|
402
|
+
blink agent install --plugin-path ./plugins/brainlink
|
|
403
|
+
blink agent status
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
`agent install` configures Brainlink MCP in `~/.codex/config.toml` so compatible agents can use Brainlink by default.
|
|
407
|
+
`agent install` and `agent upgrade` automatically apply the `fully-auto` MCP bootstrap policy (`enforceBootstrap=true`, `enforceContextFirst=true`, `autoBootstrapOnRead=true`, `autoBootstrapOnStartup=true`) so all plug-and-play Brainlink features start enabled.
|
|
408
|
+
Use `agent upgrade` on legacy installations to reapply the latest defaults and run self-test diagnostics.
|
|
409
|
+
Use `agent policy --preset fully-auto` to keep startup/read auto-bootstrap enabled, or `agent policy --preset strict` to force explicit bootstrap calls.
|
|
410
|
+
|
|
411
|
+
### Quickstart Plug-And-Play
|
|
412
|
+
|
|
413
|
+
```bash
|
|
414
|
+
blink quickstart --json
|
|
415
|
+
blink quickstart --vault ./team-vault --agent coding-agent --query "architecture decisions" --json
|
|
416
|
+
blink quickstart --vault ./team-vault --mcp-only --json
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
`quickstart` runs index, doctor, stats and validation, marks bootstrap readiness for MCP sessions, optionally returns context, and updates agent integration by default.
|
|
420
|
+
|
|
346
421
|
### Add A Note
|
|
347
422
|
|
|
348
423
|
```bash
|
|
@@ -356,6 +431,26 @@ blink add "Note Title" --vault ./vault --content-file ./notes.md --no-auto-index
|
|
|
356
431
|
This creates a slugged Markdown file with frontmatter and a heading.
|
|
357
432
|
|
|
358
433
|
The CLI blocks common secret patterns by default. Do not use `--allow-sensitive` unless the vault is intentionally protected.
|
|
434
|
+
Brainlink also auto-connects notes that have no `[[wiki links]]` by adding a fallback edge to an agent hub note, so new memory does not stay disconnected.
|
|
435
|
+
`add` also returns `possibleDuplicates` (exact hash + semantic candidates) so agents can decide duplicate resolution immediately.
|
|
436
|
+
|
|
437
|
+
### Detect Duplicate Notes
|
|
438
|
+
|
|
439
|
+
```bash
|
|
440
|
+
blink dedupe --vault ./vault --json
|
|
441
|
+
blink dedupe --vault ./vault --agent coding-agent --limit 20 --min-score 0.92 --json
|
|
442
|
+
blink dedupe --vault ./vault --no-semantic --json
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
### Resolve Duplicate Notes
|
|
446
|
+
|
|
447
|
+
```bash
|
|
448
|
+
blink dedupe-resolve --vault ./vault --left agents/shared/a.md --right agents/shared/b.md --action merge --json
|
|
449
|
+
blink dedupe-resolve --vault ./vault --left agents/shared/a.md --right agents/shared/b.md --action link --json
|
|
450
|
+
blink dedupe-resolve --vault ./vault --left agents/shared/a.md --right agents/shared/b.md --action ignore --json
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
`dedupe-resolve` keeps connectivity: non-merge actions still create a low-priority related edge (`#related-to`).
|
|
359
454
|
|
|
360
455
|
For agent-private memory:
|
|
361
456
|
|
|
@@ -385,6 +480,37 @@ This scans Markdown files and rebuilds:
|
|
|
385
480
|
- links
|
|
386
481
|
- full-text search records
|
|
387
482
|
|
|
483
|
+
### Benchmark Indexing Realtime
|
|
484
|
+
|
|
485
|
+
```bash
|
|
486
|
+
blink bench --vault ./vault
|
|
487
|
+
blink bench --vault ./vault --watch
|
|
488
|
+
blink bench --vault ./vault --watch --debounce 500
|
|
489
|
+
blink bench --vault ./vault --json
|
|
490
|
+
```
|
|
491
|
+
|
|
492
|
+
`bench` runs indexing with realtime phase events and prints a run summary with:
|
|
493
|
+
|
|
494
|
+
- indexed totals (documents, chunks, links)
|
|
495
|
+
- elapsed time and changed document count
|
|
496
|
+
- pack rebuild status and reason
|
|
497
|
+
- pack compression metrics (`inputBytes`, `outputBytes`, ratio/saved percentage)
|
|
498
|
+
- objective guardrails (`guardrailMinSavingsPercent`, `guardrailMaxLatencyRegressionPercent`)
|
|
499
|
+
|
|
500
|
+
Use `--watch` for continuous benchmark runs while editing notes. Watch mode is supported only for local filesystem vaults.
|
|
501
|
+
If pack manifest metadata is missing but encrypted `.blpk` files are present, Brainlink repairs manifest metadata before deciding rebuild policy to avoid unnecessary full repacks on small updates.
|
|
502
|
+
|
|
503
|
+
### Create Offline Pack Backup
|
|
504
|
+
|
|
505
|
+
```bash
|
|
506
|
+
blink pack-backup --vault ./vault
|
|
507
|
+
blink pack-backup --vault ./vault --output ./vault/.brainlink/backups/custom.blpkbak.gz
|
|
508
|
+
blink pack-backup --vault ./vault --json
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
`pack-backup` creates an offline artifact with second-stage compression on top of encrypted `.blpk` packs.
|
|
512
|
+
This is outside the online retrieval path (`index`, `search`, `context`), which keeps a single compression stage.
|
|
513
|
+
|
|
388
514
|
### Search Knowledge
|
|
389
515
|
|
|
390
516
|
```bash
|
|
@@ -395,12 +521,16 @@ blink search "authentication token policy" --vault ./vault --mode semantic --jso
|
|
|
395
521
|
```
|
|
396
522
|
|
|
397
523
|
This returns matching chunks with title, source path, score, `textScore`, `semanticScore`, `searchMode`, and content.
|
|
524
|
+
If `--mode`/`--limit` are omitted, Brainlink resolves those values from the active agent profile before global defaults.
|
|
398
525
|
|
|
399
526
|
Search modes:
|
|
400
527
|
|
|
401
|
-
- `hybrid`: default; combines
|
|
402
|
-
- `fts`: lexical
|
|
403
|
-
- `semantic`: local deterministic embedding similarity
|
|
528
|
+
- `hybrid`: default; combines lexical matching and local embedding similarity.
|
|
529
|
+
- `fts`: lexical full-text matching only.
|
|
530
|
+
- `semantic`: local deterministic embedding similarity.
|
|
531
|
+
|
|
532
|
+
Hybrid results are cached in-memory for a short TTL and invalidated when `.brainlink/index.json` changes.
|
|
533
|
+
Context assembly uses middle-out ordering inside each note: the highest-scoring chunk is selected first, then nearby chunks are expanded while token budget allows.
|
|
404
534
|
|
|
405
535
|
### Build Agent Context
|
|
406
536
|
|
|
@@ -459,13 +589,26 @@ shared: 30 documents
|
|
|
459
589
|
```bash
|
|
460
590
|
blink server --host 127.0.0.1 --port 4321
|
|
461
591
|
blink server --vault ./vault --host 127.0.0.1 --port 4321
|
|
592
|
+
blink server --vault ./vault --host 127.0.0.1 --port 4321 --no-open
|
|
462
593
|
```
|
|
463
594
|
|
|
464
595
|
This starts a local frontend for inspecting the knowledge graph.
|
|
596
|
+
By default it tries to open the graph in a native desktop GUI window:
|
|
597
|
+
- macOS: Swift + WebKit
|
|
598
|
+
- Windows: PowerShell WinForms WebBrowser
|
|
599
|
+
- Linux: optional Python GTK + WebKit2 (requires `python3` + `gi` + `WebKit2`)
|
|
600
|
+
|
|
601
|
+
On Linux, native GUI is disabled by default for better startup performance. Enable it with `BRAINLINK_LINUX_NATIVE_GUI=1`.
|
|
602
|
+
If native GUI launch is unavailable, it falls back to dedicated app-window mode and then to the default browser.
|
|
603
|
+
Use `--no-open` to keep the server headless.
|
|
604
|
+
When native GUI is active, the GUI window closes automatically when the `blink server` process stops.
|
|
465
605
|
|
|
466
606
|
Without `--vault`, the graph UI serves `$HOME/.brainlink/vault`.
|
|
467
607
|
|
|
468
|
-
The frontend includes an agent selector. Selecting an agent calls the same read APIs with `agent=<agent-id>` and renders that namespace instead of merging every agent into one graph.
|
|
608
|
+
The frontend includes an agent selector that shows only the agent id. Selecting an agent calls the same read APIs with `agent=<agent-id>` and renders that namespace instead of merging every agent into one graph.
|
|
609
|
+
|
|
610
|
+
Graph navigation controls include zoom in, zoom out, fit visible nodes and reset-to-fit-all nodes. Mouse wheel zoom (including `cmd+scroll` and `ctrl+scroll`) is anchored to the cursor. Keyboard shortcuts are `+` (zoom in), `-` (zoom out) and `0` (reset fit). Double-click on canvas zooms in at cursor position. Totals for notes, links and tags stay visible as floating metrics under the Brainlink title, and node details open on click in a modal (tags, outgoing links, backlinks and Markdown content).
|
|
611
|
+
During graph filtering, Brainlink keeps hub context nodes visible (`Memory Hub`/`MOC`/high-degree fallback) so filtered views still show relationship anchors.
|
|
469
612
|
|
|
470
613
|
The command reindexes by default, then serves:
|
|
471
614
|
|
|
@@ -518,8 +661,13 @@ Example MCP client configuration:
|
|
|
518
661
|
|
|
519
662
|
Available MCP tools:
|
|
520
663
|
|
|
664
|
+
- `brainlink_bootstrap`
|
|
665
|
+
- `brainlink_policy`
|
|
666
|
+
- `brainlink_recommendations`
|
|
521
667
|
- `brainlink_context`
|
|
522
668
|
- `brainlink_search`
|
|
669
|
+
- `brainlink_dedupe`
|
|
670
|
+
- `brainlink_resolve_duplicate`
|
|
523
671
|
- `brainlink_add_note`
|
|
524
672
|
- `brainlink_add_file`
|
|
525
673
|
- `brainlink_index`
|
|
@@ -530,9 +678,17 @@ Available MCP tools:
|
|
|
530
678
|
- `brainlink_broken_links`
|
|
531
679
|
- `brainlink_orphans`
|
|
532
680
|
|
|
681
|
+
Recommended start of every memory-dependent task: call `brainlink_bootstrap` first, then `brainlink_context`. By default, Brainlink enforces context-first for non-context MCP reads (`enforceContextFirst=true`), and also enforces bootstrap with auto-bootstrap on reads when state is missing or stale (`autoBootstrapOnRead=true`).
|
|
682
|
+
MCP startup also bootstraps the configured default vault/agent automatically (`autoBootstrapOnStartup=true`), so sessions start warm without manual calls.
|
|
683
|
+
If `autoBootstrapOnRead` or `enforceContextFirst` are disabled through `brainlink_policy`, behavior is relaxed accordingly; otherwise read tools return preflight-required responses when requirements are not satisfied.
|
|
684
|
+
`brainlink_bootstrap`, `brainlink_policy` and preflight responses include structured `nextActions` so clients can continue tool flows automatically.
|
|
685
|
+
`brainlink_policy` also accepts policy presets (`fully-auto`, `strict`) so MCP clients can switch behavior in one call.
|
|
686
|
+
`brainlink_recommendations` returns the suggested execution order so an agent can follow Brainlink best practices automatically.
|
|
687
|
+
|
|
533
688
|
MCP clients can pass `vault` and `agent` arguments per tool call. Set `BRAINLINK_ALLOWED_VAULTS` when exposing Brainlink to an external agent process so a tool cannot pass arbitrary vault paths:
|
|
534
689
|
|
|
535
690
|
`brainlink_graph` returns weighted edges. Agents should prefer higher `weight` and stronger `priority` when deciding which related notes matter most.
|
|
691
|
+
`brainlink_add_note` and `brainlink_add_file` return `writeConnectivity` metadata and guarantee at least one edge for new notes.
|
|
536
692
|
|
|
537
693
|
```bash
|
|
538
694
|
export BRAINLINK_ALLOWED_VAULTS="/absolute/path/to/project-vault"
|
|
@@ -543,6 +699,8 @@ export BRAINLINK_ALLOWED_VAULTS="/absolute/path/to/project-vault"
|
|
|
543
699
|
```txt
|
|
544
700
|
GET /api/graph
|
|
545
701
|
GET /api/graph-layout
|
|
702
|
+
GET /api/graph-node?id=<node-id>
|
|
703
|
+
GET /api/graph-filter?q=<query>&limit=<n>
|
|
546
704
|
GET /api/search?q=<query>&limit=10&mode=hybrid
|
|
547
705
|
GET /api/context?q=<query>&limit=12&tokens=2000&mode=hybrid
|
|
548
706
|
GET /api/links
|
|
@@ -555,6 +713,10 @@ GET /api/validate
|
|
|
555
713
|
|
|
556
714
|
The HTTP API is read-only. Use the CLI for writes and indexing.
|
|
557
715
|
|
|
716
|
+
Indexing writes private encrypted search packs at `.brainlink/search-packs/*.blpk` for resilient retrieval and portability.
|
|
717
|
+
Pack search now uses compressed-space prefiltering (token bloom index per pack) before decrypting/reading pack payloads.
|
|
718
|
+
Pack decryption keys are resolved from `$BRAINLINK_HOME/keys` (or `BRAINLINK_SEARCH_PACK_KEY` when explicitly set).
|
|
719
|
+
|
|
558
720
|
## Agent Integration Contract
|
|
559
721
|
|
|
560
722
|
Input:
|
|
@@ -586,9 +748,9 @@ Non-goals:
|
|
|
586
748
|
## Operational Rules
|
|
587
749
|
|
|
588
750
|
- Re-run `index` after modifying notes.
|
|
589
|
-
- Treat `.brainlink/
|
|
590
|
-
- Commit Markdown notes, not local
|
|
591
|
-
- Do not manually edit
|
|
751
|
+
- Treat `.brainlink/index.json` and `.brainlink/search-packs/` as disposable.
|
|
752
|
+
- Commit Markdown notes, not local index files.
|
|
753
|
+
- Do not manually edit generated index artifacts.
|
|
592
754
|
- Keep generated context short enough for the target model.
|
|
593
755
|
- Prefer specific queries over broad queries.
|
|
594
756
|
- Write explicit `[[wiki links]]` when durable memory should be connected.
|
|
@@ -618,9 +780,9 @@ Weak retrieval usually means:
|
|
|
618
780
|
|
|
619
781
|
## Current Limits
|
|
620
782
|
|
|
621
|
-
- Search supports FTS, local semantic embeddings
|
|
783
|
+
- Search supports FTS, local semantic embeddings and hybrid ranking.
|
|
622
784
|
- Local embeddings are deterministic and provider-free; remote embedding providers are not implemented yet.
|
|
623
785
|
- MCP integration is available through the `brainlink-mcp` stdio server.
|
|
624
786
|
- HTTP API is local and unauthenticated.
|
|
625
|
-
- Bucket vaults support S3-compatible `s3://bucket/prefix` URIs and use
|
|
787
|
+
- Bucket vaults support S3-compatible `s3://bucket/prefix` URIs and use local cache/index artifacts.
|
|
626
788
|
- Watch mode depends on platform filesystem watcher behavior and is only supported for local filesystem vaults.
|
package/docs/ARCHITECTURE.md
CHANGED
|
@@ -8,7 +8,7 @@ CLI -> application use cases -> domain functions -> infrastructure adapters
|
|
|
8
8
|
|
|
9
9
|
The core rule is simple:
|
|
10
10
|
|
|
11
|
-
Domain code must not know about the CLI, filesystem, or
|
|
11
|
+
Domain code must not know about the CLI, filesystem, or index persistence format.
|
|
12
12
|
|
|
13
13
|
## Modules
|
|
14
14
|
|
|
@@ -34,6 +34,8 @@ src/
|
|
|
34
34
|
|
|
35
35
|
cli/
|
|
36
36
|
commands/
|
|
37
|
+
agent-commands.ts
|
|
38
|
+
config-commands.ts
|
|
37
39
|
read-commands.ts
|
|
38
40
|
write-commands.ts
|
|
39
41
|
main.ts
|
|
@@ -51,13 +53,16 @@ src/
|
|
|
51
53
|
types.ts
|
|
52
54
|
|
|
53
55
|
infrastructure/
|
|
54
|
-
|
|
55
|
-
document-writer.ts
|
|
56
|
-
graph-reader.ts
|
|
57
|
-
schema.ts
|
|
58
|
-
search-reader.ts
|
|
56
|
+
file-index.ts
|
|
59
57
|
file-system-vault.ts
|
|
60
|
-
|
|
58
|
+
private-pack-codec.ts
|
|
59
|
+
search-packs.ts
|
|
60
|
+
session-state.ts
|
|
61
|
+
|
|
62
|
+
mcp/
|
|
63
|
+
main.ts
|
|
64
|
+
server.ts
|
|
65
|
+
tools.ts
|
|
61
66
|
```
|
|
62
67
|
|
|
63
68
|
## Domain
|
|
@@ -72,7 +77,6 @@ The domain layer contains pure knowledge rules:
|
|
|
72
77
|
- extract `#tags`
|
|
73
78
|
- split documents into chunks
|
|
74
79
|
- create deterministic local embeddings
|
|
75
|
-
- create deterministic embedding buckets for semantic candidate retrieval
|
|
76
80
|
- calculate cosine similarity
|
|
77
81
|
- estimate token counts
|
|
78
82
|
- select context sections
|
|
@@ -108,12 +112,11 @@ The infrastructure layer handles side effects:
|
|
|
108
112
|
- mirroring S3-compatible bucket Markdown into a local cache
|
|
109
113
|
- writing Markdown notes
|
|
110
114
|
- creating `.brainlink`
|
|
111
|
-
- writing and querying
|
|
112
|
-
- running
|
|
113
|
-
|
|
115
|
+
- writing and querying file-based indexes
|
|
116
|
+
- running lexical, semantic and hybrid retrieval
|
|
117
|
+
|
|
114
118
|
|
|
115
|
-
|
|
116
|
-
objects in the bucket remain canonical and SQLite is still local derived data.
|
|
119
|
+
Index artifacts are rebuildable and are not canonical storage. For bucket vaults, Markdown objects in the bucket remain canonical and local index files are derived data.
|
|
117
120
|
|
|
118
121
|
## Indexing Flow
|
|
119
122
|
|
|
@@ -124,11 +127,9 @@ read markdown files
|
|
|
124
127
|
-> resolve links
|
|
125
128
|
-> split chunks
|
|
126
129
|
-> create chunk embeddings
|
|
127
|
-
-> reset
|
|
130
|
+
-> reset file index
|
|
128
131
|
-> persist documents, chunks and links
|
|
129
|
-
->
|
|
130
|
-
-> persist embedding vectors
|
|
131
|
-
-> persist embedding buckets
|
|
132
|
+
-> persist chunks, links and embeddings in file index
|
|
132
133
|
```
|
|
133
134
|
|
|
134
135
|
## Retrieval Flow
|
|
@@ -137,8 +138,10 @@ read markdown files
|
|
|
137
138
|
question
|
|
138
139
|
-> selected mode: fts | semantic | hybrid
|
|
139
140
|
-> optional query embedding
|
|
140
|
-
->
|
|
141
|
+
-> optional compressed pack prefilter (token bloom)
|
|
142
|
+
-> lexical scoring and/or semantic cosine scoring
|
|
141
143
|
-> cosine similarity over candidate chunks
|
|
144
|
+
-> middle-out context expansion around strongest chunk
|
|
142
145
|
-> ranked chunks with textScore and semanticScore
|
|
143
146
|
-> token-budget selection
|
|
144
147
|
-> Markdown context package
|
|
@@ -155,7 +158,7 @@ server command
|
|
|
155
158
|
-> browser renders graph canvas
|
|
156
159
|
```
|
|
157
160
|
|
|
158
|
-
The graph UI is intentionally read-only. Markdown remains the write interface and
|
|
161
|
+
The graph UI is intentionally read-only. Markdown remains the write interface and index artifacts remain derived data.
|
|
159
162
|
|
|
160
163
|
## HTTP API Flow
|
|
161
164
|
|
|
@@ -163,7 +166,7 @@ The graph UI is intentionally read-only. Markdown remains the write interface an
|
|
|
163
166
|
HTTP request
|
|
164
167
|
-> route handler
|
|
165
168
|
-> application use case
|
|
166
|
-
-> filesystem and
|
|
169
|
+
-> filesystem and index adapters
|
|
167
170
|
-> JSON response
|
|
168
171
|
```
|
|
169
172
|
|
|
@@ -181,6 +184,10 @@ MCP client
|
|
|
181
184
|
```
|
|
182
185
|
|
|
183
186
|
The MCP adapter stays thin. It validates tool inputs, resolves the configured vault and calls the same application use cases used by the CLI.
|
|
187
|
+
At server startup, Brainlink runs a bootstrap pass on the configured default vault/agent, then keeps enforcing bootstrap policy on read tools.
|
|
188
|
+
For MCP agents, non-context read tools also enforce context-first by default, requiring a recent `brainlink_context` call before additional reads.
|
|
189
|
+
When `mode`/`limit`/`tokens` are omitted, MCP read tools resolve per-agent defaults from `agentProfiles` and then fallback to global config defaults.
|
|
190
|
+
Session state is persisted in `$BRAINLINK_HOME/session-state.json` with independent bootstrap/context freshness per vault/agent so read tools can enforce bootstrap and context-first policies with optional automation.
|
|
184
191
|
|
|
185
192
|
## Link Resolution
|
|
186
193
|
|
|
@@ -270,11 +277,10 @@ vault/agents/<agent-id>/**/*.md
|
|
|
270
277
|
|
|
271
278
|
Rebuildable:
|
|
272
279
|
|
|
273
|
-
- `.brainlink/
|
|
280
|
+
- `.brainlink/index.json`
|
|
281
|
+
- `.brainlink/search-packs/*.blpk`
|
|
274
282
|
- `$BRAINLINK_HOME/bucket-cache`
|
|
275
|
-
- FTS records
|
|
276
283
|
- local embedding vectors
|
|
277
|
-
- local embedding bucket index
|
|
278
284
|
- chunks
|
|
279
285
|
- resolved links
|
|
280
286
|
|
|
@@ -284,13 +290,18 @@ Rebuildable:
|
|
|
284
290
|
|
|
285
291
|
Markdown keeps the system portable, inspectable, Git-friendly, and compatible with Obsidian-like workflows.
|
|
286
292
|
|
|
287
|
-
###
|
|
293
|
+
### File Index As Local Index
|
|
288
294
|
|
|
289
|
-
|
|
295
|
+
Brainlink uses a local JSON index plus encrypted pack exports for fast rebuildable retrieval without external infrastructure.
|
|
296
|
+
Hybrid retrieval also uses a short-lived in-memory cache keyed by vault/query/agent and invalidated by index file mtime to reduce repeated query latency.
|
|
297
|
+
Indexing exports private encrypted pack files (`.brainlink/search-packs/*.blpk`) from indexed chunks for fast retrieval and recovery continuity.
|
|
298
|
+
Pack manifests include compressed-space token bloom metadata so retrieval can skip unrelated packs before decryption.
|
|
299
|
+
Pack encryption keys are resolved from `$BRAINLINK_HOME/keys` or from `BRAINLINK_SEARCH_PACK_KEY` when configured.
|
|
300
|
+
Legacy `.jsonl.gz` search packs are auto-upgraded to `.blpk` on first retrieval flow.
|
|
290
301
|
|
|
291
302
|
### CLI First
|
|
292
303
|
|
|
293
|
-
The CLI is the smallest useful integration surface for agents. HTTP is a local inspection adapter, and
|
|
304
|
+
The CLI is the smallest useful integration surface for agents. HTTP is a local inspection adapter, and Brainlink also ships a built-in MCP server (`brainlink-mcp`) that uses the same application use cases.
|
|
294
305
|
|
|
295
306
|
### Functional Core
|
|
296
307
|
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# Quickstart
|
|
2
|
+
|
|
3
|
+
Use this path when you want Brainlink running as agent memory with the smallest setup.
|
|
4
|
+
|
|
5
|
+
## 1) Install Brainlink
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @andespindola/brainlink@latest
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## 2) Install Agent Integration
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
blink agent install --self-test
|
|
15
|
+
blink agent upgrade
|
|
16
|
+
blink agent policy --preset fully-auto
|
|
17
|
+
blink agent status
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
For local plugin gallery in this repository:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
blink agent install --plugin-path ./plugins/brainlink --self-test
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
One-command setup and readiness check:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
blink quickstart --query "what should I know before this task?" --json
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## 3) Initialize Or Select Vault
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
blink init
|
|
36
|
+
blink config where
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
To set a different default vault:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
blink config set-vault /absolute/path/to/vault
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Optional per-agent retrieval defaults in `brainlink.config.json`:
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"agentProfiles": {
|
|
50
|
+
"coding-agent": {
|
|
51
|
+
"defaultSearchMode": "semantic",
|
|
52
|
+
"defaultSearchLimit": 8,
|
|
53
|
+
"defaultContextTokens": 2400
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## 4) Run Bootstrap Before Work
|
|
60
|
+
|
|
61
|
+
MCP clients should call `brainlink_bootstrap` first for each vault/agent session, then `brainlink_context`.
|
|
62
|
+
By default, Brainlink enforces context-first for non-context read tools, so a fresh `brainlink_context` call is required before other MCP reads.
|
|
63
|
+
Read tools auto-bootstrap by default when state is missing/stale, and bootstrap/preflight responses include structured `nextActions` for automatic client flows.
|
|
64
|
+
MCP startup also runs bootstrap automatically for the configured default vault/agent.
|
|
65
|
+
|
|
66
|
+
For CLI workflows:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
blink context "what should I know before this task?" --mode hybrid --json
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## 5) Write Durable Memory
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
blink add "Architecture Decision" --content "Use explicit [[Bounded Context]] links and #tags. #architecture #decision"
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## 6) Validate Health
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
blink validate
|
|
82
|
+
blink doctor
|
|
83
|
+
blink stats --extended --json
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## 7) Migrate Existing Memory (Optional)
|
|
87
|
+
|
|
88
|
+
Preview first:
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
blink migrate-vault --from ~/.brainlink/vault --to ./team-vault --dry-run --report ./migration-report.json
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Apply:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
blink migrate-vault --from ~/.brainlink/vault --to ./team-vault --report ./migration-report.json
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
S3 target:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
blink migrate-vault --from ~/.brainlink/vault --to "s3://my-memory-bucket/brainlink" --dry-run
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Legacy SQLite import:
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
blink db-import --vault ./team-vault
|
|
110
|
+
blink db-import --vault ./team-vault --db ./legacy/brainlink.db --dry-run
|
|
111
|
+
```
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@andespindola/brainlink",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.81",
|
|
4
4
|
"description": "Local-first knowledge memory for agents with Markdown, backlinks, indexing and context retrieval.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
|
-
"author": "
|
|
7
|
+
"author": "Substructa",
|
|
8
8
|
"homepage": "https://github.com/andersonflima/brainlink#readme",
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
@@ -32,6 +32,7 @@
|
|
|
32
32
|
"dist",
|
|
33
33
|
"assets",
|
|
34
34
|
"README.md",
|
|
35
|
+
"COPYRIGHT.md",
|
|
35
36
|
"LICENSE",
|
|
36
37
|
"CHANGELOG.md",
|
|
37
38
|
"CONTRIBUTING.md",
|
|
@@ -58,12 +59,13 @@
|
|
|
58
59
|
"dependencies": {
|
|
59
60
|
"@aws-sdk/client-s3": "^3.1038.0",
|
|
60
61
|
"@modelcontextprotocol/sdk": "^1.29.0",
|
|
61
|
-
"better-sqlite3": "^12.9.0",
|
|
62
62
|
"commander": "^14.0.2",
|
|
63
63
|
"zod": "^4.3.6"
|
|
64
64
|
},
|
|
65
|
+
"overrides": {
|
|
66
|
+
"qs": "6.15.2"
|
|
67
|
+
},
|
|
65
68
|
"devDependencies": {
|
|
66
|
-
"@types/better-sqlite3": "^7.6.13",
|
|
67
69
|
"@types/node": "^24.9.2",
|
|
68
70
|
"tsx": "^4.21.0",
|
|
69
71
|
"typescript": "^5.9.3",
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
import { createEmbeddingBuckets } from '../../domain/embeddings.js';
|
|
2
|
-
const toTitleKey = (title) => title.toLowerCase();
|
|
3
|
-
export const createIndexWriter = (database) => ({
|
|
4
|
-
reset: () => {
|
|
5
|
-
database.exec(`
|
|
6
|
-
DELETE FROM embedding_buckets;
|
|
7
|
-
DELETE FROM chunks_fts;
|
|
8
|
-
DELETE FROM links;
|
|
9
|
-
DELETE FROM chunks;
|
|
10
|
-
DELETE FROM documents;
|
|
11
|
-
`);
|
|
12
|
-
},
|
|
13
|
-
saveDocuments: (documents) => {
|
|
14
|
-
const insertDocument = database.prepare(`
|
|
15
|
-
INSERT INTO documents (id, agent_id, title, path, content, tags_json, frontmatter_json, created_at, updated_at)
|
|
16
|
-
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
|
|
17
|
-
`);
|
|
18
|
-
const insertChunk = database.prepare(`
|
|
19
|
-
INSERT INTO chunks (id, document_id, ordinal, content, token_count, embedding_provider, embedding_json)
|
|
20
|
-
VALUES (?, ?, ?, ?, ?, ?, ?)
|
|
21
|
-
`);
|
|
22
|
-
const insertChunkFts = database.prepare(`
|
|
23
|
-
INSERT INTO chunks_fts (chunk_id, document_id, agent_id, title, content)
|
|
24
|
-
VALUES (?, ?, ?, ?, ?)
|
|
25
|
-
`);
|
|
26
|
-
const insertEmbeddingBucket = database.prepare(`
|
|
27
|
-
INSERT OR IGNORE INTO embedding_buckets (bucket, chunk_id)
|
|
28
|
-
VALUES (?, ?)
|
|
29
|
-
`);
|
|
30
|
-
const insertLink = database.prepare(`
|
|
31
|
-
INSERT INTO links (from_document_id, to_title, to_title_key, to_document_id, weight, priority)
|
|
32
|
-
VALUES (?, ?, ?, ?, ?, ?)
|
|
33
|
-
`);
|
|
34
|
-
const transaction = database.transaction(() => {
|
|
35
|
-
documents.forEach(({ document, chunks, links }) => {
|
|
36
|
-
insertDocument.run(document.id, document.agentId, document.title, document.path, document.content, JSON.stringify(document.tags), JSON.stringify(document.frontmatter), document.createdAt, document.updatedAt);
|
|
37
|
-
chunks.forEach((chunk) => {
|
|
38
|
-
insertChunk.run(chunk.id, chunk.documentId, chunk.ordinal, chunk.content, chunk.tokenCount, chunk.embeddingProvider, JSON.stringify(chunk.embedding));
|
|
39
|
-
insertChunkFts.run(chunk.id, chunk.documentId, document.agentId, document.title, chunk.content);
|
|
40
|
-
createEmbeddingBuckets(chunk.embedding).forEach((bucket) => insertEmbeddingBucket.run(bucket, chunk.id));
|
|
41
|
-
});
|
|
42
|
-
});
|
|
43
|
-
documents.forEach(({ links }) => {
|
|
44
|
-
links.forEach((link) => {
|
|
45
|
-
insertLink.run(link.fromDocumentId, link.toTitle, toTitleKey(link.toTitle), link.toDocumentId, link.weight, link.priority);
|
|
46
|
-
});
|
|
47
|
-
});
|
|
48
|
-
});
|
|
49
|
-
transaction();
|
|
50
|
-
}
|
|
51
|
-
});
|