Skip to content

Commit bcac3fa

Browse files
committed
docs: audit + launch prep — fix embedding model, expand CLI previews
- capabilities.md: fix CRITICAL bug — default embedding is bge-small-en-v1.5, not Granite (Granite is opt-in via EMBEDDING_MODEL env var) - README: add metadata, refs, cycles CLI preview boxes (real output) - README: add EMBEDDING_MODEL config row - README: fix markup typo in VS Code snippet - .gitignore: add docs/visuals.md (local-only launch notes)
1 parent b7bc5cc commit bcac3fa

File tree

3 files changed

+41
-3
lines changed

3 files changed

+41
-3
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ nul
2020
.codebase-intelligence.json
2121
.cursor/
2222
.planning/*
23-
23+
.planning-archive/*
24+
.codex/
2425
grammars/*.wasm
2526

2627
.tmp-research-repos/
28+
docs/visuals.md

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Add `.vscode/mcp.json` to your project root:
5757
"servers": {
5858
"codebase-context": {
5959
"command": "npx",
60-
"args": ["-y", "codebase-context", "/path/to/your/project"] // Or "${workspaceFolder}"if your workspace is one project only
60+
"args": ["-y", "codebase-context", "/path/to/your/project"] // Or "${workspaceFolder}" if your workspace is one project only
6161
}
6262
}
6363
}
@@ -143,6 +143,41 @@ $ npx -y codebase-context search --query "file watcher" --intent edit --limit 1
143143
└──────────────────────────────────────────────────────────────────────┘
144144
```
145145

146+
```text
147+
$ npx -y codebase-context metadata
148+
┌─ codebase-context [monorepo] ────────────────────────────────────────┐
149+
│ │
150+
│ Framework: Angular unknown Architecture: mixed │
151+
│ 130 files · 24,211 lines · 1077 components │
152+
│ │
153+
│ Dependencies: @huggingface/transformers · @lancedb/lancedb · │
154+
│ @modelcontextprotocol/sdk · @typescript-eslint/typescript-estree · │
155+
│ chokidar · fuse.js (+14 more) │
156+
│ │
157+
└──────────────────────────────────────────────────────────────────────┘
158+
```
159+
160+
```text
161+
$ npx -y codebase-context refs --symbol "startFileWatcher"
162+
┌─ startFileWatcher ─── 11 references ─── static analysis ─────────────┐
163+
│ │
164+
│ startFileWatcher │
165+
│ │ │
166+
│ ├─ file-watcher.test.ts:5 │
167+
│ │ import { startFileWatcher } from '../src/core/file-watcher.... │
168+
│ │
169+
└──────────────────────────────────────────────────────────────────────┘
170+
```
171+
172+
```text
173+
$ npx -y codebase-context cycles
174+
┌─ Circular Dependencies ──────────────────────────────────────────────┐
175+
│ │
176+
│ No cycles found · 98 files · 260 edges · 2.7 avg deps │
177+
│ │
178+
└──────────────────────────────────────────────────────────────────────┘
179+
```
180+
146181
See `docs/cli.md` for the full CLI gallery.
147182

148183
## What It Actually Does
@@ -273,6 +308,7 @@ Structured filters available: `framework`, `language`, `componentType`, `layer`
273308
| `OPENAI_API_KEY` | - | Required only if using `openai` provider |
274309
| `CODEBASE_ROOT` | - | Project root (CLI arg takes precedence) |
275310
| `CODEBASE_CONTEXT_DEBUG` | - | Set to `1` for verbose logging |
311+
| `EMBEDDING_MODEL` | `Xenova/bge-small-en-v1.5` | Local embedding model override (e.g. `ibm-granite/granite-embedding-30m-english` for Granite) |
276312

277313
## Performance
278314

docs/capabilities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Ordered by execution:
7676

7777
- **Chunk size**: 50 lines, 0 overlap
7878
- **Reranker trigger**: activates when top-3 results are within 0.08 score of each other
79-
- **Embedding model**: Granite (`ibm-granite/granite-embedding-30m-english`, 8192 token context) via `@huggingface/transformers` v3
79+
- **Embedding model**: `Xenova/bge-small-en-v1.5` (512 token context, fast, local-first) via `@xenova/transformers`. Override: `EMBEDDING_MODEL=ibm-granite/granite-embedding-30m-english` for Granite (8192 ctx, slower).
8080
- **Vector DB**: LanceDB with cosine distance
8181

8282
## Decision Card (Edit Intent)

0 commit comments

Comments
 (0)