@et0and/ovid 0.0.5 → 0.0.6
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/README.md +35 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,35 @@
|
|
|
1
|
-
# ovid
|
|
1
|
+
# ovid
|
|
2
|
+
|
|
3
|
+
Semantic project navigator for local repos. Builds a labeled tree of files by meaning and renders it in a TUI.
|
|
4
|
+
|
|
5
|
+
Port of the original Python project by [Gabriella Gonzalez](https://github.com/Gabriella439/semantic-navigator)
|
|
6
|
+
|
|
7
|
+
Key differences in this port:
|
|
8
|
+
|
|
9
|
+
- TypeScript + Bun CLI, OpenTUI renderer
|
|
10
|
+
- Local embeddings via `@huggingface/transformers` (`Xenova/all-MiniLM-L6-v2`)
|
|
11
|
+
- Labels generated through GitHub Copilot device flow (no OpenAI API key)
|
|
12
|
+
- Two-layer cache under `~/.cache/semantic-navigator`
|
|
13
|
+
|
|
14
|
+
**What it does**
|
|
15
|
+
|
|
16
|
+
- Reads tracked files (git) or top-level files (non-git)
|
|
17
|
+
- Embeds file chunks locally with `Xenova/all-MiniLM-L6-v2`
|
|
18
|
+
- Clusters files with bisecting k-means
|
|
19
|
+
- Labels clusters and leaves via GitHub Copilot
|
|
20
|
+
- Renders an interactive tree (OpenTUI)
|
|
21
|
+
|
|
22
|
+
**How it works**
|
|
23
|
+
|
|
24
|
+
- Discover files → chunk text → embed → cluster → label → display
|
|
25
|
+
- Embeddings are cached in `~/.cache/semantic-navigator/embeddings.json`
|
|
26
|
+
- Trees are cached in `~/.cache/semantic-navigator/trees/<fingerprint>.json`
|
|
27
|
+
|
|
28
|
+
**Usage**
|
|
29
|
+
|
|
30
|
+
- `bun run src/main.ts [directory]`
|
|
31
|
+
- `bun run src/main.ts --help`
|
|
32
|
+
|
|
33
|
+
**Notes**
|
|
34
|
+
|
|
35
|
+
- First run prompts for GitHub device flow to access Copilot.
|