zvec-grep
本機優先搜尋您的工作區,專為人類與 AI 代理打造。
zvec-grep 是什麼?
本機優先搜尋您的工作區,專為人類與 AI 代理打造。。(注意:此處多餘句號,應修正為單一句號)
zvec-grep 概覽
這是什麼
zg(zvec-grep)是一個以本機優先的搜尋工具,整合了 ripgrep、BM25 與向量搜尋於單一介面。它同時為人類使用者與 AI 代理程式設計,可直接從終端機使用,或透過代理程式工作流程進行搜尋。工具會建立索引,並將索引儲存在專案根目錄下的 .zvec-grep/ 資料夾中。
主要功能
- 整合三種搜尋方式:ripgrep(正規表達式)、BM25(詞彙排序)與向量搜尋(語意相似度)。
- 支援多格式搜尋,涵蓋原始碼、文件與結構化資料,同時保留結構與來源位置。
- 提供排序且附帶來源連結的結果,減少工具呼叫次數與 token 用量。
- 預設本機執行:檔案、索引與本機模型皆留在使用者機器上;遠端嵌入僅在使用者允許時才接收資料。
- 支援 macOS、Linux 與 Windows。
使用情境
- 在程式碼庫中搜尋架構模式、資料流或呼叫鏈,當目標位置未知時特別有用。
- 依語意或精確文字搜尋文件(例如書籍、報告)。
- 代理程式輔助搜尋:代理程式可自動使用 zg 擷取證據並回答問題,如 OpenCode 的示範。
- 跨領域檢索:同一工具可用於程式碼(符號、簽章)與散文(章節、片段)。
快速開始
透過 npm 全域安裝 zg: bash npm install -g @zvec/zvec-grep --allow-scripts=@zvec/zvec-grep 建立專案目錄、下載範例檔案並建立索引: bash 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 索引完成後,直接搜尋: bash zg --preview detail 'An unseen creature left a few marks. What did the detective infer?' --limit 3 代理程式使用方式請參閱儲存庫的 README 以了解 OpenCode 設定。
授權與價格
本專案採用 Apache-2.0 授權,為開放原始碼軟體。
內容整理自該專案公開的 README 與儲存庫資訊。