opencode-codebase-index 0.20.1 → 0.21.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/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.codex-plugin/plugin.json +1 -1
- package/README.md +23 -6
- package/dist/cli.cjs +635 -334
- package/dist/cli.cjs.map +1 -1
- package/dist/cli.js +629 -330
- package/dist/cli.js.map +1 -1
- package/dist/index.cjs +809 -508
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +808 -509
- package/dist/index.js.map +1 -1
- package/dist/pi-extension.cjs +732 -457
- package/dist/pi-extension.cjs.map +1 -1
- package/dist/pi-extension.js +735 -462
- package/dist/pi-extension.js.map +1 -1
- package/native/codebase-index-native.darwin-arm64.node +0 -0
- package/native/codebase-index-native.darwin-x64.node +0 -0
- package/native/codebase-index-native.linux-arm64-gnu.node +0 -0
- package/native/codebase-index-native.linux-x64-gnu.node +0 -0
- package/native/codebase-index-native.win32-x64-msvc.node +0 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,14 +1,16 @@
|
|
|
1
|
-
#
|
|
1
|
+
# open-codebase-index
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/open-codebase-index)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
|
-
[](https://www.npmjs.com/package/open-codebase-index)
|
|
6
6
|
[](https://github.com/Helweg/opencode-codebase-index/actions)
|
|
7
7
|
[](https://nodejs.org/)
|
|
8
8
|
|
|
9
9
|
> Search a codebase by meaning, then follow the result into definitions, callers, and dependency paths.
|
|
10
10
|
|
|
11
|
-
`
|
|
11
|
+
`open-codebase-index` is a local semantic code index for OpenCode, Jcode, Pi, Codex, Claude Code, and other MCP clients. It combines embeddings, BM25 keyword search, branch-aware filtering, symbol lookup, and a call graph behind agent-friendly tools.
|
|
12
|
+
|
|
13
|
+
New installs should use `open-codebase-index` and `open-codebase-index-mcp`. The legacy package `opencode-codebase-index` and `opencode-codebase-index-mcp` remain supported aliases.
|
|
12
14
|
|
|
13
15
|
## Highlights
|
|
14
16
|
|
|
@@ -26,12 +28,26 @@ Requires Node.js 20 or newer.
|
|
|
26
28
|
|
|
27
29
|
1. Install the package:
|
|
28
30
|
|
|
31
|
+
```bash
|
|
32
|
+
npm install open-codebase-index
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Legacy installs continue to work with:
|
|
36
|
+
|
|
29
37
|
```bash
|
|
30
38
|
npm install opencode-codebase-index
|
|
31
39
|
```
|
|
32
40
|
|
|
33
41
|
2. Add it to `opencode.json`:
|
|
34
42
|
|
|
43
|
+
```json
|
|
44
|
+
{
|
|
45
|
+
"plugin": ["open-codebase-index"]
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Legacy alias:
|
|
50
|
+
|
|
35
51
|
```json
|
|
36
52
|
{
|
|
37
53
|
"plugin": ["opencode-codebase-index"]
|
|
@@ -54,7 +70,7 @@ The first index creates embeddings. Later runs reuse unchanged content and proce
|
|
|
54
70
|
| Pi | Pi package | `.codebase-index/` |
|
|
55
71
|
| Codex | Marketplace plugin with MCP and skill guidance | `.codebase-index/` |
|
|
56
72
|
| Claude Code | Marketplace plugin with MCP and skill guidance | `.claude/` |
|
|
57
|
-
| Cursor, Windsurf, other MCP clients | `opencode-codebase-index-mcp` | Selected by `--host`; default is OpenCode-compatible |
|
|
73
|
+
| Cursor, Windsurf, other MCP clients | `open-codebase-index-mcp` (legacy alias: `opencode-codebase-index-mcp`) | Selected by `--host`; default is OpenCode-compatible |
|
|
58
74
|
|
|
59
75
|
See [Installation and host setup](docs/installation.md) for complete instructions.
|
|
60
76
|
|
|
@@ -157,7 +173,7 @@ Only specify values you want to override. See [Configuration](docs/configuration
|
|
|
157
173
|
|
|
158
174
|
## Branch-aware indexing
|
|
159
175
|
|
|
160
|
-
The index stores reusable content by hash and maintains branch catalogs for chunks and symbols. On a branch switch, unchanged content can be reused while results remain scoped to the active branch.
|
|
176
|
+
The index stores reusable content by hash and maintains branch catalogs for chunks and symbols. On a branch switch, unchanged content can be reused while results remain scoped to the active branch. Linked worktrees without a local project config share the main checkout's portable project index; adding a worktree-local config creates an isolated index boundary.
|
|
161
177
|
|
|
162
178
|
## Knowledge bases and reranking
|
|
163
179
|
|
|
@@ -209,6 +225,7 @@ Native changes require Rust and `npm run build:native`. See [Contributing](CONTR
|
|
|
209
225
|
- [Evaluation](docs/evaluation.md)
|
|
210
226
|
- [Cross-repository benchmarking](docs/benchmarking-cross-repo.md)
|
|
211
227
|
- [Adding language support](docs/adding-language-support.md)
|
|
228
|
+
- [Future `open-codebase-index` rename plan](docs/rename-to-open-codebase-index.md)
|
|
212
229
|
- [Contributing](CONTRIBUTING.md)
|
|
213
230
|
- [Security](SECURITY.md)
|
|
214
231
|
- [Changelog](CHANGELOG.md)
|