nlm-memory 0.5.0 → 0.5.2

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 (257) hide show
  1. package/README.md +89 -34
  2. package/dist/cli/digest.d.ts +20 -0
  3. package/dist/cli/digest.js +142 -0
  4. package/dist/cli/digest.js.map +1 -0
  5. package/dist/cli/nlm.d.ts +1 -0
  6. package/dist/cli/nlm.js +25 -1
  7. package/dist/cli/nlm.js.map +1 -1
  8. package/dist/core/digest/compose.d.ts +38 -0
  9. package/dist/core/digest/compose.js +93 -0
  10. package/dist/core/digest/compose.js.map +1 -0
  11. package/dist/core/digest/hook-liveness.d.ts +32 -0
  12. package/dist/core/digest/hook-liveness.js +54 -0
  13. package/dist/core/digest/hook-liveness.js.map +1 -0
  14. package/dist/http/app.js +2 -1
  15. package/dist/http/app.js.map +1 -1
  16. package/dist/mcp/server.js +20 -1
  17. package/dist/mcp/server.js.map +1 -1
  18. package/dist/ui/assets/{index-C8cpwbYJ.css → index-Beo8psd-.css} +1 -1
  19. package/dist/ui/assets/{index-CB50QnL-.js → index-CSPTTeeM.js} +8 -8
  20. package/dist/ui/index.html +2 -2
  21. package/package.json +26 -1
  22. package/.agents/plugins/marketplace.json +0 -20
  23. package/.github/workflows/ci.yml +0 -30
  24. package/docs/methodology/re-derivation-rate.md +0 -112
  25. package/docs/methodology/useful-hit-rate.md +0 -79
  26. package/docs/plans/2026-05-20-fts5-lexical-recall.md +0 -1088
  27. package/docs/plans/2026-05-20-recall-daemon-wedge-fix.md +0 -662
  28. package/docs/plans/2026-05-20-recall-hook-design.md +0 -131
  29. package/docs/plans/2026-05-20-recall-hook-implementation.md +0 -1222
  30. package/docs/plans/desktop-product.md +0 -69
  31. package/docs/plans/factstore-design.md +0 -236
  32. package/logs/CHANGELOG/CHANGELOG-2026.md +0 -1575
  33. package/logs/CHANGELOG/CHANGELOG.md +0 -209
  34. package/migrations/000_initial_schema.sql +0 -174
  35. package/migrations/001_entity_type_rename.sql +0 -17
  36. package/migrations/002_adapter_state_extend.sql +0 -12
  37. package/migrations/003_session_embeddings.sql +0 -11
  38. package/migrations/004_facts.sql +0 -46
  39. package/migrations/005_sources.sql +0 -31
  40. package/migrations/006_providers.sql +0 -33
  41. package/migrations/007_source_tokens.sql +0 -17
  42. package/migrations/008_fts_rebuild.sql +0 -9
  43. package/migrations/009_session_embedding_chunks.sql +0 -46
  44. package/migrations/010_sources_opencode.sql +0 -30
  45. package/migrations/011_sources_hermes_agent.sql +0 -30
  46. package/migrations/012_sources_aider.sql +0 -30
  47. package/migrations/013_adapter_state_failure_count.sql +0 -12
  48. package/migrations/014_sources_cursor.sql +0 -30
  49. package/migrations/015_sources_windsurf.sql +0 -30
  50. package/plugin-hermes-agent/README.md +0 -49
  51. package/plugin-hermes-agent/__init__.py +0 -75
  52. package/plugin-hermes-agent/plugin.yaml +0 -15
  53. package/scripts/backfill-citations.mjs +0 -0
  54. package/scripts/build-codex-plugin.mjs +0 -61
  55. package/scripts/deepseek-probe.mjs +0 -67
  56. package/scripts/extract-triples.mjs +0 -207
  57. package/scripts/longmemeval/embedding-cache.ts +0 -77
  58. package/scripts/longmemeval/fetch-dataset.sh +0 -25
  59. package/scripts/longmemeval/run-harness.ts +0 -315
  60. package/scripts/longmemeval/scorer.ts +0 -99
  61. package/scripts/longmemeval/tsconfig.json +0 -9
  62. package/scripts/longmemeval/types.ts +0 -35
  63. package/scripts/nlm-daily-digest.py +0 -239
  64. package/scripts/nlm-daily-digest.sh +0 -28
  65. package/src/cli/classify-parity.ts +0 -257
  66. package/src/cli/launchctl-helpers.ts +0 -49
  67. package/src/cli/nlm.ts +0 -1078
  68. package/src/core/actions/actions-log.ts +0 -118
  69. package/src/core/actions/overlay.ts +0 -117
  70. package/src/core/adapters/aider.ts +0 -205
  71. package/src/core/adapters/claude-code.ts +0 -293
  72. package/src/core/adapters/common.ts +0 -54
  73. package/src/core/adapters/cursor.ts +0 -486
  74. package/src/core/adapters/from-source.ts +0 -67
  75. package/src/core/adapters/hermes-agent.ts +0 -240
  76. package/src/core/adapters/hermes.ts +0 -277
  77. package/src/core/adapters/jsonl-generic.ts +0 -208
  78. package/src/core/adapters/opencode.ts +0 -281
  79. package/src/core/adapters/pi.ts +0 -264
  80. package/src/core/adapters/windsurf.ts +0 -386
  81. package/src/core/classifier/prompt.ts +0 -200
  82. package/src/core/dataset/build-dataset.ts +0 -463
  83. package/src/core/embedding/chunk-body.ts +0 -76
  84. package/src/core/embedding/embed-backfill.ts +0 -210
  85. package/src/core/embedding/embed-normalize.ts +0 -135
  86. package/src/core/facts/backfill-facts.ts +0 -254
  87. package/src/core/facts/extract-facts.ts +0 -50
  88. package/src/core/hook/citation-detect.ts +0 -124
  89. package/src/core/hook/cite-memo.ts +0 -68
  90. package/src/core/hook/claude-settings.ts +0 -187
  91. package/src/core/hook/gate.ts +0 -25
  92. package/src/core/hook/hook-log.ts +0 -41
  93. package/src/core/hook/memo-sweep.ts +0 -164
  94. package/src/core/hook/memo.ts +0 -67
  95. package/src/core/hook/pointer-block.ts +0 -26
  96. package/src/core/hook/select.ts +0 -32
  97. package/src/core/hook/transcript.ts +0 -121
  98. package/src/core/ingest/ingest-session.ts +0 -111
  99. package/src/core/providers/provider-models.ts +0 -100
  100. package/src/core/providers/provider-registry.ts +0 -196
  101. package/src/core/recall/citation-log.ts +0 -108
  102. package/src/core/recall/filter.ts +0 -27
  103. package/src/core/recall/index.ts +0 -6
  104. package/src/core/recall/match-fields.ts +0 -40
  105. package/src/core/recall/query-log.ts +0 -149
  106. package/src/core/recall/query-shape.ts +0 -66
  107. package/src/core/recall/recall-service.ts +0 -320
  108. package/src/core/recall/recent-log.ts +0 -59
  109. package/src/core/recall/tokenize.ts +0 -18
  110. package/src/core/recall/useful-scan.ts +0 -336
  111. package/src/core/recall-facts/fact-query-log.ts +0 -150
  112. package/src/core/recall-facts/fact-recall-service.ts +0 -327
  113. package/src/core/scheduler/scan-once.ts +0 -142
  114. package/src/core/scheduler/scheduler.ts +0 -225
  115. package/src/core/sources/source-registry.ts +0 -278
  116. package/src/core/storage/db-restore.ts +0 -133
  117. package/src/core/storage/live-status.ts +0 -45
  118. package/src/core/storage/migrate.ts +0 -72
  119. package/src/core/storage/sqlite-fact-store.ts +0 -304
  120. package/src/core/storage/sqlite-session-store.ts +0 -810
  121. package/src/hook/hook-auth.ts +0 -18
  122. package/src/hook/prompt-recall-hook.ts +0 -180
  123. package/src/hook/session-end-hook.ts +0 -81
  124. package/src/hook/session-start-hook.ts +0 -168
  125. package/src/hook/stop-hook.ts +0 -239
  126. package/src/http/app.ts +0 -1215
  127. package/src/install/claude-code.ts +0 -128
  128. package/src/install/codex.ts +0 -367
  129. package/src/install/cursor.ts +0 -68
  130. package/src/install/hermes-agent.ts +0 -76
  131. package/src/install/hermes.ts +0 -78
  132. package/src/install/nlm-dir-perms.ts +0 -55
  133. package/src/install/ollama.ts +0 -284
  134. package/src/install/setup.ts +0 -489
  135. package/src/install/windsurf.ts +0 -68
  136. package/src/llm/classifier-box.ts +0 -64
  137. package/src/llm/deepseek-client.ts +0 -150
  138. package/src/llm/env-autoload.ts +0 -55
  139. package/src/llm/ollama-client.ts +0 -189
  140. package/src/mcp/server.ts +0 -534
  141. package/src/ports/fact-store.ts +0 -102
  142. package/src/ports/llm-client.ts +0 -52
  143. package/src/ports/logger.ts +0 -16
  144. package/src/ports/session-store.ts +0 -45
  145. package/src/ports/transcript-adapter.ts +0 -55
  146. package/src/shared/types.ts +0 -149
  147. package/src/ui/App.tsx +0 -58
  148. package/src/ui/components/PromoteOpenButton.tsx +0 -65
  149. package/src/ui/components/SessionDrawer.tsx +0 -199
  150. package/src/ui/components/SideNav.tsx +0 -162
  151. package/src/ui/components/Skeleton.tsx +0 -107
  152. package/src/ui/index.html +0 -13
  153. package/src/ui/lib/actions.ts +0 -30
  154. package/src/ui/lib/api.ts +0 -92
  155. package/src/ui/lib/dataset.ts +0 -141
  156. package/src/ui/lib/registries.ts +0 -155
  157. package/src/ui/lib/view-settings.ts +0 -41
  158. package/src/ui/main.tsx +0 -15
  159. package/src/ui/pages/Live.tsx +0 -229
  160. package/src/ui/pages/Pulse.tsx +0 -415
  161. package/src/ui/pages/Recall.tsx +0 -190
  162. package/src/ui/pages/River.tsx +0 -354
  163. package/src/ui/pages/Search.tsx +0 -386
  164. package/src/ui/pages/Stub.tsx +0 -9
  165. package/src/ui/pages/Thread.tsx +0 -473
  166. package/src/ui/pages/settings/Classifier.tsx +0 -227
  167. package/src/ui/pages/settings/Data.tsx +0 -190
  168. package/src/ui/pages/settings/Index.tsx +0 -65
  169. package/src/ui/pages/settings/Labels.tsx +0 -224
  170. package/src/ui/pages/settings/Providers.tsx +0 -305
  171. package/src/ui/pages/settings/SettingsSubnav.tsx +0 -28
  172. package/src/ui/pages/settings/Sources.tsx +0 -326
  173. package/src/ui/pages/settings/Views.tsx +0 -96
  174. package/src/ui/styles.css +0 -1890
  175. package/src/ui/tsconfig.json +0 -21
  176. package/src/ui/vite.config.ts +0 -19
  177. package/tests/fixtures/claude_code/short_session.jsonl +0 -2
  178. package/tests/fixtures/claude_code/standard_iso.jsonl +0 -4
  179. package/tests/fixtures/claude_code/tool_heavy.jsonl +0 -8
  180. package/tests/fixtures/claude_code/with_subagent.jsonl +0 -7
  181. package/tests/fixtures/facts.ts +0 -17
  182. package/tests/fixtures/golden-corpus.ts +0 -85
  183. package/tests/fixtures/hermes/paired_request_dump.json +0 -24
  184. package/tests/fixtures/hermes/paired_session.json +0 -23
  185. package/tests/fixtures/hermes/request_dump.json +0 -28
  186. package/tests/fixtures/hermes/session_iso.json +0 -38
  187. package/tests/fixtures/hermes/session_unix.json +0 -38
  188. package/tests/fixtures/hermes/system_only.json +0 -18
  189. package/tests/fixtures/pi/error-connection-abort.jsonl +0 -8
  190. package/tests/fixtures/pi/short-successful.jsonl +0 -5
  191. package/tests/fixtures/pi/with-custom-message.jsonl +0 -6
  192. package/tests/fixtures/sessions.ts +0 -22
  193. package/tests/integration/backfill-facts.test.ts +0 -362
  194. package/tests/integration/citation-explicit.test.ts +0 -111
  195. package/tests/integration/cite-event.test.ts +0 -169
  196. package/tests/integration/cite-memo.test.ts +0 -87
  197. package/tests/integration/db-restore.test.ts +0 -153
  198. package/tests/integration/embed-backfill.test.ts +0 -176
  199. package/tests/integration/fact-supersedence.test.ts +0 -313
  200. package/tests/integration/fts-index.test.ts +0 -60
  201. package/tests/integration/getbyids-sqlite.test.ts +0 -100
  202. package/tests/integration/hermes-agent-hooks.test.ts +0 -248
  203. package/tests/integration/hook-claude-settings.test.ts +0 -218
  204. package/tests/integration/hook-log.test.ts +0 -54
  205. package/tests/integration/hook-memo.test.ts +0 -68
  206. package/tests/integration/hook-pre-compact.test.ts +0 -105
  207. package/tests/integration/hook-subagent-start.test.ts +0 -102
  208. package/tests/integration/http.test.ts +0 -401
  209. package/tests/integration/keyword-search-fts.test.ts +0 -66
  210. package/tests/integration/mcp-recall-logging.test.ts +0 -88
  211. package/tests/integration/mcp.test.ts +0 -260
  212. package/tests/integration/memo-sweep.test.ts +0 -91
  213. package/tests/integration/prompt-recall-hook.test.ts +0 -88
  214. package/tests/integration/provider-registry.test.ts +0 -107
  215. package/tests/integration/recall-golden.test.ts +0 -59
  216. package/tests/integration/recall-sqlite.test.ts +0 -169
  217. package/tests/integration/scheduler.test.ts +0 -391
  218. package/tests/integration/session-end-hook.test.ts +0 -48
  219. package/tests/integration/session-start-hook.test.ts +0 -126
  220. package/tests/integration/source-registry.test.ts +0 -122
  221. package/tests/integration/sqlite-fact-store.test.ts +0 -346
  222. package/tests/integration/stop-hook.test.ts +0 -560
  223. package/tests/integration/wal-checkpoint.test.ts +0 -49
  224. package/tests/unit/cli/launchctl-helpers.test.ts +0 -60
  225. package/tests/unit/core/adapters/aider.test.ts +0 -230
  226. package/tests/unit/core/adapters/claude-code.test.ts +0 -118
  227. package/tests/unit/core/adapters/cursor.test.ts +0 -485
  228. package/tests/unit/core/adapters/hermes-agent.test.ts +0 -329
  229. package/tests/unit/core/adapters/hermes.test.ts +0 -81
  230. package/tests/unit/core/adapters/jsonl-generic.test.ts +0 -142
  231. package/tests/unit/core/adapters/opencode.test.ts +0 -354
  232. package/tests/unit/core/adapters/pi.test.ts +0 -110
  233. package/tests/unit/core/adapters/windsurf.test.ts +0 -416
  234. package/tests/unit/core/classifier/prompt.test.ts +0 -126
  235. package/tests/unit/core/embedding/chunk-body.test.ts +0 -100
  236. package/tests/unit/core/facts/extract-facts.test.ts +0 -117
  237. package/tests/unit/core/filter.test.ts +0 -40
  238. package/tests/unit/core/hook/citation-detect-cite-session.test.ts +0 -96
  239. package/tests/unit/core/hook/citation-detect.test.ts +0 -124
  240. package/tests/unit/core/hook/gate.test.ts +0 -29
  241. package/tests/unit/core/hook/pointer-block.test.ts +0 -22
  242. package/tests/unit/core/hook/select.test.ts +0 -66
  243. package/tests/unit/core/match-fields.test.ts +0 -39
  244. package/tests/unit/core/mcp-cite-session.test.ts +0 -51
  245. package/tests/unit/core/providers/provider-models.test.ts +0 -101
  246. package/tests/unit/core/query-shape.test.ts +0 -92
  247. package/tests/unit/core/recall-facts/fact-recall-service.test.ts +0 -258
  248. package/tests/unit/core/recall-service.test.ts +0 -200
  249. package/tests/unit/core/storage/live-status.test.ts +0 -54
  250. package/tests/unit/core/tokenize.test.ts +0 -32
  251. package/tests/unit/core/useful-scan.test.ts +0 -537
  252. package/tests/unit/llm/embed.test.ts +0 -93
  253. package/tests/unit/llm/ollama-client.test.ts +0 -124
  254. package/tests/unit/scripts/longmemeval-scorer.test.ts +0 -114
  255. package/tsconfig.json +0 -31
  256. package/tsconfig.test.json +0 -11
  257. package/vitest.config.ts +0 -22
