claude-db 0.4.1 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +399 -0
- package/README.md +62 -94
- package/dist/capture/command.d.ts +0 -14
- package/dist/capture/command.js +0 -23
- package/dist/capture/flush.d.ts +1 -50
- package/dist/capture/flush.js +4 -63
- package/dist/capture/git.js +0 -20
- package/dist/capture/identity.d.ts +0 -17
- package/dist/capture/identity.js +1 -21
- package/dist/capture/index.d.ts +1 -0
- package/dist/capture/index.js +1 -0
- package/dist/capture/manual.d.ts +0 -19
- package/dist/capture/manual.js +0 -0
- package/dist/capture/progress.d.ts +4 -0
- package/dist/capture/progress.js +33 -0
- package/dist/capture/transcript.d.ts +0 -45
- package/dist/capture/transcript.js +4 -70
- package/dist/capture/turn-extractor.d.ts +0 -15
- package/dist/capture/turn-extractor.js +1 -104
- package/dist/cli/args.d.ts +4 -0
- package/dist/cli/args.js +16 -0
- package/dist/cli/commands/doctor.d.ts +1 -0
- package/dist/cli/commands/doctor.js +76 -0
- package/dist/cli/commands/graph.d.ts +2 -0
- package/dist/cli/commands/graph.js +93 -0
- package/dist/cli/commands/insight.d.ts +3 -0
- package/dist/cli/commands/insight.js +129 -0
- package/dist/cli/commands/maintain.d.ts +3 -0
- package/dist/cli/commands/maintain.js +77 -0
- package/dist/cli/commands/memory.d.ts +3 -0
- package/dist/cli/commands/memory.js +77 -0
- package/dist/cli/commands/seed.d.ts +1 -0
- package/dist/cli/commands/seed.js +43 -0
- package/dist/cli/commands/setup.d.ts +4 -0
- package/dist/cli/commands/setup.js +156 -0
- package/dist/cli/commands/sync.d.ts +1 -0
- package/dist/cli/commands/sync.js +95 -0
- package/dist/cli/commands/transfer.d.ts +9 -0
- package/dist/cli/commands/transfer.js +129 -0
- package/dist/cli/commands/use.d.ts +1 -0
- package/dist/cli/commands/use.js +90 -0
- package/dist/cli/constants.d.ts +2 -0
- package/dist/cli/constants.js +4 -0
- package/dist/cli/files.d.ts +4 -0
- package/dist/cli/files.js +33 -0
- package/dist/cli/index.js +15 -1080
- package/dist/cli/install.d.ts +1 -59
- package/dist/cli/install.js +5 -194
- package/dist/cli/instructions.d.ts +5 -0
- package/dist/cli/instructions.js +55 -0
- package/dist/cli/paths.d.ts +5 -0
- package/dist/cli/paths.js +19 -0
- package/dist/cli/refresh.d.ts +1 -0
- package/dist/cli/refresh.js +25 -0
- package/dist/cli/usage.d.ts +1 -0
- package/dist/cli/usage.js +39 -0
- package/dist/config/load.d.ts +0 -5
- package/dist/config/load.js +1 -8
- package/dist/config/schema.js +2 -58
- package/dist/context.d.ts +0 -10
- package/dist/context.js +0 -16
- package/dist/embed/builtin.d.ts +0 -12
- package/dist/embed/builtin.js +0 -20
- package/dist/embed/embedder.d.ts +0 -14
- package/dist/embed/embedder.js +0 -1
- package/dist/embed/index.d.ts +0 -9
- package/dist/embed/index.js +0 -9
- package/dist/embed/local.d.ts +0 -8
- package/dist/embed/local.js +0 -12
- package/dist/graph/index.d.ts +7 -0
- package/dist/graph/index.js +4 -0
- package/dist/graph/languages/ecmascript.d.ts +4 -0
- package/dist/graph/languages/ecmascript.js +47 -0
- package/dist/graph/languages/go.d.ts +2 -0
- package/dist/graph/languages/go.js +15 -0
- package/dist/graph/languages/index.d.ts +6 -0
- package/dist/graph/languages/index.js +20 -0
- package/dist/graph/languages/python.d.ts +2 -0
- package/dist/graph/languages/python.js +15 -0
- package/dist/graph/languages/rules.d.ts +18 -0
- package/dist/graph/languages/rules.js +1 -0
- package/dist/graph/languages/rust.d.ts +2 -0
- package/dist/graph/languages/rust.js +16 -0
- package/dist/graph/parser.d.ts +31 -0
- package/dist/graph/parser.js +29 -0
- package/dist/graph/query/format.d.ts +2 -0
- package/dist/graph/query/format.js +41 -0
- package/dist/graph/query/index.d.ts +5 -0
- package/dist/graph/query/index.js +4 -0
- package/dist/graph/query/lookup.d.ts +21 -0
- package/dist/graph/query/lookup.js +35 -0
- package/dist/graph/query/path.d.ts +2 -0
- package/dist/graph/query/path.js +48 -0
- package/dist/graph/query/refresh.d.ts +2 -0
- package/dist/graph/query/refresh.js +21 -0
- package/dist/graph/scan/extract.d.ts +15 -0
- package/dist/graph/scan/extract.js +101 -0
- package/dist/graph/scan/files.d.ts +12 -0
- package/dist/graph/scan/files.js +51 -0
- package/dist/graph/scan/index.d.ts +18 -0
- package/dist/graph/scan/index.js +44 -0
- package/dist/graph/scan/resolve.d.ts +3 -0
- package/dist/graph/scan/resolve.js +48 -0
- package/dist/hooks/payload.d.ts +0 -8
- package/dist/hooks/payload.js +0 -6
- package/dist/hooks/relevance.d.ts +0 -17
- package/dist/hooks/relevance.js +55 -38
- package/dist/hooks/session-end.js +0 -11
- package/dist/hooks/session-start.js +33 -14
- package/dist/hooks/user-prompt.js +0 -18
- package/dist/mcp/render.d.ts +0 -20
- package/dist/mcp/render.js +0 -39
- package/dist/mcp/server.js +46 -25
- package/dist/search/rank.d.ts +0 -14
- package/dist/search/rank.js +0 -16
- package/dist/search/service.d.ts +1 -32
- package/dist/search/service.js +1 -36
- package/dist/store/adapter.d.ts +11 -44
- package/dist/store/adapter.js +1 -12
- package/dist/store/index.d.ts +0 -11
- package/dist/store/index.js +0 -11
- package/dist/store/mongo/docs.d.ts +61 -0
- package/dist/store/mongo/docs.js +106 -0
- package/dist/store/mongo/driver.d.ts +1 -15
- package/dist/store/mongo/driver.js +0 -15
- package/dist/store/mongo/filters.d.ts +6 -0
- package/dist/store/mongo/filters.js +18 -0
- package/dist/store/mongo/graph.d.ts +12 -0
- package/dist/store/mongo/graph.js +61 -0
- package/dist/store/mongo/helpers.d.ts +2 -0
- package/dist/store/mongo/helpers.js +8 -0
- package/dist/store/mongo/index.d.ts +16 -13
- package/dist/store/mongo/index.js +52 -295
- package/dist/store/mongo/observations.d.ts +10 -0
- package/dist/store/mongo/observations.js +97 -0
- package/dist/store/mongo/search.d.ts +6 -0
- package/dist/store/mongo/search.js +51 -0
- package/dist/store/mongo/sessions.d.ts +6 -0
- package/dist/store/mongo/sessions.js +24 -0
- package/dist/store/mongo/vectorSearch.d.ts +5 -0
- package/dist/store/mongo/vectorSearch.js +57 -0
- package/dist/store/postgres/driver.d.ts +19 -0
- package/dist/store/postgres/driver.js +13 -0
- package/dist/store/postgres/filters.d.ts +2 -0
- package/dist/store/postgres/filters.js +22 -0
- package/dist/store/postgres/graph.d.ts +11 -0
- package/dist/store/postgres/graph.js +115 -0
- package/dist/store/postgres/index.d.ts +20 -33
- package/dist/store/postgres/index.js +43 -428
- package/dist/store/postgres/insert.d.ts +3 -0
- package/dist/store/postgres/insert.js +59 -0
- package/dist/store/postgres/meta.d.ts +10 -0
- package/dist/store/postgres/meta.js +54 -0
- package/dist/store/postgres/observations.d.ts +10 -0
- package/dist/store/postgres/observations.js +139 -0
- package/dist/store/postgres/rows.d.ts +6 -0
- package/dist/store/postgres/rows.js +74 -0
- package/dist/store/postgres/schema.d.ts +3 -0
- package/dist/store/postgres/schema.js +84 -0
- package/dist/store/postgres/search.d.ts +3 -0
- package/dist/store/postgres/search.js +20 -0
- package/dist/store/postgres/sessions.d.ts +5 -0
- package/dist/store/postgres/sessions.js +26 -0
- package/dist/store/postgres/vectorSearch.d.ts +3 -0
- package/dist/store/postgres/vectorSearch.js +21 -0
- package/dist/store/sqlite/filters.d.ts +9 -0
- package/dist/store/sqlite/filters.js +77 -0
- package/dist/store/sqlite/graph.d.ts +11 -0
- package/dist/store/sqlite/graph.js +100 -0
- package/dist/store/sqlite/index.d.ts +12 -10
- package/dist/store/sqlite/index.js +41 -379
- package/dist/store/sqlite/observations.d.ts +10 -0
- package/dist/store/sqlite/observations.js +128 -0
- package/dist/store/sqlite/rows.d.ts +8 -0
- package/dist/store/sqlite/rows.js +84 -0
- package/dist/store/sqlite/schema.sql +42 -2
- package/dist/store/sqlite/search.d.ts +5 -0
- package/dist/store/sqlite/search.js +86 -0
- package/dist/store/sqlite/sessions.d.ts +5 -0
- package/dist/store/sqlite/sessions.js +21 -0
- package/dist/types.d.ts +47 -40
- package/dist/types.js +0 -4
- package/dist/update.d.ts +0 -20
- package/dist/update.js +4 -29
- package/dist/usages/find.d.ts +2 -8
- package/dist/usages/find.js +51 -54
- package/dist/usages/index.d.ts +1 -1
- package/dist/usages/index.js +1 -1
- package/dist/util/project.d.ts +0 -12
- package/dist/util/project.js +0 -24
- package/dist/util/scope.d.ts +0 -9
- package/dist/util/scope.js +0 -9
- package/dist/util/shortid.d.ts +0 -5
- package/dist/util/shortid.js +1 -19
- package/dist/util/snippet.d.ts +0 -26
- package/dist/util/snippet.js +0 -30
- package/dist/util/vector.d.ts +0 -12
- package/dist/util/vector.js +0 -12
- package/dist/util/warnings.d.ts +0 -11
- package/dist/util/warnings.js +0 -11
- package/docs/how-it-works.md +183 -0
- package/package.json +14 -3
- package/skills/cdb-scan/SKILL.md +31 -6
package/dist/cli/install.d.ts
CHANGED
|
@@ -1,62 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
/**
|
|
3
|
-
* Where Claude Code reads settings from.
|
|
4
|
-
*
|
|
5
|
-
* `project` writes `settings.local.json` inside the target repo, which Claude
|
|
6
|
-
* Code already treats as personal and gitignores. That makes it the right
|
|
7
|
-
* choice for trying memory on one repo without touching every session on the
|
|
8
|
-
* machine, and it is trivially reversible by deleting one file.
|
|
9
|
-
*/
|
|
10
|
-
export declare function settingsPathFor(scope: Scope, project: string): string;
|
|
11
|
-
/**
|
|
12
|
-
* Where standing instructions go.
|
|
13
|
-
*
|
|
14
|
-
* Hook output is injected as conversation context, which the agent reads as
|
|
15
|
-
* information about the current turn. It is not a rule, so "you could search
|
|
16
|
-
* memory" competes with everything else in the transcript and loses. A memory
|
|
17
|
-
* file is part of the system prompt and governs the whole session, which is
|
|
18
|
-
* the only reliable way to make recall a default rather than a suggestion.
|
|
19
|
-
*
|
|
20
|
-
* Project scope writes CLAUDE.local.md rather than CLAUDE.md: it is personal
|
|
21
|
-
* and uncommitted, matching settings.local.json, so installing memory for
|
|
22
|
-
* yourself never tells a teammate's agent to call a server they do not have.
|
|
23
|
-
*/
|
|
24
|
-
export declare function instructionsPathFor(scope: Scope, project: string): string;
|
|
25
|
-
/**
|
|
26
|
-
* Where the `/cdb-scan` skill is installed.
|
|
27
|
-
*
|
|
28
|
-
* A skill rather than a CLI command: surveying a codebase means reading it, and
|
|
29
|
-
* the agent is already sitting in the repo with the tools to do that. A command
|
|
30
|
-
* would need its own model, its own key and its own opinion about what matters.
|
|
31
|
-
*/
|
|
32
|
-
export declare function skillPathFor(scope: Scope, project: string): string;
|
|
33
|
-
/**
|
|
34
|
-
* MCP servers live in a different file from hooks.
|
|
35
|
-
*
|
|
36
|
-
* Claude Code reads project-scoped MCP servers from `.mcp.json` at the repo
|
|
37
|
-
* root, not from `settings.local.json`. Writing them alongside the hooks looks
|
|
38
|
-
* correct and silently does nothing: the hooks fire, the tools never appear,
|
|
39
|
-
* and the session-start text ends up advertising tools that do not exist.
|
|
40
|
-
*/
|
|
41
|
-
export declare function mcpPathFor(scope: Scope, project: string): string;
|
|
42
|
-
/**
|
|
43
|
-
* Registers the three lifecycle hooks and the MCP server, merging into whatever
|
|
44
|
-
* the user already has rather than overwriting it. Re-running is safe: a hook
|
|
45
|
-
* whose command already appears is skipped rather than duplicated.
|
|
46
|
-
*/
|
|
47
|
-
/**
|
|
48
|
-
* Refuses to install from a location that will not survive.
|
|
49
|
-
*
|
|
50
|
-
* Hooks are registered as absolute paths to this build. `npx` unpacks into
|
|
51
|
-
* `~/.npm/_npx/<hash>/`, which npm evicts on its own schedule, so an install
|
|
52
|
-
* from there works until the cache is cleared and then fails silently on every
|
|
53
|
-
* hook forever after. Failing loudly now is far better than a memory system
|
|
54
|
-
* that quietly stops recording weeks later.
|
|
55
|
-
*/
|
|
1
|
+
import { Scope } from './paths.js';
|
|
56
2
|
export declare function assertStableLocation(distDir: string): void;
|
|
57
3
|
export declare function install(distDir: string, scope: Scope, project: string): string;
|
|
58
|
-
/**
|
|
59
|
-
* Removes only what `install` added, leaving unrelated hooks and servers in
|
|
60
|
-
* place. Empty containers are pruned so an uninstall leaves no residue.
|
|
61
|
-
*/
|
|
62
4
|
export declare function uninstall(distDir: string, scope: Scope, project: string): string | null;
|
package/dist/cli/install.js
CHANGED
|
@@ -1,53 +1,12 @@
|
|
|
1
|
+
import { instructionsPathFor, mcpPathFor, settingsPathFor, skillPathFor } from './paths.js';
|
|
2
|
+
import { dirname, resolve } from 'node:path';
|
|
1
3
|
import { execFileSync } from 'node:child_process';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
/**
|
|
6
|
-
* Where Claude Code reads settings from.
|
|
7
|
-
*
|
|
8
|
-
* `project` writes `settings.local.json` inside the target repo, which Claude
|
|
9
|
-
* Code already treats as personal and gitignores. That makes it the right
|
|
10
|
-
* choice for trying memory on one repo without touching every session on the
|
|
11
|
-
* machine, and it is trivially reversible by deleting one file.
|
|
12
|
-
*/
|
|
13
|
-
export function settingsPathFor(scope, project) {
|
|
14
|
-
return scope === 'project'
|
|
15
|
-
? join(project, '.claude', 'settings.local.json')
|
|
16
|
-
: join(homedir(), '.claude', 'settings.json');
|
|
17
|
-
}
|
|
18
|
-
/**
|
|
19
|
-
* Where standing instructions go.
|
|
20
|
-
*
|
|
21
|
-
* Hook output is injected as conversation context, which the agent reads as
|
|
22
|
-
* information about the current turn. It is not a rule, so "you could search
|
|
23
|
-
* memory" competes with everything else in the transcript and loses. A memory
|
|
24
|
-
* file is part of the system prompt and governs the whole session, which is
|
|
25
|
-
* the only reliable way to make recall a default rather than a suggestion.
|
|
26
|
-
*
|
|
27
|
-
* Project scope writes CLAUDE.local.md rather than CLAUDE.md: it is personal
|
|
28
|
-
* and uncommitted, matching settings.local.json, so installing memory for
|
|
29
|
-
* yourself never tells a teammate's agent to call a server they do not have.
|
|
30
|
-
*/
|
|
31
|
-
export function instructionsPathFor(scope, project) {
|
|
32
|
-
return scope === 'project'
|
|
33
|
-
? join(project, 'CLAUDE.local.md')
|
|
34
|
-
: join(homedir(), '.claude', 'CLAUDE.md');
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* Where the `/cdb-scan` skill is installed.
|
|
38
|
-
*
|
|
39
|
-
* A skill rather than a CLI command: surveying a codebase means reading it, and
|
|
40
|
-
* the agent is already sitting in the repo with the tools to do that. A command
|
|
41
|
-
* would need its own model, its own key and its own opinion about what matters.
|
|
42
|
-
*/
|
|
43
|
-
export function skillPathFor(scope, project) {
|
|
44
|
-
const root = scope === 'project' ? join(project, '.claude') : join(homedir(), '.claude');
|
|
45
|
-
return join(root, 'skills', 'cdb-scan', 'SKILL.md');
|
|
46
|
-
}
|
|
4
|
+
import { readJson, readText, writeAtomic, writeJson } from './files.js';
|
|
5
|
+
import { removeInstructions, writeInstructions } from './instructions.js';
|
|
6
|
+
import { rmSync } from 'node:fs';
|
|
47
7
|
function writeSkill(distDir, scope, project) {
|
|
48
8
|
const source = resolve(distDir, '..', 'skills', 'cdb-scan', 'SKILL.md');
|
|
49
9
|
const body = readText(source);
|
|
50
|
-
// Absent only in a partial checkout; the rest of the install still stands.
|
|
51
10
|
if (body.length > 0)
|
|
52
11
|
writeAtomic(skillPathFor(scope, project), body);
|
|
53
12
|
}
|
|
@@ -55,114 +14,12 @@ function removeSkill(scope, project) {
|
|
|
55
14
|
const path = skillPathFor(scope, project);
|
|
56
15
|
rmSync(dirname(path), { recursive: true, force: true });
|
|
57
16
|
}
|
|
58
|
-
const BLOCK_START = '<!-- claude-db:start -->';
|
|
59
|
-
const BLOCK_END = '<!-- claude-db:end -->';
|
|
60
|
-
const INSTRUCTIONS = [
|
|
61
|
-
BLOCK_START,
|
|
62
|
-
'## Project memory',
|
|
63
|
-
'',
|
|
64
|
-
'This project has persistent memory of past sessions, served by the `memory`',
|
|
65
|
-
'MCP server. Session summaries are injected at startup and the best matching',
|
|
66
|
-
'observation is injected above each prompt, but that is only ever a slice.',
|
|
67
|
-
'',
|
|
68
|
-
'Search it *before* re-deriving something this project already knows. That',
|
|
69
|
-
'means before grepping or reading git history to reconstruct why something is',
|
|
70
|
-
'the way it is, before saying you lack context, and before asking the user to',
|
|
71
|
-
're-explain a past decision or a failed approach: call `search`, then',
|
|
72
|
-
'`get_observations` for the ids worth reading.',
|
|
73
|
-
'',
|
|
74
|
-
'Verifying against the code afterwards is right — memory records what was',
|
|
75
|
-
'done, the source shows what is. Starting there is what wastes the memory.',
|
|
76
|
-
'',
|
|
77
|
-
'`search` covers *why*: past decisions, bugs, reasoning. `find_usages` is',
|
|
78
|
-
'the default the moment a question is about a symbol or identifier — before',
|
|
79
|
-
'editing or removing a shared or exported name, or to look one up at all —',
|
|
80
|
-
'since it tags the likely definition and re-derives the answer from the',
|
|
81
|
-
'current source on every call, so it is never stale. grep still wins for',
|
|
82
|
-
'everything that is not a code identifier: plain text, log files, comments,',
|
|
83
|
-
'strings, and scoping with grep flags `find_usages` does not expose.',
|
|
84
|
-
'',
|
|
85
|
-
'When the user states a standing rule or preference, record it with',
|
|
86
|
-
'`remember` so it survives this session.',
|
|
87
|
-
BLOCK_END,
|
|
88
|
-
].join('\n');
|
|
89
|
-
/** Adds or refreshes our block, leaving everything else in the file intact. */
|
|
90
|
-
function writeInstructions(path) {
|
|
91
|
-
const rest = withoutBlock(readText(path)).trimEnd();
|
|
92
|
-
const body = rest.length > 0 ? `${rest}\n\n${INSTRUCTIONS}\n` : `${INSTRUCTIONS}\n`;
|
|
93
|
-
writeAtomic(path, body);
|
|
94
|
-
}
|
|
95
|
-
function removeInstructions(path) {
|
|
96
|
-
const existing = readText(path);
|
|
97
|
-
if (!existing.includes(BLOCK_START))
|
|
98
|
-
return;
|
|
99
|
-
const rest = withoutBlock(existing).trim();
|
|
100
|
-
// A file that held nothing but our block was ours to create, so take it with
|
|
101
|
-
// us rather than leaving an empty CLAUDE.md behind.
|
|
102
|
-
if (rest.length === 0)
|
|
103
|
-
rmSync(path, { force: true });
|
|
104
|
-
else
|
|
105
|
-
writeAtomic(path, `${rest}\n`);
|
|
106
|
-
}
|
|
107
|
-
function withoutBlock(text) {
|
|
108
|
-
const start = text.indexOf(BLOCK_START);
|
|
109
|
-
const end = text.indexOf(BLOCK_END);
|
|
110
|
-
if (start === -1 || end === -1 || end < start)
|
|
111
|
-
return text;
|
|
112
|
-
return `${text.slice(0, start)}${text.slice(end + BLOCK_END.length)}`.replace(/\n{3,}/g, '\n\n');
|
|
113
|
-
}
|
|
114
|
-
function readText(path) {
|
|
115
|
-
try {
|
|
116
|
-
return readFileSync(path, 'utf8');
|
|
117
|
-
}
|
|
118
|
-
catch {
|
|
119
|
-
return '';
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* MCP servers live in a different file from hooks.
|
|
124
|
-
*
|
|
125
|
-
* Claude Code reads project-scoped MCP servers from `.mcp.json` at the repo
|
|
126
|
-
* root, not from `settings.local.json`. Writing them alongside the hooks looks
|
|
127
|
-
* correct and silently does nothing: the hooks fire, the tools never appear,
|
|
128
|
-
* and the session-start text ends up advertising tools that do not exist.
|
|
129
|
-
*/
|
|
130
|
-
export function mcpPathFor(scope, project) {
|
|
131
|
-
return scope === 'project'
|
|
132
|
-
? join(project, '.mcp.json')
|
|
133
|
-
: join(homedir(), '.claude.json');
|
|
134
|
-
}
|
|
135
|
-
/**
|
|
136
|
-
* Three hooks, not four.
|
|
137
|
-
*
|
|
138
|
-
* There is deliberately no PostToolUse hook. It fired after every single tool
|
|
139
|
-
* call and existed only to journal file paths, which the transcript already
|
|
140
|
-
* records in far more detail. Removing it deletes the most frequently invoked
|
|
141
|
-
* process in the system and loses nothing.
|
|
142
|
-
*/
|
|
143
17
|
const HOOKS = [
|
|
144
18
|
['SessionStart', 'session-start.js'],
|
|
145
19
|
['UserPromptSubmit', 'user-prompt.js'],
|
|
146
20
|
['SessionEnd', 'session-end.js'],
|
|
147
21
|
];
|
|
148
|
-
/**
|
|
149
|
-
* Registers the three lifecycle hooks and the MCP server, merging into whatever
|
|
150
|
-
* the user already has rather than overwriting it. Re-running is safe: a hook
|
|
151
|
-
* whose command already appears is skipped rather than duplicated.
|
|
152
|
-
*/
|
|
153
|
-
/**
|
|
154
|
-
* Refuses to install from a location that will not survive.
|
|
155
|
-
*
|
|
156
|
-
* Hooks are registered as absolute paths to this build. `npx` unpacks into
|
|
157
|
-
* `~/.npm/_npx/<hash>/`, which npm evicts on its own schedule, so an install
|
|
158
|
-
* from there works until the cache is cleared and then fails silently on every
|
|
159
|
-
* hook forever after. Failing loudly now is far better than a memory system
|
|
160
|
-
* that quietly stops recording weeks later.
|
|
161
|
-
*/
|
|
162
22
|
export function assertStableLocation(distDir) {
|
|
163
|
-
// Only npm's own scratch areas. Matching on `/tmp/` generally would be a
|
|
164
|
-
// false positive: a global prefix can legitimately live anywhere, and
|
|
165
|
-
// refusing a valid install is worse than the problem being guarded against.
|
|
166
23
|
const ephemeral = ['_npx', '_cacache'];
|
|
167
24
|
const segments = distDir.split('/');
|
|
168
25
|
if (!ephemeral.some((name) => segments.includes(name)))
|
|
@@ -190,17 +47,11 @@ export function install(distDir, scope, project) {
|
|
|
190
47
|
hooks[event] = existing;
|
|
191
48
|
}
|
|
192
49
|
settings['hooks'] = hooks;
|
|
193
|
-
// Never write mcpServers here; Claude Code ignores it in this file.
|
|
194
50
|
delete settings['mcpServers'];
|
|
195
51
|
writeJson(path, settings);
|
|
196
52
|
const server = resolve(distDir, 'mcp', 'server.js');
|
|
197
53
|
writeInstructions(instructionsPathFor(scope, project));
|
|
198
54
|
writeSkill(distDir, scope, project);
|
|
199
|
-
// A global install lands in ~/.claude.json, which holds all of Claude Code's
|
|
200
|
-
// own state. Let its CLI own that file rather than round-tripping megabytes
|
|
201
|
-
// of someone else's config through JSON.parse to add one key. The direct
|
|
202
|
-
// write stays as a fallback, since `claude` is not always on PATH, and it is
|
|
203
|
-
// the right thing for the project scope: .mcp.json is small and ours.
|
|
204
55
|
if (scope === 'global' && registerViaCli(server))
|
|
205
56
|
return path;
|
|
206
57
|
const mcpPath = mcpPathFor(scope, project);
|
|
@@ -211,7 +62,6 @@ export function install(distDir, scope, project) {
|
|
|
211
62
|
writeJson(mcpPath, mcpConfig);
|
|
212
63
|
return path;
|
|
213
64
|
}
|
|
214
|
-
/** Both directions of the `claude mcp` CLI, false when it is unavailable. */
|
|
215
65
|
function claudeMcp(args) {
|
|
216
66
|
try {
|
|
217
67
|
execFileSync('claude', args, { stdio: 'ignore' });
|
|
@@ -222,15 +72,9 @@ function claudeMcp(args) {
|
|
|
222
72
|
}
|
|
223
73
|
}
|
|
224
74
|
function registerViaCli(server) {
|
|
225
|
-
// Removed first because `add` refuses an existing name, and re-running
|
|
226
|
-
// install has to stay safe.
|
|
227
75
|
claudeMcp(['mcp', 'remove', 'memory', '-s', 'user']);
|
|
228
76
|
return claudeMcp(['mcp', 'add', 'memory', '-s', 'user', '--', 'node', server]);
|
|
229
77
|
}
|
|
230
|
-
/**
|
|
231
|
-
* Removes only what `install` added, leaving unrelated hooks and servers in
|
|
232
|
-
* place. Empty containers are pruned so an uninstall leaves no residue.
|
|
233
|
-
*/
|
|
234
78
|
export function uninstall(distDir, scope, project) {
|
|
235
79
|
const path = settingsPathFor(scope, project);
|
|
236
80
|
const settings = readJson(path);
|
|
@@ -257,15 +101,11 @@ export function uninstall(distDir, scope, project) {
|
|
|
257
101
|
writeJson(path, settings);
|
|
258
102
|
removeInstructions(instructionsPathFor(scope, project));
|
|
259
103
|
removeSkill(scope, project);
|
|
260
|
-
// Symmetric with install: if the CLI put it there, the CLI takes it out.
|
|
261
104
|
if (scope === 'global' && claudeMcp(['mcp', 'remove', 'memory', '-s', 'user'])) {
|
|
262
105
|
return path;
|
|
263
106
|
}
|
|
264
107
|
const mcpPath = mcpPathFor(scope, project);
|
|
265
108
|
const mcpConfig = readJson(mcpPath);
|
|
266
|
-
// Captured before the delete below can empty it. Testing emptiness
|
|
267
|
-
// afterwards skipped the write for a config holding only our server, which
|
|
268
|
-
// is the common case, so uninstall silently left it registered.
|
|
269
109
|
const existed = Object.keys(mcpConfig).length > 0;
|
|
270
110
|
const servers = (mcpConfig['mcpServers'] ?? {});
|
|
271
111
|
delete servers['memory'];
|
|
@@ -280,32 +120,3 @@ export function uninstall(distDir, scope, project) {
|
|
|
280
120
|
function hookCommand(distDir, file) {
|
|
281
121
|
return `node ${resolve(distDir, 'hooks', file)}`;
|
|
282
122
|
}
|
|
283
|
-
function readJson(path) {
|
|
284
|
-
try {
|
|
285
|
-
return JSON.parse(readFileSync(path, 'utf8'));
|
|
286
|
-
}
|
|
287
|
-
catch {
|
|
288
|
-
return {};
|
|
289
|
-
}
|
|
290
|
-
}
|
|
291
|
-
/**
|
|
292
|
-
* Written through a temporary file and renamed, because one of these targets
|
|
293
|
-
* is `~/.claude.json`, which holds all of Claude Code's own state. Truncating
|
|
294
|
-
* it and dying midway to add a single key would cost the user real data;
|
|
295
|
-
* rename is atomic, so the file is either the old one or the new one.
|
|
296
|
-
*/
|
|
297
|
-
function writeJson(path, value) {
|
|
298
|
-
writeAtomic(path, `${JSON.stringify(value, null, 2)}\n`);
|
|
299
|
-
}
|
|
300
|
-
function writeAtomic(path, content) {
|
|
301
|
-
mkdirSync(dirname(path), { recursive: true });
|
|
302
|
-
const temp = `${path}.${process.pid}.tmp`;
|
|
303
|
-
try {
|
|
304
|
-
writeFileSync(temp, content, 'utf8');
|
|
305
|
-
renameSync(temp, path);
|
|
306
|
-
}
|
|
307
|
-
catch (error) {
|
|
308
|
-
rmSync(temp, { force: true });
|
|
309
|
-
throw error;
|
|
310
|
-
}
|
|
311
|
-
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export declare const BLOCK_START = "<!-- claude-db:start -->";
|
|
2
|
+
export declare const BLOCK_END = "<!-- claude-db:end -->";
|
|
3
|
+
export declare const INSTRUCTIONS: string;
|
|
4
|
+
export declare function writeInstructions(path: string): void;
|
|
5
|
+
export declare function removeInstructions(path: string): void;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { readText, writeAtomic } from './files.js';
|
|
2
|
+
import { rmSync } from 'node:fs';
|
|
3
|
+
export const BLOCK_START = '<!-- claude-db:start -->';
|
|
4
|
+
export const BLOCK_END = '<!-- claude-db:end -->';
|
|
5
|
+
export const INSTRUCTIONS = [
|
|
6
|
+
BLOCK_START,
|
|
7
|
+
'## Project memory',
|
|
8
|
+
'',
|
|
9
|
+
'This project has persistent memory of past sessions, served by the `memory`',
|
|
10
|
+
'MCP server. Session summaries are injected at startup and the best matching',
|
|
11
|
+
'observation is injected above each prompt, but that is only ever a slice.',
|
|
12
|
+
'',
|
|
13
|
+
'Search it *before* re-deriving something this project already knows. That',
|
|
14
|
+
'means before grepping or reading git history to reconstruct why something is',
|
|
15
|
+
'the way it is, before saying you lack context, and before asking the user to',
|
|
16
|
+
're-explain a past decision or a failed approach: call `search`, then',
|
|
17
|
+
'`get_observations` for the ids worth reading.',
|
|
18
|
+
'',
|
|
19
|
+
'Verifying against the code afterwards is right — memory records what was',
|
|
20
|
+
'done, the source shows what is. Starting there is what wastes the memory.',
|
|
21
|
+
'',
|
|
22
|
+
'`search` covers *why*: past decisions, bugs, reasoning. `find_usages` is',
|
|
23
|
+
'the default the moment a question is about a symbol or identifier — before',
|
|
24
|
+
'editing or removing a shared or exported name, or to look one up at all —',
|
|
25
|
+
'since it tags the likely definition and re-derives the answer from the',
|
|
26
|
+
'current source on every call, so it is never stale. grep still wins for',
|
|
27
|
+
'everything that is not a code identifier: plain text, log files, comments,',
|
|
28
|
+
'strings, and scoping with grep flags `find_usages` does not expose.',
|
|
29
|
+
'',
|
|
30
|
+
'When the user states a standing rule or preference, record it with',
|
|
31
|
+
'`remember` so it survives this session.',
|
|
32
|
+
BLOCK_END,
|
|
33
|
+
].join('\n');
|
|
34
|
+
export function writeInstructions(path) {
|
|
35
|
+
const rest = withoutBlock(readText(path)).trimEnd();
|
|
36
|
+
const body = rest.length > 0 ? `${rest}\n\n${INSTRUCTIONS}\n` : `${INSTRUCTIONS}\n`;
|
|
37
|
+
writeAtomic(path, body);
|
|
38
|
+
}
|
|
39
|
+
export function removeInstructions(path) {
|
|
40
|
+
const existing = readText(path);
|
|
41
|
+
if (!existing.includes(BLOCK_START))
|
|
42
|
+
return;
|
|
43
|
+
const rest = withoutBlock(existing).trim();
|
|
44
|
+
if (rest.length === 0)
|
|
45
|
+
rmSync(path, { force: true });
|
|
46
|
+
else
|
|
47
|
+
writeAtomic(path, `${rest}\n`);
|
|
48
|
+
}
|
|
49
|
+
function withoutBlock(text) {
|
|
50
|
+
const start = text.indexOf(BLOCK_START);
|
|
51
|
+
const end = text.indexOf(BLOCK_END);
|
|
52
|
+
if (start === -1 || end === -1 || end < start)
|
|
53
|
+
return text;
|
|
54
|
+
return `${text.slice(0, start)}${text.slice(end + BLOCK_END.length)}`.replace(/\n{3,}/g, '\n\n');
|
|
55
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export type Scope = 'global' | 'project';
|
|
2
|
+
export declare function settingsPathFor(scope: Scope, project: string): string;
|
|
3
|
+
export declare function instructionsPathFor(scope: Scope, project: string): string;
|
|
4
|
+
export declare function skillPathFor(scope: Scope, project: string): string;
|
|
5
|
+
export declare function mcpPathFor(scope: Scope, project: string): string;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { homedir } from 'node:os';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
export function settingsPathFor(scope, project) {
|
|
4
|
+
return scope === 'project'
|
|
5
|
+
? join(project, '.claude', 'settings.local.json')
|
|
6
|
+
: join(homedir(), '.claude', 'settings.json');
|
|
7
|
+
}
|
|
8
|
+
export function instructionsPathFor(scope, project) {
|
|
9
|
+
return scope === 'project'
|
|
10
|
+
? join(project, 'CLAUDE.local.md')
|
|
11
|
+
: join(homedir(), '.claude', 'CLAUDE.md');
|
|
12
|
+
}
|
|
13
|
+
export function skillPathFor(scope, project) {
|
|
14
|
+
const root = scope === 'project' ? join(project, '.claude') : join(homedir(), '.claude');
|
|
15
|
+
return join(root, 'skills', 'cdb-scan', 'SKILL.md');
|
|
16
|
+
}
|
|
17
|
+
export function mcpPathFor(scope, project) {
|
|
18
|
+
return scope === 'project' ? join(project, '.mcp.json') : join(homedir(), '.claude.json');
|
|
19
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function refreshInstalled(distDir: string, project: string): string[];
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { BLOCK_START, INSTRUCTIONS, writeInstructions } from './instructions.js';
|
|
2
|
+
import { instructionsPathFor, skillPathFor } from './paths.js';
|
|
3
|
+
import { readText, writeAtomic } from './files.js';
|
|
4
|
+
import { resolve } from 'node:path';
|
|
5
|
+
export function refreshInstalled(distDir, project) {
|
|
6
|
+
const refreshed = [];
|
|
7
|
+
for (const scope of ['project', 'global']) {
|
|
8
|
+
const skillPath = skillPathFor(scope, project);
|
|
9
|
+
const current = readText(skillPath);
|
|
10
|
+
if (current.length > 0) {
|
|
11
|
+
const packaged = readText(resolve(distDir, '..', 'skills', 'cdb-scan', 'SKILL.md'));
|
|
12
|
+
if (packaged.length > 0 && packaged !== current) {
|
|
13
|
+
writeAtomic(skillPath, packaged);
|
|
14
|
+
refreshed.push(skillPath);
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
const instructionsPath = instructionsPathFor(scope, project);
|
|
18
|
+
const existing = readText(instructionsPath);
|
|
19
|
+
if (existing.includes(BLOCK_START) && !existing.includes(INSTRUCTIONS)) {
|
|
20
|
+
writeInstructions(instructionsPath);
|
|
21
|
+
refreshed.push(instructionsPath);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
return refreshed;
|
|
25
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function usage(): void;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
export function usage() {
|
|
2
|
+
console.log(`claude-db
|
|
3
|
+
|
|
4
|
+
install [--project] Register hooks + MCP server with Claude Code
|
|
5
|
+
uninstall [--project] Remove them again, leaving memory intact
|
|
6
|
+
status Is it wired up, and has it recorded anything
|
|
7
|
+
doctor [--deep] Show resolved config; --deep proves a full
|
|
8
|
+
write, search, recall and delete round trip
|
|
9
|
+
use [--force] <url> Point memory at a database, once it answers
|
|
10
|
+
search [--all] <query> Search memory, this project or every project
|
|
11
|
+
[--tag <name>] ...limited to one repo or top-level directory
|
|
12
|
+
remember [--kind k] <text> Record something outright, e.g. a house rule
|
|
13
|
+
[--key <name>] ...under a stable name, replacing any earlier one
|
|
14
|
+
forget <id> [id...] Delete specific observations by id
|
|
15
|
+
projects List every project with memory in this database
|
|
16
|
+
merge [<old-path>] [--yes] Move memory from an old project path onto this one
|
|
17
|
+
stats What this project's memory is made of
|
|
18
|
+
flush Re-ingest every transcript for this project
|
|
19
|
+
seed --from-git [--limit n] Fill a cold memory from this repo's history
|
|
20
|
+
usages [--regex] <symbol> Find real usages via git grep, current source only
|
|
21
|
+
[--context n] [--path <dir>] [--limit n]
|
|
22
|
+
export [--all] > out.jsonl Dump memory as JSONL, for backup or migration
|
|
23
|
+
import <file.jsonl> Load a dump back in (safe to repeat)
|
|
24
|
+
sync <url> [--yes] Two-way merge with another database
|
|
25
|
+
update Install a newer compatible release now
|
|
26
|
+
reembed Re-embed everything with the current model
|
|
27
|
+
prune --older-than <days> Delete old memory (dry run without --yes)
|
|
28
|
+
reset [--project] --yes Delete stored memory (dry run without --yes)
|
|
29
|
+
|
|
30
|
+
--project scope to the current repo via .claude/settings.local.json
|
|
31
|
+
instead of every project on this machine
|
|
32
|
+
|
|
33
|
+
Connection strings:
|
|
34
|
+
mongodb+srv://user:pass@cluster.mongodb.net/memory
|
|
35
|
+
postgres://user:pass@host:5432/memory
|
|
36
|
+
/path/to/memory.db (SQLite, default)
|
|
37
|
+
|
|
38
|
+
Or set CLAUDE_DB_URL in the environment to override config.json.`);
|
|
39
|
+
}
|
package/dist/config/load.d.ts
CHANGED
|
@@ -2,10 +2,5 @@ import type { Config } from './schema.js';
|
|
|
2
2
|
export declare const CONFIG_DIR: string;
|
|
3
3
|
export declare const CONFIG_PATH: string;
|
|
4
4
|
export declare const DEFAULT_DB_PATH: string;
|
|
5
|
-
/**
|
|
6
|
-
* Precedence: CLAUDE_DB_URL env var, then config.json, then a local SQLite
|
|
7
|
-
* file. The env var wins so CI and containers can point at a shared database
|
|
8
|
-
* without rewriting config on disk.
|
|
9
|
-
*/
|
|
10
5
|
export declare function loadConfig(): Config;
|
|
11
6
|
export declare function saveConfig(config: Config): void;
|
package/dist/config/load.js
CHANGED
|
@@ -5,19 +5,12 @@ import { ConfigSchema } from './schema.js';
|
|
|
5
5
|
export const CONFIG_DIR = join(homedir(), '.claude-memory');
|
|
6
6
|
export const CONFIG_PATH = join(CONFIG_DIR, 'config.json');
|
|
7
7
|
export const DEFAULT_DB_PATH = join(CONFIG_DIR, 'memory.db');
|
|
8
|
-
/**
|
|
9
|
-
* Precedence: CLAUDE_DB_URL env var, then config.json, then a local SQLite
|
|
10
|
-
* file. The env var wins so CI and containers can point at a shared database
|
|
11
|
-
* without rewriting config on disk.
|
|
12
|
-
*/
|
|
13
8
|
export function loadConfig() {
|
|
14
9
|
let fileConfig = {};
|
|
15
10
|
try {
|
|
16
11
|
fileConfig = JSON.parse(readFileSync(CONFIG_PATH, 'utf8'));
|
|
17
12
|
}
|
|
18
|
-
catch {
|
|
19
|
-
// Missing or unreadable config is not an error; defaults apply.
|
|
20
|
-
}
|
|
13
|
+
catch { }
|
|
21
14
|
const config = ConfigSchema.parse(fileConfig);
|
|
22
15
|
const envUrl = process.env['CLAUDE_DB_URL']?.trim();
|
|
23
16
|
return {
|
package/dist/config/schema.js
CHANGED
|
@@ -1,85 +1,29 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
export const ConfigSchema = z.object({
|
|
3
|
-
/**
|
|
4
|
-
* Any supported connection string. Scheme selects the adapter.
|
|
5
|
-
* Defaults to a local SQLite file so the tool works before configuration.
|
|
6
|
-
*/
|
|
7
3
|
database: z.string().default(''),
|
|
8
4
|
embeddings: z
|
|
9
5
|
.object({
|
|
10
6
|
provider: z.enum(['auto', 'local', 'builtin', 'none']).default('auto'),
|
|
11
|
-
/**
|
|
12
|
-
* Ceiling on how many vectors a brute-force backend will score in one
|
|
13
|
-
* query. Scanning is linear, so this converts an unbounded tail latency
|
|
14
|
-
* into a fixed one: the newest N observations in scope are scored and
|
|
15
|
-
* older ones are reachable through keyword search. Backends with a real
|
|
16
|
-
* vector index (pgvector, Atlas) ignore this.
|
|
17
|
-
*/
|
|
18
7
|
maxScanCandidates: z.number().int().positive().default(25000),
|
|
19
|
-
/**
|
|
20
|
-
* How long to wait for the embedding model before giving up for this
|
|
21
|
-
* one invocation and falling back to keyword-only search. The model is
|
|
22
|
-
* fetched and loaded lazily inside a hook that runs on the critical path
|
|
23
|
-
* of a prompt, so an unbounded wait is a hung prompt. 0 disables the
|
|
24
|
-
* limit, which is what `doctor` uses to warm the model deliberately.
|
|
25
|
-
*/
|
|
26
8
|
timeoutMs: z.number().int().nonnegative().default(3000),
|
|
27
9
|
})
|
|
28
10
|
.default({ provider: 'auto', maxScanCandidates: 25000, timeoutMs: 3000 }),
|
|
29
|
-
/**
|
|
30
|
-
* `notify` mentions a newer release at session start; `auto` also installs
|
|
31
|
-
* it; `off` never asks.
|
|
32
|
-
*
|
|
33
|
-
* Notify is the default. Installing on someone's behalf means executing code
|
|
34
|
-
* they did not choose, in a process holding their whole memory database, and
|
|
35
|
-
* it turns a single bad publish into silent execution everywhere. The nudge
|
|
36
|
-
* is what actually matters here: this tool fails silently by design — hooks
|
|
37
|
-
* swallow their errors so they can never break a session — so a user left on
|
|
38
|
-
* a broken release sees no error, just memory that never fills up.
|
|
39
|
-
*/
|
|
40
11
|
updates: z.enum(['auto', 'notify', 'off']).default('notify'),
|
|
41
12
|
capture: z
|
|
42
13
|
.object({
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
.array(z.string())
|
|
46
|
-
.default(['Edit', 'Write', 'Bash', 'NotebookEdit']),
|
|
47
|
-
/** Glob-ish fragments; matching paths are never persisted. */
|
|
48
|
-
exclude: z
|
|
49
|
-
.array(z.string())
|
|
50
|
-
.default(['.env', 'secrets', 'node_modules', '.git/']),
|
|
14
|
+
tools: z.array(z.string()).default(['Edit', 'Write', 'Bash', 'NotebookEdit']),
|
|
15
|
+
exclude: z.array(z.string()).default(['.env', 'secrets', 'node_modules', '.git/']),
|
|
51
16
|
maxBodyChars: z.number().int().positive().default(4000),
|
|
52
17
|
})
|
|
53
|
-
// `prefault` rather than `default`: zod 4 requires a `default` to satisfy
|
|
54
|
-
// the full output type, so `{}` is rejected even though every field below
|
|
55
|
-
// supplies its own default. `prefault` substitutes on the input side and
|
|
56
|
-
// lets those field defaults fill the object in.
|
|
57
18
|
.prefault({}),
|
|
58
19
|
inject: z
|
|
59
20
|
.object({
|
|
60
|
-
/** Session summaries pulled in at SessionStart. */
|
|
61
21
|
sessions: z.number().int().nonnegative().default(5),
|
|
62
|
-
/** Hard ceiling on SessionStart context, in characters. */
|
|
63
22
|
maxChars: z.number().int().positive().default(6000),
|
|
64
|
-
/**
|
|
65
|
-
* Search memory on every prompt and inject matching titles.
|
|
66
|
-
* Set false to fall back to tool-only recall, where Claude decides.
|
|
67
|
-
*/
|
|
68
23
|
perPrompt: z.boolean().default(true),
|
|
69
|
-
/** How many titles a per-prompt injection may surface. */
|
|
70
24
|
promptResults: z.number().int().positive().max(10).default(4),
|
|
71
|
-
/** Character ceiling for the per-prompt block. Roughly 4 chars a token. */
|
|
72
25
|
promptMaxChars: z.number().int().positive().default(500),
|
|
73
|
-
/**
|
|
74
|
-
* How many top matches to inject in full rather than as a title.
|
|
75
|
-
*
|
|
76
|
-
* Titles alone require the agent to decide to call get_observations,
|
|
77
|
-
* which reintroduces exactly the "it might not bother" failure that
|
|
78
|
-
* automatic injection exists to remove. Expanding the single best match
|
|
79
|
-
* delivers the reasoning without a round trip.
|
|
80
|
-
*/
|
|
81
26
|
expandTop: z.number().int().min(0).max(3).default(1),
|
|
82
|
-
/** Character ceiling for each expanded body. */
|
|
83
27
|
expandMaxChars: z.number().int().positive().default(900),
|
|
84
28
|
})
|
|
85
29
|
.prefault({}),
|
package/dist/context.d.ts
CHANGED
|
@@ -5,18 +5,8 @@ import type { MemoryStore } from './store/adapter.js';
|
|
|
5
5
|
export interface RecallContext {
|
|
6
6
|
config: Config;
|
|
7
7
|
store: MemoryStore;
|
|
8
|
-
/** Resolves the embedder, constructing it on first use. */
|
|
9
8
|
embedder(): Promise<Embedder>;
|
|
10
9
|
search: SearchService;
|
|
11
10
|
close(): Promise<void>;
|
|
12
11
|
}
|
|
13
|
-
/**
|
|
14
|
-
* Single composition root. Everything else takes its dependencies as
|
|
15
|
-
* constructor arguments, which keeps the units testable with fakes.
|
|
16
|
-
*
|
|
17
|
-
* The embedder is created lazily because `provider: auto` probes the model
|
|
18
|
-
* with a real inference call to decide whether it works. That probe is the
|
|
19
|
-
* single most expensive thing in a hook, and hooks that never embed (a trivial
|
|
20
|
-
* prompt, a status query) should not pay for it.
|
|
21
|
-
*/
|
|
22
12
|
export declare function createContext(overrides?: Partial<Config>): Promise<RecallContext>;
|
package/dist/context.js
CHANGED
|
@@ -2,15 +2,6 @@ import { loadConfig } from './config/index.js';
|
|
|
2
2
|
import { createEmbedder, NoopEmbedder } from './embed/index.js';
|
|
3
3
|
import { SearchService } from './search/index.js';
|
|
4
4
|
import { createStore } from './store/index.js';
|
|
5
|
-
/**
|
|
6
|
-
* Single composition root. Everything else takes its dependencies as
|
|
7
|
-
* constructor arguments, which keeps the units testable with fakes.
|
|
8
|
-
*
|
|
9
|
-
* The embedder is created lazily because `provider: auto` probes the model
|
|
10
|
-
* with a real inference call to decide whether it works. That probe is the
|
|
11
|
-
* single most expensive thing in a hook, and hooks that never embed (a trivial
|
|
12
|
-
* prompt, a status query) should not pay for it.
|
|
13
|
-
*/
|
|
14
5
|
export async function createContext(overrides) {
|
|
15
6
|
const config = { ...loadConfig(), ...overrides };
|
|
16
7
|
const store = await createStore(config.database);
|
|
@@ -23,13 +14,6 @@ export async function createContext(overrides) {
|
|
|
23
14
|
const search = new SearchService(store, embedder, config.embeddings.maxScanCandidates);
|
|
24
15
|
return { config, store, embedder, search, close: () => store.close() };
|
|
25
16
|
}
|
|
26
|
-
/**
|
|
27
|
-
* The first use of a local model downloads ~25MB and loads it, inside a hook
|
|
28
|
-
* that is blocking the user's prompt. Bounding that turns a hung prompt into
|
|
29
|
-
* one prompt with keyword-only recall; the next invocation finds the model
|
|
30
|
-
* cached. Falls back to no embedder rather than to the builtin, so a timeout
|
|
31
|
-
* never mixes a second vector width into the database.
|
|
32
|
-
*/
|
|
33
17
|
async function withTimeout(pending, ms) {
|
|
34
18
|
if (ms <= 0)
|
|
35
19
|
return pending;
|