Apache License 2.0

项目介绍

zvec-ai/zvec-grep 是一个托管在 GitHub 上的开源项目,主要使用 Rust 编写,采用 Apache License 2.0 许可证,目前获得 4.3k 个 Star、261 次 Fork。

仓库全名
zvec-ai/zvec-grep
开源许可证
Apache License 2.0
Star 数
4.3k
Fork 数
261
未关闭 Issue
92

README 摘要

English | 中文 Know the words—or don’t. Just zg. 💫 Features | 🚀 Try it yourself | 📚 Docs | 📊 Benchmarks | 🤝 Community zg (zvec-grep), powered by zvec, unifies ripgrep, BM25, and vector search behind one local-first interface. Use it directly from the terminal, or let your agent use it for you. 🎬 See it in action 💫 Why zg? Ready for humans and agents — install once, index once, then use the same workspace from…

完整内容见 GitHub 原始 README 或本页 。

常见问题

zvec-grep 用什么语言开发?

主要使用 Rust 编写,采用 Apache License 2.0 许可证,目前有 4.3k 个 Star。

zvec-grep 可以免费商用吗?

仓库采用 Apache License 2.0 许可证,可免费使用与修改,商业使用请遵守许可证条款(例如保留版权声明与许可声明)。

如何获取 zvec-grep 的源码?

可以直接克隆仓库:git clone https://github.com/zvec-ai/zvec-grep.git;安装与运行步骤见仓库 README。

zvec-grep 最近还在维护吗?

仓库最近一次更新为 13 小时前,当前有 92 个未关闭 Issue;Star 数为 4.3k,可作为社区活跃度的参考。

关于

GitHub 原始描述(英文)

Local-first search across your workspace, built for humans and AI agents.

描述取自 GitHub 官方 API,保持仓库作者书写的原文。

简要分析

热度分
4813
价值分
2641
活跃状态
活跃

语言占比

C
Dockerfile
JavaScript
PowerShell
Python
Rust
Shell
TypeScript

Release

README

English | 中文

zg logo

Know the words—or don’t. Just zg.

npm version Rust CI Apache 2.0 license

zvec-ai/zvec-grep | Trendshift TypeScript daily ranking zvec-ai/zvec-grep | Trendshift all-language daily ranking

💫 Features | 🚀 Try it yourself | 📚 Docs | 📊 Benchmarks | 🤝 Community

zg (zvec-grep), powered by zvec, unifies ripgrep, BM25, and vector search behind one local-first interface. Use it directly from the terminal, or let your agent use it for you.

🎬 See it in action

Install the agent integration, index a workspace, and let the agent search it with zvec-grep

💫 Why zg?

  • Ready for humans and agents — install once, index once, then use the same workspace from the CLI or your agent on macOS, Linux, and Windows.
  • Search beyond keywords — discover by meaning, rank by relevance, then verify with exact text or regex when needed.
  • Multi-format search — search source code, documents, and structured data while preserving useful structure and source locations.
  • Less searching, less context — ranked, source-linked results surface the right evidence with fewer tool calls, fewer tokens, and less noise.
  • Local by default — files, indexes, and local models stay on your machine; remote embeddings receive data only with your permission.

🚀 Try it yourself

1. Set up a sample bookshelf

npm install -g @zvec/zvec-grep --allow-scripts=@zvec/zvec-grep

mkdir zg-mystery && cd zg-mystery
curl --retry 3 --retry-all-errors --progress-bar -fL \
  -o alice-in-wonderland.txt https://raw.githubusercontent.com/GITenberg/Alice-s-Adventures-in-Wonderland_11/master/11.txt \
  -o sherlock-holmes.txt https://raw.githubusercontent.com/GITenberg/The-Memoirs-of-Sherlock-Holmes_834/master/834.txt

zg --index --embedding local/potion-retrieval-32m
Note 注意

The index is stored in .zvec-grep/ under the indexed project root.

For agents: ask with OpenCode

With OpenCode configured:

zg --install --target opencode --yes
opencode models
opencode run --model opencode/nemotron-3-ultra-free \
  "An unseen creature left a few marks. What did the detective infer? Cite local evidence."

Free model availability can change. Check opencode models and replace the example model with one that is currently available in your environment.

OpenCode chooses zg on its own—the prompt does not name a tool.