@@ -1,78 +0,0 @@
1
- /**
2
- * `nlm connect hermes` / `nlm disconnect hermes` — writes the nlm-memory
3
- * MCP server entry into ~/.hermes/config.yaml.
4
- *
5
- * Uses yaml's Document API (parseDocument / doc.setIn / doc.toString) to
6
- * preserve any comments the user has written in their config file. Round-
7
- * tripping through parse+stringify would silently destroy comments.
8
- */
9
-
10
- import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
11
- import { homedir } from "node:os";
12
- import { dirname, join } from "node:path";
13
- import { Document as YamlDocument, parseDocument as parseYamlDocument } from "yaml";
14
-
15
- export interface ConnectHermesOptions {
16
- readonly nlmBinPath: string;
17
- readonly nodeExecPath: string;
18
- readonly dryRun?: boolean;
19
- }
20
-
21
- export interface ConnectHermesReport {
22
- readonly configPath: string;
23
- readonly alreadyPresent: boolean;
24
- readonly written: boolean;
25
- readonly dryRun: boolean;
26
- }
27
-
28
- export interface DisconnectHermesReport {
29
- readonly configPath: string;
30
- readonly removed: boolean;
31
- readonly dryRun: boolean;
32
- }
33
-
34
- export function hermesConfigPath(): string {
35
- return process.env["NLM_HERMES_CONFIG"] ?? join(homedir(), ".hermes", "config.yaml");
36
- }
37
-
38
- function readDocument(path: string): YamlDocument {
39
- if (!existsSync(path)) return new YamlDocument();
40
- try {
41
- return parseYamlDocument(readFileSync(path, "utf8"));
42
- } catch {
43
- throw new Error(`${path} is not valid YAML. Fix or remove it, then re-run \`nlm connect hermes\`.`);
44
- }
45
- }
46
-
47
- export function connectHermes(opts: ConnectHermesOptions): ConnectHermesReport {
48
- const configPath = hermesConfigPath();
49
- const doc = readDocument(configPath);
50
- const alreadyPresent = doc.getIn(["mcp_servers", "nlm-memory"]) !== undefined;
51
-
52
- if (!opts.dryRun) {
53
- doc.setIn(["mcp_servers", "nlm-memory"], {
54
- command: opts.nodeExecPath,
55
- args: [opts.nlmBinPath, "mcp"],
56
- });
57
- mkdirSync(dirname(configPath), { recursive: true });
58
- writeFileSync(configPath, doc.toString(), "utf8");
59
- }
60
-
61
- return { configPath, alreadyPresent, written: !opts.dryRun, dryRun: opts.dryRun ?? false };
62
- }
63
-
64
- export function disconnectHermes(opts?: { dryRun?: boolean }): DisconnectHermesReport {
65
- const configPath = hermesConfigPath();
66
- const doc = readDocument(configPath);
67
-
68
- if (doc.getIn(["mcp_servers", "nlm-memory"]) === undefined) {
69
- return { configPath, removed: false, dryRun: opts?.dryRun ?? false };
70
- }
71
-
72
- if (!opts?.dryRun) {
73
- doc.deleteIn(["mcp_servers", "nlm-memory"]);
74
- writeFileSync(configPath, doc.toString(), "utf8");
75
- }
76
-
77
- return { configPath, removed: true, dryRun: opts?.dryRun ?? false };
78
- }
@@ -1,55 +0,0 @@
1
- /**
2
- * Idempotent permission hardening for ~/.nlm/.
3
- *
4
- * Recursively sets owner-only perms on the daemon's working directory:
5
- * directories → 0o700
6
- * files → 0o600
7
- *
8
- * Run at every `nlm setup`, `nlm install`, and `nlm start` so installs
9
- * predating v0.4.2 (when explicit chmod was added) self-heal on next
10
- * launch. No-op on Windows — ACLs are the POSIX equivalent and out of
11
- * scope here.
12
- */
13
-
14
- import { chmodSync, existsSync, readdirSync, statSync } from "node:fs";
15
- import { homedir } from "node:os";
16
- import { join } from "node:path";
17
-
18
- export interface PermsHardenResult {
19
- readonly nlmDir: string;
20
- readonly filesHardened: number;
21
- readonly dirsHardened: number;
22
- readonly skipped: number;
23
- }
24
-
25
- export function hardenNlmDirPermissions(
26
- nlmDir: string = join(homedir(), ".nlm"),
27
- ): PermsHardenResult {
28
- const result = { nlmDir, filesHardened: 0, dirsHardened: 0, skipped: 0 };
29
- if (process.platform === "win32") return result;
30
- if (!existsSync(nlmDir)) return result;
31
- walk(nlmDir, result);
32
- return result;
33
- }
34
-
35
- interface MutableResult {
36
- filesHardened: number;
37
- dirsHardened: number;
38
- skipped: number;
39
- }
40
-
41
- function walk(path: string, r: MutableResult): void {
42
- try {
43
- const s = statSync(path);
44
- if (s.isDirectory()) {
45
- chmodSync(path, 0o700);
46
- r.dirsHardened += 1;
47
- for (const name of readdirSync(path)) walk(join(path, name), r);
48
- } else if (s.isFile()) {
49
- chmodSync(path, 0o600);
50
- r.filesHardened += 1;
51
- }
52
- } catch {
53
- r.skipped += 1;
54
- }
55
- }
@@ -1,284 +0,0 @@
1
- /**
2
- * Ollama preflight helpers for `nlm setup`.
3
- *
4
- * Three cases handled:
5
- * 1. Ollama not installed → install it
6
- * 2. Ollama installed, server not responding → start the server
7
- * 3. Embedding model missing → pull it
8
- *
9
- * Platform support:
10
- * macOS — brew install / Ollama.app / brew services / open -a
11
- * Linux — official install.sh / systemctl / detached spawn
12
- * Windows — winget install / detached spawn
13
- */
14
-
15
- import { chmodSync, existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
16
- import { homedir, platform } from "node:os";
17
- import { join } from "node:path";
18
- import { spawnSync, spawn } from "node:child_process";
19
- import { randomBytes } from "node:crypto";
20
-
21
- export const EMBEDDING_MODEL = "nomic-embed-text";
22
- const OS = platform();
23
-
24
- export interface OllamaResult {
25
- readonly ok: boolean;
26
- readonly output: string;
27
- }
28
-
29
- // ── Detection ─────────────────────────────────────────────────────────────
30
-
31
- export function ollamaBinaryAvailable(): boolean {
32
- const r = spawnSync("ollama", ["--version"], { encoding: "utf8" });
33
- return r.status === 0;
34
- }
35
-
36
- /** Returns true if the Ollama server is accepting API requests. */
37
- export function ollamaServerRunning(): boolean {
38
- const r = spawnSync("ollama", ["list"], { encoding: "utf8" });
39
- return r.status === 0;
40
- }
41
-
42
- /** Returns true if nomic-embed-text is present in `ollama list`. */
43
- export function embeddingModelPresent(): boolean {
44
- const r = spawnSync("ollama", ["list"], { encoding: "utf8" });
45
- if (r.status !== 0) return false;
46
- return r.stdout.includes(EMBEDDING_MODEL);
47
- }
48
-
49
- function brewAvailable(): boolean {
50
- return spawnSync("brew", ["--version"], { encoding: "utf8" }).status === 0;
51
- }
52
-
53
- function ollamaAppInstalled(): boolean {
54
- return existsSync("/Applications/Ollama.app");
55
- }
56
-
57
- function wingetAvailable(): boolean {
58
- return spawnSync("winget", ["--version"], { encoding: "utf8", shell: true }).status === 0;
59
- }
60
-
61
- function systemctlAvailable(): boolean {
62
- return spawnSync("systemctl", ["--version"], { encoding: "utf8" }).status === 0;
63
- }
64
-
65
- // ── Install ───────────────────────────────────────────────────────────────
66
-
67
- /**
68
- * Install Ollama using the best available method for the current platform.
69
- * Returns { ok: false } if no automated path exists — caller shows manual instructions.
70
- */
71
- export function installOllama(): OllamaResult {
72
- if (OS === "darwin") {
73
- if (brewAvailable()) {
74
- const r = spawnSync("brew", ["install", "ollama"], { encoding: "utf8" });
75
- return { ok: r.status === 0, output: (r.stdout + r.stderr).trim() };
76
- }
77
- return {
78
- ok: false,
79
- output: "Homebrew not found. Download Ollama from https://ollama.com/download and re-run setup.",
80
- };
81
- }
82
-
83
- if (OS === "linux") {
84
- // Runs: curl -fsSL https://ollama.com/install.sh | sh
85
- // The official Ollama installer — sets up the binary and a systemd service.
86
- // Requires sudo internally and may modify /etc/systemd/. The caller is
87
- // responsible for confirming this with the user before calling.
88
- const r = spawnSync("sh", ["-c", "curl -fsSL --proto '=https' https://ollama.com/install.sh | sh"], {
89
- encoding: "utf8",
90
- timeout: 120_000,
91
- });
92
- return { ok: r.status === 0, output: (r.stdout + r.stderr).trim() };
93
- }
94
-
95
- if (OS === "win32") {
96
- if (wingetAvailable()) {
97
- const r = spawnSync("winget", ["install", "Ollama.Ollama"], { encoding: "utf8", shell: true });
98
- return { ok: r.status === 0, output: (r.stdout + r.stderr).trim() };
99
- }
100
- return {
101
- ok: false,
102
- output: "Download Ollama from https://ollama.com/download and re-run setup.",
103
- };
104
- }
105
-
106
- return { ok: false, output: `Unsupported platform: ${OS}. Install from https://ollama.com/download.` };
107
- }
108
-
109
- // ── Server start ──────────────────────────────────────────────────────────
110
-
111
- /**
112
- * Start the Ollama server in the background.
113
- *
114
- * Platform preference:
115
- * macOS + brew → brew services start ollama
116
- * macOS + app → open -a Ollama
117
- * Linux + systemd → systemctl start ollama (needs sudo; falls back to spawn)
118
- * All others → detached spawn of `ollama serve`
119
- */
120
- export function startOllamaServer(): OllamaResult {
121
- if (OS === "darwin") {
122
- if (brewAvailable()) {
123
- const r = spawnSync("brew", ["services", "start", "ollama"], { encoding: "utf8" });
124
- if (r.status === 0) return { ok: true, output: "Started via brew services" };
125
- }
126
- if (ollamaAppInstalled()) {
127
- const r = spawnSync("open", ["-a", "Ollama"], { encoding: "utf8" });
128
- if (r.status === 0) return { ok: true, output: "Started via Ollama.app" };
129
- }
130
- }
131
-
132
- if (OS === "linux" && systemctlAvailable()) {
133
- // systemctl requires root — try without sudo first (works in user sessions
134
- // where the service is installed under the current user), fall through on failure.
135
- const r = spawnSync("systemctl", ["start", "ollama"], { encoding: "utf8" });
136
- if (r.status === 0) return { ok: true, output: "Started via systemctl" };
137
- }
138
-
139
- // Universal fallback: detach `ollama serve`.
140
- try {
141
- mkdirSync(join(homedir(), ".nlm", "logs"), { recursive: true });
142
- const child = spawn("ollama", ["serve"], {
143
- detached: true,
144
- stdio: "ignore",
145
- });
146
- child.unref();
147
- return { ok: true, output: `ollama serve started (pid ${child.pid})` };
148
- } catch (e) {
149
- return { ok: false, output: e instanceof Error ? e.message : String(e) };
150
- }
151
- }
152
-
153
- /**
154
- * Poll until the Ollama server is accepting requests or maxAttempts is reached.
155
- * Returns true if the server came up, false on timeout.
156
- */
157
- export async function waitForOllamaServer(
158
- maxAttempts = 15,
159
- intervalMs = 1000,
160
- ): Promise<boolean> {
161
- for (let i = 0; i < maxAttempts; i++) {
162
- if (ollamaServerRunning()) return true;
163
- await new Promise((res) => setTimeout(res, intervalMs));
164
- }
165
- return false;
166
- }
167
-
168
- // ── Model pull ────────────────────────────────────────────────────────────
169
-
170
- /**
171
- * Pull the embedding model. Blocks until complete (~1–3 min on first run, a
172
- * few seconds on subsequent runs). The caller shows a spinner during this call.
173
- */
174
- export function pullEmbeddingModel(): OllamaResult {
175
- // Give the server a moment to accept connections if it was just started.
176
- const r = spawnSync("ollama", ["pull", EMBEDDING_MODEL], { encoding: "utf8" });
177
- return { ok: r.status === 0, output: (r.stdout + r.stderr).trim() };
178
- }
179
-
180
- // ── API key / classifier config ───────────────────────────────────────────
181
-
182
- export type ClassifierChoice = "deepseek" | "ollama-offline";
183
-
184
- export interface ClassifierConfigInput {
185
- readonly choice: ClassifierChoice;
186
- readonly model?: string;
187
- readonly apiKey?: string;
188
- }
189
-
190
- /**
191
- * Write classifier config to ~/.nlm/.env. Merges into the existing file —
192
- * only the lines we manage are updated; anything the user added by hand stays.
193
- *
194
- * Manages three keys: DEEPSEEK_API_KEY, NLM_CLASSIFIER, NLM_CLASSIFIER_MODEL.
195
- * Backwards-compatible: passing positional (choice, apiKey) still works.
196
- */
197
- export function writeClassifierConfig(
198
- choiceOrInput: ClassifierChoice | ClassifierConfigInput,
199
- apiKey?: string,
200
- ): void {
201
- const input: ClassifierConfigInput =
202
- typeof choiceOrInput === "string"
203
- ? { choice: choiceOrInput, ...(apiKey !== undefined ? { apiKey } : {}) }
204
- : choiceOrInput;
205
-
206
- const envPath = join(homedir(), ".nlm", ".env");
207
- const nlmDir = join(homedir(), ".nlm");
208
- mkdirSync(nlmDir, { recursive: true, mode: 0o700 });
209
- chmodSync(nlmDir, 0o700);
210
-
211
- const existing = existsSync(envPath) ? readFileSync(envPath, "utf8") : "";
212
- const kept = existing
213
- .split("\n")
214
- .filter(
215
- (l) =>
216
- !l.startsWith("DEEPSEEK_API_KEY=") &&
217
- !l.startsWith("NLM_CLASSIFIER=") &&
218
- !l.startsWith("NLM_CLASSIFIER_MODEL="),
219
- )
220
- .join("\n")
221
- .replace(/\n{3,}/g, "\n\n")
222
- .trim();
223
-
224
- const additions: string[] = [];
225
- if (input.choice === "deepseek") {
226
- additions.push("NLM_CLASSIFIER=deepseek");
227
- if (input.apiKey) {
228
- // Strip newlines that clipboard paste can introduce.
229
- const sanitized = input.apiKey.replace(/[\r\n]/g, "").trim();
230
- additions.push(`DEEPSEEK_API_KEY=${sanitized}`);
231
- }
232
- }
233
- if (input.choice === "ollama-offline") additions.push("NLM_CLASSIFIER=ollama");
234
- if (input.model) additions.push(`NLM_CLASSIFIER_MODEL=${input.model}`);
235
-
236
- writeFileSync(envPath, [kept, ...additions].filter(Boolean).join("\n") + "\n", { mode: 0o600 });
237
- chmodSync(envPath, 0o600);
238
- }
239
-
240
- const TOKEN_BYTES = 32;
241
-
242
- /**
243
- * Generate and persist an NLM_MCP_TOKEN if one isn't already set. Returns
244
- * the token that's active for this process. Called during setup and on
245
- * `nlm start` so installs that pre-date token-gated /api/* still get
246
- * Bearer-protected without operator intervention.
247
- *
248
- * Token is hex-encoded crypto.randomBytes — 64 chars, 256 bits of entropy.
249
- */
250
- export function ensureMcpToken(): string {
251
- const existing = process.env["NLM_MCP_TOKEN"];
252
- if (existing) return existing;
253
-
254
- const token = randomBytes(TOKEN_BYTES).toString("hex");
255
-
256
- const envPath = join(homedir(), ".nlm", ".env");
257
- const nlmDir = join(homedir(), ".nlm");
258
- mkdirSync(nlmDir, { recursive: true, mode: 0o700 });
259
- chmodSync(nlmDir, 0o700);
260
-
261
- const fileExisting = existsSync(envPath) ? readFileSync(envPath, "utf8") : "";
262
- // Idempotent re-read: another setup run could have written the token
263
- // between our env check and now. Prefer the persisted value.
264
- for (const line of fileExisting.split("\n")) {
265
- if (line.startsWith("NLM_MCP_TOKEN=")) {
266
- const persisted = line.slice("NLM_MCP_TOKEN=".length).trim();
267
- if (persisted) {
268
- process.env["NLM_MCP_TOKEN"] = persisted;
269
- return persisted;
270
- }
271
- }
272
- }
273
-
274
- const kept = fileExisting
275
- .split("\n")
276
- .filter((l) => !l.startsWith("NLM_MCP_TOKEN="))
277
- .join("\n")
278
- .replace(/\n{3,}/g, "\n\n")
279
- .trim();
280
- writeFileSync(envPath, [kept, `NLM_MCP_TOKEN=${token}`].filter(Boolean).join("\n") + "\n", { mode: 0o600 });
281
- chmodSync(envPath, 0o600);
282
- process.env["NLM_MCP_TOKEN"] = token;
283
- return token;
284
- }