@felan-ai/ext-codebase-memory 0.0.0 → 0.1.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.
Files changed (4) hide show
  1. package/LICENSE +21 -21
  2. package/NOTICE +16 -16
  3. package/README.md +81 -81
  4. package/package.json +2 -2
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 Felan contributors
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Felan contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/NOTICE CHANGED
@@ -1,16 +1,16 @@
1
- @felan-ai/ext-codebase-memory
2
-
3
- This package adapts selected MIT-licensed behavior and prompt guidance from
4
- pi-cbm 1.2.1 at commit 921a749d5cea74bda8f647542627ef9518fec272
5
- (https://github.com/alexykn/pi-cbm). Copyright (c) 2026 alexykn.
6
-
7
- The runtime integration targets codebase-memory-mcp 0.10.8 at commit
8
- 46ae198fc11cda80e817acbc5f5908d7c2de7032
9
- (https://github.com/DeusData/codebase-memory-mcp), licensed under MIT.
10
-
11
- This package uses TypeBox 1.1.38 from https://github.com/sinclairzx81/typebox,
12
- licensed under the MIT License. Copyright (c) 2017-2026 Haydn Paterson.
13
-
14
- Felan's portable AgentRuntime implementation, binary gating, explicit installer,
15
- bounded grep augmentation, cache policy, and four-tool model surface are Felan
16
- changes. The optional binary is never bundled with this npm package.
1
+ @felan-ai/ext-codebase-memory
2
+
3
+ This package adapts selected MIT-licensed behavior and prompt guidance from
4
+ pi-cbm 1.2.1 at commit 921a749d5cea74bda8f647542627ef9518fec272
5
+ (https://github.com/alexykn/pi-cbm). Copyright (c) 2026 alexykn.
6
+
7
+ The runtime integration targets codebase-memory-mcp 0.10.8 at commit
8
+ 46ae198fc11cda80e817acbc5f5908d7c2de7032
9
+ (https://github.com/DeusData/codebase-memory-mcp), licensed under MIT.
10
+
11
+ This package uses TypeBox 1.1.38 from https://github.com/sinclairzx81/typebox,
12
+ licensed under the MIT License. Copyright (c) 2017-2026 Haydn Paterson.
13
+
14
+ Felan's portable AgentRuntime implementation, binary gating, explicit installer,
15
+ bounded grep augmentation, cache policy, and four-tool model surface are Felan
16
+ changes. The optional binary is never bundled with this npm package.
package/README.md CHANGED
@@ -1,81 +1,81 @@
1
- # @felan-ai/ext-codebase-memory
2
-
3
- Portable structural code exploration for Felan, backed by the reviewed
4
- `codebase-memory-mcp` 0.10.8 native executable.
5
-
6
- ## Behavior
7
-
8
- When the exact reviewed binary is available, the extension registers exactly
9
- four model tools:
10
-
11
- - `codebase_memory` proxies the bounded structural query surface and performs
12
- an explicit `index_repository` refresh for the active git repository.
13
- - `read_symbol` resolves and reads one named symbol.
14
- - `search_and_read_symbols` searches symbols and reads a bounded set of likely
15
- matches.
16
- - `search_code` searches indexed source text.
17
-
18
- The extension indexes once at session startup. It has no file watcher or
19
- periodic refresh. After edits, the model can call
20
- `codebase_memory({ command: "index_repository" })`, and local users can run
21
- `/codebase-memory refresh`. Direct file reads, grep, compiler output, and tests
22
- remain authoritative because an index can be stale.
23
-
24
- Grep and ripgrep calls made through `bash` or Codex `exec_command` receive a
25
- best-effort Codebase Memory appendix by default. Augmentation has its own
26
- 1.5-second deadline, never replaces the original command result, and emits
27
- hit/error telemetry only through a host-supplied callback.
28
-
29
- ## Availability and installation
30
-
31
- The package never bundles or installs a binary automatically. If the binary is
32
- missing, it registers no tools, capability instructions, or model prompt. A
33
- local interactive session shows one installation hint; a cloud host receives a
34
- hard error log while session startup continues without Codebase Memory.
35
-
36
- Local installation is always explicit through `/dependencies` or
37
- `/codebase-memory install`. Felan downloads a commit-pinned upstream installer,
38
- verifies its SHA-256 digest, requests the pinned 0.10.8 release, passes
39
- `--skip-config`, and installs only into `AgentRuntime.storage('agent')`. It
40
- never edits agent or repository configuration. Cloud hosts must place the exact
41
- reviewed binary on `PATH` in the execution image.
42
-
43
- ## Cache and limits
44
-
45
- Codebase Memory data is rooted at
46
- `AgentRuntime.storage('agent')/codebase-memory/cache`, so root sessions and
47
- subagents using the same runtime coordinate through one index. No tenant key is
48
- added inside that already scoped runtime storage.
49
-
50
- - Query timeout: 60 seconds
51
- - Index timeout: 20 minutes
52
- - Combined process output: 5 MiB
53
- - Maximum symbol read: 220 lines
54
- - Cache LRU: 2 GiB for host runtimes; 500 MiB for Docker and Daytona
55
-
56
- Set `extensionConfig.codebaseMemory.maxCacheBytes` to a positive integer to
57
- override the runtime cache limit. The persisted default `0` means “use the
58
- runtime-specific limit”; it is not a zero-byte cache.
59
-
60
- ## Public API
61
-
62
- The default export is the portable extension. Hosts may also use:
63
-
64
- - `createCodebaseMemoryExtension({ telemetry, log })`
65
- - `CODEBASE_MEMORY_CONFIG`
66
- - `inspectCodebaseMemoryRuntime(runtime)`
67
- - `installManagedCodebaseMemory(runtime, onStatus)`
68
- - `MANAGED_CODEBASE_MEMORY_VERSION`
69
-
70
- The binary client, project coordination, and symbol services are internal
71
- implementation details. The package intentionally provides no LSP integration.
72
-
73
- ## Development
74
-
75
- ```sh
76
- pnpm --filter @felan-ai/ext-codebase-memory build
77
- pnpm --filter @felan-ai/ext-codebase-memory type-check
78
- pnpm --filter @felan-ai/ext-codebase-memory test
79
- ```
80
-
81
- See [NOTICE](NOTICE) for the immutable upstream baselines and licensing.
1
+ # @felan-ai/ext-codebase-memory
2
+
3
+ Portable structural code exploration for Felan, backed by the reviewed
4
+ `codebase-memory-mcp` 0.10.8 native executable.
5
+
6
+ ## Behavior
7
+
8
+ When the exact reviewed binary is available, the extension registers exactly
9
+ four model tools:
10
+
11
+ - `codebase_memory` proxies the bounded structural query surface and performs
12
+ an explicit `index_repository` refresh for the active git repository.
13
+ - `read_symbol` resolves and reads one named symbol.
14
+ - `search_and_read_symbols` searches symbols and reads a bounded set of likely
15
+ matches.
16
+ - `search_code` searches indexed source text.
17
+
18
+ The extension indexes once at session startup. It has no file watcher or
19
+ periodic refresh. After edits, the model can call
20
+ `codebase_memory({ command: "index_repository" })`, and local users can run
21
+ `/codebase-memory refresh`. Direct file reads, grep, compiler output, and tests
22
+ remain authoritative because an index can be stale.
23
+
24
+ Grep and ripgrep calls made through `bash` or Codex `exec_command` receive a
25
+ best-effort Codebase Memory appendix by default. Augmentation has its own
26
+ 1.5-second deadline, never replaces the original command result, and emits
27
+ hit/error telemetry only through a host-supplied callback.
28
+
29
+ ## Availability and installation
30
+
31
+ The package never bundles or installs a binary automatically. If the binary is
32
+ missing, it registers no tools, capability instructions, or model prompt. A
33
+ local interactive session shows one installation hint; a cloud host receives a
34
+ hard error log while session startup continues without Codebase Memory.
35
+
36
+ Local installation is always explicit through `/dependencies` or
37
+ `/codebase-memory install`. Felan downloads a commit-pinned upstream installer,
38
+ verifies its SHA-256 digest, requests the pinned 0.10.8 release, passes
39
+ `--skip-config`, and installs only into `AgentRuntime.storage('agent')`. It
40
+ never edits agent or repository configuration. Cloud hosts must place the exact
41
+ reviewed binary on `PATH` in the execution image.
42
+
43
+ ## Cache and limits
44
+
45
+ Codebase Memory data is rooted at
46
+ `AgentRuntime.storage('agent')/codebase-memory/cache`, so root sessions and
47
+ subagents using the same runtime coordinate through one index. No tenant key is
48
+ added inside that already scoped runtime storage.
49
+
50
+ - Query timeout: 60 seconds
51
+ - Index timeout: 20 minutes
52
+ - Combined process output: 5 MiB
53
+ - Maximum symbol read: 220 lines
54
+ - Cache LRU: 2 GiB for host runtimes; 500 MiB for Docker and Daytona
55
+
56
+ Set `extensionConfig.codebaseMemory.maxCacheBytes` to a positive integer to
57
+ override the runtime cache limit. The persisted default `0` means “use the
58
+ runtime-specific limit”; it is not a zero-byte cache.
59
+
60
+ ## Public API
61
+
62
+ The default export is the portable extension. Hosts may also use:
63
+
64
+ - `createCodebaseMemoryExtension({ telemetry, log })`
65
+ - `CODEBASE_MEMORY_CONFIG`
66
+ - `inspectCodebaseMemoryRuntime(runtime)`
67
+ - `installManagedCodebaseMemory(runtime, onStatus)`
68
+ - `MANAGED_CODEBASE_MEMORY_VERSION`
69
+
70
+ The binary client, project coordination, and symbol services are internal
71
+ implementation details. The package intentionally provides no LSP integration.
72
+
73
+ ## Development
74
+
75
+ ```sh
76
+ pnpm --filter @felan-ai/ext-codebase-memory build
77
+ pnpm --filter @felan-ai/ext-codebase-memory type-check
78
+ pnpm --filter @felan-ai/ext-codebase-memory test
79
+ ```
80
+
81
+ See [NOTICE](NOTICE) for the immutable upstream baselines and licensing.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@felan-ai/ext-codebase-memory",
3
- "version": "0.0.0",
3
+ "version": "0.1.0",
4
4
  "description": "Portable Codebase Memory tools and grep augmentation for Felan",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -42,4 +42,4 @@
42
42
  "type-check": "tsc -p tsconfig.json --noEmit",
43
43
  "test": "vitest run"
44
44
  }
45
- }
45
+ }