diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..aba79e3 --- /dev/null +++ b/README.md | |||
| @@ -0,0 +1,34 @@ | |||
| 1 | # codevec | ||
| 2 | |||
| 3 | Semantic code search via embeddings. | ||
| 4 | |||
| 5 | ```bash | ||
| 6 | codevec index . | ||
| 7 | codevec query "websocket connection handling" | ||
| 8 | ``` | ||
| 9 | |||
| 10 | ## Status | ||
| 11 | |||
| 12 | **Design phase** — see [DESIGN.md](DESIGN.md) | ||
| 13 | |||
| 14 | ## Overview | ||
| 15 | |||
| 16 | Index your codebase, query by concept. Get relevant code chunks with file paths and line numbers. | ||
| 17 | |||
| 18 | - AST-aware chunking (tree-sitter) for Go, TypeScript, Python | ||
| 19 | - sqlite-vec for fast similarity search | ||
| 20 | - Incremental updates (only re-index changed files) | ||
| 21 | - Integrates with claude-flow as a `CodeSearch` tool | ||
| 22 | |||
| 23 | ## Why | ||
| 24 | |||
| 25 | `grep` finds keywords. `codevec` finds meaning. | ||
| 26 | |||
| 27 | ```bash | ||
| 28 | # grep misses this | ||
| 29 | grep "authentication" # won't find verifyJWT() | ||
| 30 | |||
| 31 | # codevec finds it | ||
| 32 | codevec query "authentication" | ||
| 33 | # src/auth.go:15-42 VerifyJWT (0.89) | ||
| 34 | ``` | ||
