@andespindola/brainlink 0.1.0-beta.12 → 0.1.0-beta.120
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 +26 -2
- package/CONTRIBUTING.md +2 -2
- package/COPYRIGHT.md +5 -0
- package/README.md +138 -18
- package/SECURITY.md +1 -1
- package/dist/application/analyze-vault.js +1 -9
- package/dist/application/build-context.js +56 -1
- package/dist/application/dedupe-notes.js +226 -0
- package/dist/application/frontend/client-css.js +93 -45
- package/dist/application/frontend/client-html.js +34 -25
- package/dist/application/frontend/client-js.js +2637 -181
- package/dist/application/frontend/client-worker-js.js +66 -0
- package/dist/application/get-graph-layout.js +2 -2
- package/dist/application/get-graph-node.js +3 -3
- package/dist/application/get-graph-summary.js +3 -3
- package/dist/application/get-graph.js +3 -3
- package/dist/application/import-legacy-sqlite.js +296 -0
- package/dist/application/index-vault.js +250 -24
- package/dist/application/list-agents.js +3 -3
- package/dist/application/list-links.js +5 -5
- package/dist/application/offline-pack-backup.js +44 -0
- package/dist/application/search-graph-node-ids.js +3 -3
- package/dist/application/search-knowledge.js +6 -6
- package/dist/application/server/routes.js +90 -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 +7 -0
- package/dist/cli/commands/write-commands.js +818 -8
- package/dist/domain/context.js +53 -11
- package/dist/domain/graph-layout.js +177 -3
- package/dist/domain/middle-out.js +18 -0
- package/dist/infrastructure/config.js +38 -0
- 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/private-pack-codec.js +71 -10
- package/dist/infrastructure/search-packs.js +313 -17
- package/dist/mcp/server.js +11 -1
- package/dist/mcp/tools.js +62 -0
- package/docs/AGENT_USAGE.md +96 -17
- package/docs/ARCHITECTURE.md +22 -27
- package/docs/QUICKSTART.md +7 -0
- package/package.json +6 -4
- package/dist/infrastructure/sqlite/document-writer.js +0 -51
- package/dist/infrastructure/sqlite/graph-reader.js +0 -267
- package/dist/infrastructure/sqlite/recovery.js +0 -83
- package/dist/infrastructure/sqlite/schema.js +0 -114
- package/dist/infrastructure/sqlite/search-reader.js +0 -188
- package/dist/infrastructure/sqlite/types.js +0 -1
- package/dist/infrastructure/sqlite-index.js +0 -38
package/AGENTS.md
CHANGED
|
@@ -6,19 +6,19 @@ This file tells coding agents and AI assistants how to use this repository.
|
|
|
6
6
|
|
|
7
7
|
Brainlink is a local-first knowledge memory for agents.
|
|
8
8
|
|
|
9
|
-
It reads a Markdown vault, extracts `[[wiki links]]` and `#tags`, builds a local
|
|
9
|
+
It reads a Markdown vault, extracts `[[wiki links]]` and `#tags`, builds a local file index at `.brainlink/index.json`, and returns compact context packages that agents can inject into prompts.
|
|
10
10
|
|
|
11
11
|
## Source Of Truth
|
|
12
12
|
|
|
13
13
|
Markdown files are the source of truth.
|
|
14
14
|
|
|
15
|
-
The
|
|
15
|
+
The JSON index at `.brainlink/index.json` is derived. It can be deleted and rebuilt with:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
npm run dev -- index --vault ./vault
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Do not store permanent knowledge only in
|
|
21
|
+
Do not store permanent knowledge only in index artifacts.
|
|
22
22
|
|
|
23
23
|
By default, the installed Brainlink CLI uses `$HOME/.brainlink/vault` as its vault. Passing `--vault` or setting `vault` in `brainlink.config.json` intentionally selects a custom vault such as `./vault`.
|
|
24
24
|
|
|
@@ -83,6 +83,9 @@ Use watch mode while editing notes:
|
|
|
83
83
|
```bash
|
|
84
84
|
npm run dev -- server --vault ./vault --watch
|
|
85
85
|
npm run dev -- watch --vault ./vault
|
|
86
|
+
npm run dev -- bench --vault ./vault
|
|
87
|
+
npm run dev -- bench --vault ./vault --watch
|
|
88
|
+
npm run dev -- pack-backup --vault ./vault
|
|
86
89
|
```
|
|
87
90
|
|
|
88
91
|
Start MCP over stdio:
|
|
@@ -107,10 +110,10 @@ npm run dev -- doctor --vault ./vault
|
|
|
107
110
|
|
|
108
111
|
- Keep domain rules in `src/domain`.
|
|
109
112
|
- Keep use cases in `src/application`.
|
|
110
|
-
- Keep filesystem and
|
|
113
|
+
- Keep filesystem and index details in `src/infrastructure`.
|
|
111
114
|
- Keep CLI concerns in `src/cli`.
|
|
112
115
|
- Prefer pure functions for parsing, ranking, formatting, and transformation.
|
|
113
|
-
- Do not make
|
|
116
|
+
- Do not make index artifacts the canonical storage layer.
|
|
114
117
|
- Do not add comments with emojis.
|
|
115
118
|
- Keep JSON output backwards compatible where possible.
|
|
116
119
|
|
package/CHANGELOG.md
CHANGED
|
@@ -22,6 +22,30 @@
|
|
|
22
22
|
- Added short-lived hybrid search cache with automatic invalidation on index changes.
|
|
23
23
|
- Added `stats --extended` observability output with storage, quality and latency probes.
|
|
24
24
|
- Added `docs/QUICKSTART.md` and aligned README/agent docs with the latest CLI/MCP flows.
|
|
25
|
+
- Added middle-out context assembly so chunk selection expands around the strongest note chunk.
|
|
26
|
+
- Added compressed-space pack prefiltering (token bloom index) before `.blpk` decryption and scan.
|
|
27
|
+
- Improved graph UI auto-fit and viewport recovery so loaded nodes are re-centered when zoom/pan drifts to empty canvas.
|
|
28
|
+
- Added cross-platform native desktop GUI auto-open for `blink server` (macOS Swift/WebKit, Windows PowerShell WinForms, Linux Python GTK/WebKit2), with app-window/browser fallback.
|
|
29
|
+
- Changed Linux default UI launch to app-window/browser for lighter startup; Linux native GUI is now opt-in via `BRAINLINK_LINUX_NATIVE_GUI=1`.
|
|
30
|
+
- Added native GUI parent-process monitoring so GUI windows close automatically when `blink server` stops.
|
|
31
|
+
- Improved non-mac browser detection fallback to try installed Edge/Chrome/Firefox/Chromium candidates before system default open.
|
|
32
|
+
- Improved graph filter rendering to keep hub anchor nodes visible (`Memory Hub`/`MOC`/high-degree fallback) for coherent relationship context.
|
|
33
|
+
- Fixed graph modal content loading by correcting agent query parameter composition for `/api/graph-node` and `/api/graph-filter` requests.
|
|
34
|
+
- Improved 50k+ graph rendering performance with viewport-aware spatial node culling, cached render visibility, and node-adjacent edge selection to avoid full graph scans every frame.
|
|
35
|
+
- Added incremental vault indexing with file snapshots to reuse unchanged documents/chunks/embeddings, plus adaptive search-pack rebuild thresholds to avoid full re-compression on small edits.
|
|
36
|
+
- Reduced large-graph HTTP payload size with compact `/api/graph-layout` encoding for high-node vaults and capped transmitted edges to improve UI load responsiveness.
|
|
37
|
+
- Added aggressive graph LOD clustering when zoomed out, dynamic per-zoom edge render budgets, and a dedicated frontend worker for off-main-thread graph filter matching.
|
|
38
|
+
- Improved Linux browser fallback launch stability by auto-applying Chromium compatibility flags (`--ozone-platform=x11`, `--disable-gpu`, `--disable-features=Vulkan,VaapiVideoDecoder`, `--disable-background-networking`) for app-window/browser modes.
|
|
39
|
+
- Improved massive-graph UI responsiveness with stricter render budgets, adaptive heavy-graph frame throttling, reduced interaction hit-test frequency, and URL-first agent selection on initial graph load.
|
|
40
|
+
- Improved 50k+ graph LOD behavior so zoomed-out views render lightweight cluster overviews and progressively reveal nodes/edges only as zoom increases.
|
|
41
|
+
- Added `blink bench` with realtime index phase telemetry and per-run compressed-pack analysis (input/output bytes, ratio, saved space, rebuild reason and duration), including continuous watch mode.
|
|
42
|
+
- Added tunable single-stage search-pack compression settings (`searchPack.rowChunkSize`, `searchPack.compressionLevel`, `searchPack.useDictionary`).
|
|
43
|
+
- Added benchmark guardrails for compression savings and latency regression (`searchPack.guardrailMinSavingsPercent`, `searchPack.guardrailMaxLatencyRegressionPercent`), reported in `blink bench`.
|
|
44
|
+
- Added `blink pack-backup` for offline second-stage compression backups of encrypted `.blpk` packs, outside the online query path.
|
|
45
|
+
- Hardened Linux browser launch flags for Ubuntu 26 Chromium/Wayland compatibility (`--disable-vulkan`, `--use-gl=swiftshader`, `--ozone-platform-hint=x11`).
|
|
46
|
+
- Improved pack resilience by auto-repairing missing search-pack manifests from existing `.blpk` files, avoiding unnecessary full repacks on small incremental updates.
|
|
47
|
+
- Updated Linux graph auto-open behavior to prioritize the system default browser (`xdg-open`) before explicit browser fallbacks.
|
|
48
|
+
- Removed implicit Chromium dependency in Linux auto-open flow; app-window launch is now opt-in (`BRAINLINK_LINUX_APP_WINDOW=1`).
|
|
25
49
|
|
|
26
50
|
## 0.1.0-beta.3
|
|
27
51
|
|
|
@@ -49,8 +73,8 @@
|
|
|
49
73
|
## 0.1.0-alpha.0
|
|
50
74
|
|
|
51
75
|
- Added local-first Markdown vault indexing.
|
|
52
|
-
- Added
|
|
53
|
-
- Added
|
|
76
|
+
- Added local full-text indexing, local semantic retrieval, wiki links, backlinks and graph retrieval.
|
|
77
|
+
- Added semantic candidate bucket indexing to narrow vector candidates for larger vaults.
|
|
54
78
|
- Optimized title/link resolution with precomputed agent-scoped title maps.
|
|
55
79
|
- Added CLI, JSON output, HTTP API and graph UI.
|
|
56
80
|
- Added vault diagnostics: stats, broken links, orphans, validation and doctor.
|
package/CONTRIBUTING.md
CHANGED
|
@@ -22,7 +22,7 @@ npm run pack:smoke
|
|
|
22
22
|
## Design Rules
|
|
23
23
|
|
|
24
24
|
- Markdown files are the source of truth.
|
|
25
|
-
-
|
|
25
|
+
- Local index artifacts are derived and must remain rebuildable.
|
|
26
26
|
- Domain parsing, graph analysis and layout should stay pure and testable.
|
|
27
|
-
- CLI, HTTP, filesystem and
|
|
27
|
+
- CLI, HTTP, filesystem and index code are adapters around application use cases.
|
|
28
28
|
- MCP integration should live outside this package by wrapping the CLI with `--json`.
|
package/COPYRIGHT.md
ADDED
package/README.md
CHANGED
|
@@ -52,14 +52,15 @@ LLMs do not have infinite context. Brainlink gives agents an external memory lay
|
|
|
52
52
|
1. Durable knowledge is written as Markdown.
|
|
53
53
|
2. Notes are connected with `[[wiki links]]`.
|
|
54
54
|
3. Concepts are classified with `#tags`.
|
|
55
|
-
4. Brainlink builds a local
|
|
55
|
+
4. Brainlink builds a local JSON index (`.brainlink/index.json`) and private encrypted search packs.
|
|
56
56
|
5. Agents query the index before responding.
|
|
57
57
|
6. Brainlink returns compact, source-backed context.
|
|
58
58
|
|
|
59
|
-
Markdown is the source of truth. `.brainlink/
|
|
60
|
-
Brainlink
|
|
61
|
-
|
|
59
|
+
Markdown is the source of truth. `.brainlink/index.json` is a rebuildable index artifact.
|
|
60
|
+
After each index run, Brainlink also writes private encrypted search packs at `.brainlink/search-packs/*.blpk` to preserve fast retrieval and portable recovery.
|
|
61
|
+
Online retrieval always uses a single compression stage per pack; optional second-stage compression is reserved for offline backup artifacts only.
|
|
62
62
|
Pack decryption uses a Brainlink key from `$BRAINLINK_HOME/keys` or from `BRAINLINK_SEARCH_PACK_KEY` when explicitly configured.
|
|
63
|
+
Legacy `.jsonl.gz` packs are upgraded to `.blpk` automatically on first search/context access.
|
|
63
64
|
|
|
64
65
|
## Features
|
|
65
66
|
|
|
@@ -67,8 +68,12 @@ Pack decryption uses a Brainlink key from `$BRAINLINK_HOME/keys` or from `BRAINL
|
|
|
67
68
|
- Obsidian-compatible `[[wiki links]]` and `#tags`.
|
|
68
69
|
- Weighted graph edges so agents can rank relationship importance and priority.
|
|
69
70
|
- Backlinks, broken-link reports, orphan detection and validation.
|
|
70
|
-
- Full-text, semantic and hybrid retrieval
|
|
71
|
-
-
|
|
71
|
+
- Full-text, semantic and hybrid retrieval on a local file index.
|
|
72
|
+
- Middle-out context assembly around the strongest chunk per document.
|
|
73
|
+
- In-process index and context caching with automatic invalidation on index updates.
|
|
74
|
+
- Compressed-space prefiltering for `.blpk` packs before decryption and scan.
|
|
75
|
+
- Incremental indexing that reprocesses only changed markdown files and reuses existing chunks/embeddings for unchanged notes.
|
|
76
|
+
- Adaptive compressed-pack rebuild policy to keep indexing fast during small edit batches.
|
|
72
77
|
- Agent namespaces under `agents/<agent-id>/`.
|
|
73
78
|
- S3-compatible bucket vaults through `s3://bucket/prefix` URIs.
|
|
74
79
|
- CLI with machine-readable `--json` output.
|
|
@@ -76,6 +81,17 @@ Pack decryption uses a Brainlink key from `$BRAINLINK_HOME/keys` or from `BRAINL
|
|
|
76
81
|
- Built-in MCP stdio server for agent tool integration.
|
|
77
82
|
- Local HTTP API.
|
|
78
83
|
- Realtime graph UI with agent selector and colored knowledge groups.
|
|
84
|
+
- Graph renderer optimized for large datasets with viewport-driven node culling and edge lookup by visible nodes.
|
|
85
|
+
- Canvas graph rendering uses the same batched node and edge pipeline for every graph size, reducing per-frame draw calls while keeping selected and hovered items highlighted.
|
|
86
|
+
- WebGL acceleration is used when available for dense node and edge drawing, with Canvas 2D preserved as the interaction and fallback layer.
|
|
87
|
+
- Graph rendering keeps the flat node scene and adds stable hierarchical groups for vaults above 1000 notes, with recursive parent groups when a level itself exceeds 1000 groups.
|
|
88
|
+
- Large graph layout API automatically uses compact payload encoding with link-coverage-aware edge selection to reduce initial client load without hiding major relationships.
|
|
89
|
+
- Large-segment layout spacing now grows logarithmically to keep initial visual density consistent between medium and very large vaults (for example, ~1k vs ~50k notes).
|
|
90
|
+
- Graph coordinates are visually compacted across graph sizes so reset starts from a stable fitted scene and zoom-in progressively reveals local detail.
|
|
91
|
+
- Zoomed-out graph LOD renders hierarchy groups as normal graph nodes and expands the focused group into child nodes progressively as zoom increases.
|
|
92
|
+
- Graph reset fits the full graph scene instead of starting in a separate macro overview mode.
|
|
93
|
+
- Graph filtering runs in a dedicated browser worker to keep the UI thread responsive during heavy datasets.
|
|
94
|
+
- Edge rendering budgets adapt to zoom level to prevent frame spikes on large graph panoramas.
|
|
79
95
|
|
|
80
96
|
## Install
|
|
81
97
|
|
|
@@ -285,7 +301,7 @@ export BRAINLINK_S3_FORCE_PATH_STYLE=1
|
|
|
285
301
|
|
|
286
302
|
Bucket vaults mirror Markdown into a local cache under
|
|
287
303
|
`$BRAINLINK_HOME/bucket-cache`. The bucket remains canonical; the local
|
|
288
|
-
`.brainlink/
|
|
304
|
+
`.brainlink/index.json` stays a disposable index artifact. Run `index` after remote
|
|
289
305
|
bucket changes before relying on `search`, `context`, graph or validation
|
|
290
306
|
commands. Watch mode is only supported for local filesystem vaults.
|
|
291
307
|
|
|
@@ -301,7 +317,7 @@ vault/
|
|
|
301
317
|
research-agent/
|
|
302
318
|
source-review-policy.md
|
|
303
319
|
.brainlink/
|
|
304
|
-
|
|
320
|
+
index.json
|
|
305
321
|
```
|
|
306
322
|
|
|
307
323
|
Permanent data:
|
|
@@ -311,7 +327,7 @@ Permanent data:
|
|
|
311
327
|
|
|
312
328
|
Rebuildable data:
|
|
313
329
|
|
|
314
|
-
- `.brainlink/
|
|
330
|
+
- `.brainlink/index.json`
|
|
315
331
|
- full-text records
|
|
316
332
|
- local embedding vectors
|
|
317
333
|
- local embedding buckets
|
|
@@ -395,6 +411,7 @@ blink agent upgrade
|
|
|
395
411
|
```
|
|
396
412
|
|
|
397
413
|
This configures `~/.codex/config.toml` with Brainlink MCP (`brainlink-mcp`) so Brainlink is available by default in agent sessions.
|
|
414
|
+
`agent install` and `agent upgrade` also apply the MCP `fully-auto` bootstrap policy by default (`enforceBootstrap`, `enforceContextFirst`, `autoBootstrapOnRead`, `autoBootstrapOnStartup` all enabled).
|
|
398
415
|
|
|
399
416
|
If you are inside this repository and want plugin gallery setup too:
|
|
400
417
|
|
|
@@ -514,6 +531,8 @@ Available tools:
|
|
|
514
531
|
- `brainlink_recommendations`: return an automatic action plan so agents can run Brainlink in the recommended order.
|
|
515
532
|
- `brainlink_context`: read indexed context for a task or question.
|
|
516
533
|
- `brainlink_search`: search indexed notes.
|
|
534
|
+
- `brainlink_dedupe`: detect duplicate candidates using exact hash + semantic similarity scores.
|
|
535
|
+
- `brainlink_resolve_duplicate`: resolve duplicate pairs (`merge`, `link`, `ignore`) with connectivity-safe fallback edges.
|
|
517
536
|
- `brainlink_add_note`: write durable Markdown memory and reindex.
|
|
518
537
|
- `brainlink_add_file`: ingest a local file as a note and reindex.
|
|
519
538
|
- `brainlink_index`: rebuild the vault index.
|
|
@@ -552,6 +571,17 @@ blink server --host 127.0.0.1 --port 4321 --watch
|
|
|
552
571
|
```
|
|
553
572
|
|
|
554
573
|
By default, the server uses `$HOME/.brainlink/vault`. Pass `--vault ./vault` only when you want to inspect a custom vault.
|
|
574
|
+
By default, `blink server` tries to open the graph in a native desktop GUI window:
|
|
575
|
+
- macOS: Swift + WebKit
|
|
576
|
+
- Windows: PowerShell WinForms WebBrowser
|
|
577
|
+
- Linux: optional Python GTK + WebKit2 (requires `python3` + `gi` + `WebKit2`)
|
|
578
|
+
|
|
579
|
+
On Linux, native GUI is disabled by default for better startup performance. Enable it with `BRAINLINK_LINUX_NATIVE_GUI=1`.
|
|
580
|
+
If native GUI launch is unavailable on your system, it falls back to dedicated app-window mode and then to the default browser.
|
|
581
|
+
For Chromium-family browsers on Linux (`chromium`, `chromium-browser`, `google-chrome`, `microsoft-edge`, `brave-browser`), Brainlink now auto-applies compatibility flags during launch (`--ozone-platform=x11`, `--ozone-platform-hint=x11`, `--disable-gpu`, `--disable-vulkan`, `--use-gl=swiftshader`, `--disable-features=Vulkan,VaapiVideoDecoder`, `--disable-background-networking`) to avoid common Wayland/Vulkan/VAAPI startup issues.
|
|
582
|
+
On Linux, Brainlink opens the graph through the system default browser first (`xdg-open`), then `$BROWSER`/detected browsers as fallback. Chromium-family app-window mode is optional via `BRAINLINK_LINUX_APP_WINDOW=1`.
|
|
583
|
+
Use `--no-open` to keep it headless.
|
|
584
|
+
When native GUI is used, the GUI window automatically closes when the `blink server` process stops.
|
|
555
585
|
|
|
556
586
|
The graph UI shows:
|
|
557
587
|
|
|
@@ -559,13 +589,22 @@ The graph UI shows:
|
|
|
559
589
|
- `[[wiki links]]` as weighted edges
|
|
560
590
|
- details opened on node click (tags, outgoing links, backlinks, full Markdown content)
|
|
561
591
|
- neutral graph nodes with segment/group metadata
|
|
562
|
-
- agent selector for isolated views
|
|
592
|
+
- agent selector (id-only labels) for isolated views
|
|
563
593
|
- graph filter matches title, path, tags and note content
|
|
594
|
+
- graph filter keeps hub context nodes visible (`Memory Hub`/`MOC`/high-degree fallback) to preserve relationship readability
|
|
564
595
|
- realtime refresh while `--watch` is enabled
|
|
565
596
|
- graph controls for zoom in, zoom out, fit visible nodes and reset-to-fit-all
|
|
566
|
-
- wheel zoom anchored to cursor position for faster navigation in large graphs
|
|
597
|
+
- wheel zoom (including `cmd+scroll` and `ctrl+scroll`) anchored to cursor position for faster navigation in large graphs
|
|
598
|
+
- continuous target-scale interpolation for wheel/button zoom to avoid abrupt jumps while keeping cursor-anchored focus
|
|
599
|
+
- Bloom-like scene navigation: reset fits the current graph scene, wheel zoom stays anchored to the cursor, and WebGL acceleration draws the dense node and edge layer faster
|
|
600
|
+
- zoom-out floor for large and massive graphs to keep the scene reachable without switching into a separate macro graph mode
|
|
601
|
+
- keyboard shortcuts: `+` zoom in, `-` zoom out, `0` reset fit
|
|
602
|
+
- double-click on canvas zooms in at cursor position
|
|
567
603
|
- floating graph totals (notes, links, tags) below the Brainlink title
|
|
568
|
-
-
|
|
604
|
+
- graph rendering safeguards (batched canvas drawing across graph sizes, edge draw caps, lower redraw rate, zoom-aware interaction)
|
|
605
|
+
- adaptive CPU safeguards for large graphs: idle frame pacing, throttled background physics updates and cached viewport dimensions to reduce redraw/layout overhead while preserving interaction responsiveness
|
|
606
|
+
- WebGL node and edge acceleration when supported, falling back to Canvas 2D without changing graph behavior
|
|
607
|
+
- large graph LOD keeps a recursive graph-of-graphs model: zoom-out shows one level of group nodes, zoom-in expands the focused node into its child graph, and deeper zoom repeats the same visual rule without a background glow layer
|
|
569
608
|
|
|
570
609
|
The server indexes before starting by default. Use `--no-index` to skip that step:
|
|
571
610
|
|
|
@@ -667,6 +706,18 @@ blink migrate-vault --from ~/.brainlink/vault --to ./team-vault --report ./migra
|
|
|
667
706
|
Runs explicit markdown migration between vaults while preserving conflicts as `.conflict-<timestamp>` files.
|
|
668
707
|
Use `--dry-run` to preview `copied`, `conflicted` and `unchanged` counts before writing.
|
|
669
708
|
|
|
709
|
+
### `db-import`
|
|
710
|
+
|
|
711
|
+
```bash
|
|
712
|
+
blink db-import --vault ./team-vault
|
|
713
|
+
blink db-import --vault ./team-vault --db ./legacy/brainlink.db
|
|
714
|
+
blink db-import --vault ./team-vault --db ./legacy/brainlink.db --table legacy_notes --dry-run
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
Imports durable memory from a legacy SQLite database into Markdown notes (`agents/<agent-id>/*.md`) and reindexes by default.
|
|
718
|
+
When `--db` is omitted, Brainlink auto-detects common legacy paths such as `<vault>/.brainlink/brainlink.db`.
|
|
719
|
+
Use `--agent <id>` to force all imported rows into one namespace, `--limit` for incremental imports, `--dry-run` to preview without writing files, and `--no-index` to defer reindexing.
|
|
720
|
+
|
|
670
721
|
### `init`
|
|
671
722
|
|
|
672
723
|
```bash
|
|
@@ -691,6 +742,28 @@ blink add "Note Title" --vault ./vault --content-file ./notes.md --no-auto-index
|
|
|
691
742
|
|
|
692
743
|
Creates a Markdown note under `agents/<agent-id>/`. Common secret patterns are blocked by default; use `--allow-sensitive` only for an intentionally protected vault.
|
|
693
744
|
To avoid disconnected memory, Brainlink auto-adds a fallback wiki edge when a note is written without links, creating agent hub notes when needed.
|
|
745
|
+
`add` also returns `possibleDuplicates` (exact hash + semantic candidates) so agents can resolve duplicate memory right after writes.
|
|
746
|
+
|
|
747
|
+
### `dedupe`
|
|
748
|
+
|
|
749
|
+
```bash
|
|
750
|
+
blink dedupe --vault ./vault --json
|
|
751
|
+
blink dedupe --vault ./vault --agent coding-agent --limit 20 --min-score 0.92 --json
|
|
752
|
+
blink dedupe --vault ./vault --no-semantic --json
|
|
753
|
+
```
|
|
754
|
+
|
|
755
|
+
Detects `possibleDuplicate` pairs using exact content hashes and optional semantic similarity.
|
|
756
|
+
|
|
757
|
+
### `dedupe-resolve`
|
|
758
|
+
|
|
759
|
+
```bash
|
|
760
|
+
blink dedupe-resolve --vault ./vault --left agents/shared/a.md --right agents/shared/b.md --action merge --json
|
|
761
|
+
blink dedupe-resolve --vault ./vault --left agents/shared/a.md --right agents/shared/b.md --action link --json
|
|
762
|
+
blink dedupe-resolve --vault ./vault --left agents/shared/a.md --right agents/shared/b.md --action ignore --json
|
|
763
|
+
```
|
|
764
|
+
|
|
765
|
+
Resolves a duplicate pair with `merge`, `link` or `ignore`.
|
|
766
|
+
When action is not `merge`, Brainlink still creates a low-priority related edge (`#related-to`) so notes remain connected.
|
|
694
767
|
|
|
695
768
|
### `index`
|
|
696
769
|
|
|
@@ -701,6 +774,38 @@ blink index --vault ./vault
|
|
|
701
774
|
|
|
702
775
|
Rebuilds the local index from Markdown files.
|
|
703
776
|
|
|
777
|
+
### `bench`
|
|
778
|
+
|
|
779
|
+
```bash
|
|
780
|
+
blink bench --vault ./vault
|
|
781
|
+
blink bench --vault ./vault --watch
|
|
782
|
+
blink bench --vault ./vault --watch --debounce 500
|
|
783
|
+
blink bench --vault ./vault --json
|
|
784
|
+
```
|
|
785
|
+
|
|
786
|
+
Runs indexing with realtime phase telemetry (`start`, `scan`, `parse`, `embed`, `persist`, `packs`, `complete`) and prints a benchmark summary at the end of each run.
|
|
787
|
+
|
|
788
|
+
Summary includes compression behavior for `.blpk` packs when rebuild happens:
|
|
789
|
+
- pack rebuild reason
|
|
790
|
+
- pack count and pack build duration
|
|
791
|
+
- uncompressed input bytes vs compressed output bytes
|
|
792
|
+
- saved percentage
|
|
793
|
+
- objective guardrails (minimum savings and maximum latency regression thresholds)
|
|
794
|
+
|
|
795
|
+
Use `--watch` to keep benchmarking incremental reindex runs after Markdown changes (local filesystem vaults only).
|
|
796
|
+
When `.brainlink/search-packs/manifest.json` is missing but `.blpk` files exist, Brainlink repairs the manifest first and avoids unnecessary full pack rebuild on small edits.
|
|
797
|
+
|
|
798
|
+
### `pack-backup`
|
|
799
|
+
|
|
800
|
+
```bash
|
|
801
|
+
blink pack-backup --vault ./vault
|
|
802
|
+
blink pack-backup --vault ./vault --output ./vault/.brainlink/backups/custom.blpkbak.gz
|
|
803
|
+
blink pack-backup --vault ./vault --json
|
|
804
|
+
```
|
|
805
|
+
|
|
806
|
+
Creates an offline backup artifact of encrypted search packs with a second compression pass.
|
|
807
|
+
This is intentionally outside the online retrieval path (`index`, `search`, `context`).
|
|
808
|
+
|
|
704
809
|
### `agents`
|
|
705
810
|
|
|
706
811
|
```bash
|
|
@@ -723,11 +828,12 @@ If `--mode` or `--limit` is omitted, Brainlink resolves values from the current
|
|
|
723
828
|
|
|
724
829
|
Modes:
|
|
725
830
|
|
|
726
|
-
- `hybrid`: default; combines
|
|
727
|
-
- `fts`: exact lexical retrieval
|
|
831
|
+
- `hybrid`: default; combines lexical matching with local embedding similarity.
|
|
832
|
+
- `fts`: exact lexical retrieval from the file index.
|
|
728
833
|
- `semantic`: local deterministic embedding similarity only.
|
|
729
834
|
|
|
730
835
|
Hybrid results are cached in-memory for a short TTL and invalidated automatically when the local index file changes.
|
|
836
|
+
Context selection uses a middle-out strategy: it starts from the strongest chunk in a note and expands to neighboring chunks while respecting token budget.
|
|
731
837
|
|
|
732
838
|
### `context`
|
|
733
839
|
|
|
@@ -738,6 +844,7 @@ blink context "question" --vault ./vault --agent coding-agent --mode hybrid --js
|
|
|
738
844
|
```
|
|
739
845
|
|
|
740
846
|
Builds a compact context package for an agent.
|
|
847
|
+
Repeated calls with the same vault, agent, query, mode and token/limit settings are served from a short in-memory cache while the index is unchanged.
|
|
741
848
|
|
|
742
849
|
### `links`
|
|
743
850
|
|
|
@@ -822,9 +929,15 @@ Watches Markdown files and rebuilds the index when notes change.
|
|
|
822
929
|
```bash
|
|
823
930
|
blink server --watch
|
|
824
931
|
blink server --vault ./vault --watch
|
|
932
|
+
blink server --vault ./vault --watch --no-open
|
|
825
933
|
```
|
|
826
934
|
|
|
827
935
|
Starts the local read-only graph UI and HTTP API.
|
|
936
|
+
By default, it tries to open a native desktop GUI window for the graph URL.
|
|
937
|
+
On Linux, native GUI is disabled by default; enable it with `BRAINLINK_LINUX_NATIVE_GUI=1`.
|
|
938
|
+
If native GUI launch is unavailable, it falls back to dedicated app-window mode and then browser open.
|
|
939
|
+
When fallback opens Chromium-family browsers on Linux, Brainlink automatically uses compatibility launch flags for stable rendering on Ubuntu/Wayland setups.
|
|
940
|
+
Use `--no-open` to skip that behavior.
|
|
828
941
|
|
|
829
942
|
The HTTP server only binds to loopback hosts such as `127.0.0.1`, `localhost` or `::1`.
|
|
830
943
|
|
|
@@ -865,6 +978,13 @@ If no `vault` is configured and no `--vault` flag is passed, Brainlink uses `$HO
|
|
|
865
978
|
"embeddingProvider": "local",
|
|
866
979
|
"defaultSearchMode": "hybrid",
|
|
867
980
|
"chunkSize": 1200,
|
|
981
|
+
"searchPack": {
|
|
982
|
+
"rowChunkSize": 5000,
|
|
983
|
+
"compressionLevel": 5,
|
|
984
|
+
"useDictionary": true,
|
|
985
|
+
"guardrailMinSavingsPercent": 8,
|
|
986
|
+
"guardrailMaxLatencyRegressionPercent": 5
|
|
987
|
+
},
|
|
868
988
|
"agentProfiles": {
|
|
869
989
|
"coding-agent": {
|
|
870
990
|
"defaultSearchMode": "semantic",
|
|
@@ -976,7 +1096,7 @@ src/
|
|
|
976
1096
|
application/ use cases
|
|
977
1097
|
cli/ command-line adapter
|
|
978
1098
|
domain/ pure knowledge rules
|
|
979
|
-
infrastructure/ filesystem and
|
|
1099
|
+
infrastructure/ filesystem and index adapters
|
|
980
1100
|
```
|
|
981
1101
|
|
|
982
1102
|
Detailed notes:
|
|
@@ -988,7 +1108,6 @@ Detailed notes:
|
|
|
988
1108
|
## Current Limits
|
|
989
1109
|
|
|
990
1110
|
- Semantic search uses deterministic local embeddings, not a remote model provider.
|
|
991
|
-
- Semantic search uses SQLite embedding buckets to narrow candidates before cosine scoring.
|
|
992
1111
|
- `embeddingProvider` currently supports `local` and `none`.
|
|
993
1112
|
- Link resolution is title-based inside each agent namespace, with `shared` as fallback.
|
|
994
1113
|
- HTTP API is local and unauthenticated.
|
|
@@ -999,7 +1118,7 @@ Detailed notes:
|
|
|
999
1118
|
The `0.1.0-beta` line is intended to stabilize the local-first memory loop:
|
|
1000
1119
|
|
|
1001
1120
|
- Markdown as durable memory.
|
|
1002
|
-
-
|
|
1121
|
+
- Rebuildable file index plus local embeddings and encrypted pack exports.
|
|
1003
1122
|
- CLI as the primary agent interface.
|
|
1004
1123
|
- HTTP graph API and frontend as inspection tools.
|
|
1005
1124
|
- Agent namespaces to avoid context mixing.
|
|
@@ -1015,7 +1134,7 @@ Brainlink is local-first by default.
|
|
|
1015
1134
|
- Brainlink HTTP is localhost-only and refuses non-loopback hosts.
|
|
1016
1135
|
- Brainlink blocks common secret patterns by default when adding notes. Use `--allow-sensitive` only for intentional, protected vaults.
|
|
1017
1136
|
- Do not store secrets, credentials, API keys or regulated personal data unless the vault is protected by your own storage controls.
|
|
1018
|
-
- Treat `.brainlink/
|
|
1137
|
+
- Treat `.brainlink/index.json` and `.brainlink/search-packs/` as disposable derived artifacts.
|
|
1019
1138
|
|
|
1020
1139
|
See [SECURITY.md](SECURITY.md).
|
|
1021
1140
|
|
|
@@ -1026,6 +1145,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
1026
1145
|
## License
|
|
1027
1146
|
|
|
1028
1147
|
MIT. See [LICENSE](LICENSE).
|
|
1148
|
+
Copyright (c) 2026 Substructa. See [COPYRIGHT.md](COPYRIGHT.md).
|
|
1029
1149
|
|
|
1030
1150
|
### Memory Optimization Loop (1-7)
|
|
1031
1151
|
|
package/SECURITY.md
CHANGED
|
@@ -7,7 +7,7 @@ Brainlink is local-first.
|
|
|
7
7
|
- The HTTP server binds to `127.0.0.1` by default.
|
|
8
8
|
- The HTTP server always refuses non-loopback hosts.
|
|
9
9
|
- The HTTP server is read-only and does not expose note creation, indexing or update routes.
|
|
10
|
-
-
|
|
10
|
+
- Local index artifacts (`.brainlink/index.json` and `.brainlink/search-packs/`) are derived data.
|
|
11
11
|
- Markdown files are user-owned source data.
|
|
12
12
|
- Brainlink-created Markdown files use `0600` permissions.
|
|
13
13
|
- Brainlink-created directories and `.brainlink` use `0700` permissions.
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
import { stat } from 'node:fs/promises';
|
|
2
|
-
import { existsSync } from 'node:fs';
|
|
3
2
|
import { performance } from 'node:perf_hooks';
|
|
4
|
-
import { join } from 'node:path';
|
|
5
3
|
import { validateGraph, getBrokenLinks, getOrphanNodes, getVaultStats } from '../domain/graph-analysis.js';
|
|
6
4
|
import { ensureVault, listVaultFiles, readMarkdownFiles } from '../infrastructure/file-system-vault.js';
|
|
7
5
|
import { resolveAgentRuntimeDefaults } from '../infrastructure/config.js';
|
|
@@ -96,17 +94,11 @@ export const doctorVault = async (vaultPath) => {
|
|
|
96
94
|
const files = await readMarkdownFiles(absoluteVaultPath);
|
|
97
95
|
const graph = await getGraphSummary(absoluteVaultPath);
|
|
98
96
|
const validation = validateGraph(graph);
|
|
99
|
-
const backupPath = join(absoluteVaultPath, '.brainlink', 'brainlink.db.backup');
|
|
100
|
-
const hasBackup = existsSync(backupPath);
|
|
101
|
-
const backupReady = graph.nodes.length === 0 || hasBackup;
|
|
102
97
|
const checks = [
|
|
103
98
|
createCheck('vault', true, `Vault ready at ${absoluteVaultPath}`),
|
|
104
99
|
createCheck('markdown-files', files.length > 0, `${files.length} markdown files found`),
|
|
105
100
|
createCheck('index', graph.nodes.length > 0, `${graph.nodes.length} indexed documents found`),
|
|
106
|
-
createCheck('broken-links', validation.brokenLinks.length === 0, `${validation.brokenLinks.length} broken links found`)
|
|
107
|
-
createCheck('index-backup', backupReady, backupReady
|
|
108
|
-
? (hasBackup ? 'SQLite recovery snapshot is available' : 'No index yet. Snapshot will be created after first indexing run')
|
|
109
|
-
: 'Recovery snapshot missing. Run blink index to create a rollback snapshot')
|
|
101
|
+
createCheck('broken-links', validation.brokenLinks.length === 0, `${validation.brokenLinks.length} broken links found`)
|
|
110
102
|
];
|
|
111
103
|
const recommendations = files.length === 0 && graph.nodes.length === 0
|
|
112
104
|
? [
|
|
@@ -1,13 +1,68 @@
|
|
|
1
|
+
import { stat } from 'node:fs/promises';
|
|
1
2
|
import { formatContextPackage, selectContextSections } from '../domain/context.js';
|
|
3
|
+
import { indexStoragePath } from '../infrastructure/file-index.js';
|
|
2
4
|
import { searchKnowledge } from './search-knowledge.js';
|
|
5
|
+
const contextCacheTtlMs = 45_000;
|
|
6
|
+
const contextCacheMaxEntries = 200;
|
|
7
|
+
const contextCache = new Map();
|
|
8
|
+
const readIndexMtimeMs = async (vaultPath) => {
|
|
9
|
+
try {
|
|
10
|
+
return (await stat(indexStoragePath(vaultPath))).mtimeMs;
|
|
11
|
+
}
|
|
12
|
+
catch {
|
|
13
|
+
return 0;
|
|
14
|
+
}
|
|
15
|
+
};
|
|
16
|
+
const toCacheKey = (vaultPath, query, limit, maxTokens, agentId, mode) => JSON.stringify({
|
|
17
|
+
vaultPath,
|
|
18
|
+
query: query.trim().toLowerCase(),
|
|
19
|
+
limit,
|
|
20
|
+
maxTokens,
|
|
21
|
+
agentId: agentId?.trim().toLowerCase() ?? '*',
|
|
22
|
+
mode: mode ?? 'default'
|
|
23
|
+
});
|
|
24
|
+
const contextCacheGet = (key, indexMtimeMs) => {
|
|
25
|
+
const entry = contextCache.get(key);
|
|
26
|
+
if (!entry) {
|
|
27
|
+
return undefined;
|
|
28
|
+
}
|
|
29
|
+
const fresh = Date.now() - entry.createdAt <= contextCacheTtlMs && entry.indexMtimeMs === indexMtimeMs;
|
|
30
|
+
if (!fresh) {
|
|
31
|
+
contextCache.delete(key);
|
|
32
|
+
return undefined;
|
|
33
|
+
}
|
|
34
|
+
return entry.context;
|
|
35
|
+
};
|
|
36
|
+
const contextCacheSet = (entry) => {
|
|
37
|
+
contextCache.set(entry.key, entry);
|
|
38
|
+
if (contextCache.size <= contextCacheMaxEntries) {
|
|
39
|
+
return;
|
|
40
|
+
}
|
|
41
|
+
const overflow = contextCache.size - contextCacheMaxEntries;
|
|
42
|
+
const keys = Array.from(contextCache.keys()).slice(0, overflow);
|
|
43
|
+
keys.forEach((key) => contextCache.delete(key));
|
|
44
|
+
};
|
|
3
45
|
export const buildContextPackage = async (vaultPath, query, limit, maxTokens, agentId, mode) => {
|
|
46
|
+
const cacheKey = toCacheKey(vaultPath, query, limit, maxTokens, agentId, mode);
|
|
47
|
+
const indexMtimeMs = await readIndexMtimeMs(vaultPath);
|
|
48
|
+
const cached = contextCacheGet(cacheKey, indexMtimeMs);
|
|
49
|
+
if (cached) {
|
|
50
|
+
return cached;
|
|
51
|
+
}
|
|
4
52
|
const results = await searchKnowledge(vaultPath, query, limit, agentId, mode);
|
|
5
53
|
const sections = selectContextSections(results, maxTokens);
|
|
6
|
-
|
|
54
|
+
const context = {
|
|
7
55
|
query,
|
|
8
56
|
sections,
|
|
9
57
|
content: formatContextPackage(query, sections)
|
|
10
58
|
};
|
|
59
|
+
contextCacheSet({
|
|
60
|
+
key: cacheKey,
|
|
61
|
+
createdAt: Date.now(),
|
|
62
|
+
indexMtimeMs,
|
|
63
|
+
context
|
|
64
|
+
});
|
|
65
|
+
return context;
|
|
11
66
|
};
|
|
12
67
|
export const buildContext = async (vaultPath, query, limit, maxTokens, agentId, mode) => {
|
|
13
68
|
const contextPackage = await buildContextPackage(vaultPath, query, limit, maxTokens, agentId, mode);
|