See the full agent run and answer
⚙ zvec_grep_zvec_grep_search {"root":".../zg-mystery","query":"An unseen creature left a few marks. What did the detective infer?","fts":["marks","unseen creature","inferred","detective"],"fuse":true}
→ Read sherlock-holmes.txt [offset=5440, limit=120]

Answer:
The detective is Sherlock Holmes in *The Adventure of the Crooked Man*.
From the animal's foot-marks, he inferred:

- It was not a dog, cat, monkey, or other familiar creature: its print had
  five foot-pads, long nails, and was nearly as large as a dessert-spoon
  (sherlock-holmes.txt:5479-5486).
- It had a long body and very short legs: nearly two feet long, but with a
  stride of only about three inches (sherlock-holmes.txt:5497-5502).
- It was carnivorous because it climbed the curtain toward a canary's cage
  (sherlock-holmes.txt:5509-5510).
- It was probably from the weasel or stoat tribe, though unusually large
  (sherlock-holmes.txt:5514-5516).

Holmes also inferred that a man entered through the window with it and later
left with the key (sherlock-holmes.txt:5464-5470, 5527-5528).
For humans: search directly

Search the same bookshelf directly, without an agent:

zg --preview detail "An unseen creature left a few marks. What did the detective infer?" --limit 3

zg returns the relevant passages from sherlock-holmes.txt, ranked ahead of alice-in-wonderland.txt.

Use repeated --hybrid, --fts, or --vector flags for separate queries. Each nonempty result group starts with its original query and position, such as -- query 2/2: timeout --; colored output uses a dim rule and a magenta label.

📊 Benchmarks

Each benchmark uses paired A/B runs with tasks, agent/model, prompt, environment, and limits held constant; only zg access and usage guidance differ.

See the benchmark documentation for full results and reproduction details.

1. Cross-Domain Agent Benchmark

SWE-QA-Bench uses Claude Code with Claude Opus 5 at high reasoning effort; BrowseComp-Plus uses Codex gpt-5.6-sol at medium reasoning effort. Both zg profiles use Qwen3.7 Text Embedding.

Overall zg benchmark results for Coding and general text retrieval, comparing answer quality, input tokens, tool calls, and agent time against Baseline

  • Why it helps: semantic discovery narrows the search space, ranked lexical retrieval anchors exact identifiers, and compact evidence reduces broad scans, repeated tool calls, and model context.
  • Why it generalizes: the same retrieval loop works across domains—code is indexed with symbols, signatures, and breadcrumbs, while prose is retrieved as focused sections and chunks.

2. Real-World Case Studies

Baseline to zg comparison across three repository-comprehension tasks: Judge score, input tokens, tool calls, and wall time
  • Pylint — Python static analysis: the task asks how AST node handling separates annotated and non-annotated attribute initialization. Symbol-aware retrieval is useful because the architectural entry point is not known in advance.
  • Matplotlib — plotting and rendering: the task traces FontInfo and font selection through multiple math-text rendering stages. Ranked semantic and lexical evidence helps reconstruct the cross-file data and control flow.
  • Django — web framework: the task connects username uniqueness, ORM transactions, and formset bulk operations. Compact ranked evidence brings the distributed design rationale together.
Repository questions
Repository Question type Question
pylint-dev/pylint What
Architecture exploration
What is the architectural pattern that distinguishes type-annotated from non-annotated instance attribute initialization using AST node type separation?
matplotlib/matplotlib Where
Data / Control-flow
Where does the FontInfo NamedTuple propagate font metrics and glyph data through the mathematical text rendering pipeline, and what control flow determines whether the postscript_name or the FT2Font object is used at different stages of character rendering?
django/django Why
Design rationale
Why does the User model’s unique constraint on the username field interact with Django’s ORM transaction handling, and what cascading effects would occur if this constraint were removed on an existing database with formset-based bulk operations?

zg works best when evidence spans files or modules and the target location is unknown, especially for call-chain, data-flow, and architectural questions. Since agents decide when and how to use it, results vary by model and run; repeated-run averages are more reliable.

🤝 Join Our Community

💬 DingTalk 📱 WeChat 🎮 Discord X (Twitter)
DingTalk QR Code WeChat QR Code Discord X (formerly Twitter) Follow
Scan to join Scan to join Click to join Click to follow

❤️ Contributing

Community contributions are always welcome—bug fixes, features, and documentation improvements all help make zvec-grep better.

Check out our Contributing Guide to get started!

评论

暂无评论