yek
一個基於 Rust 的快速工具,用於將儲存庫或目錄中的文字檔案序列化,供大型語言模型使用
yek 是什麼?
一個基於 Rust 的快速工具,用於將儲存庫或目錄中的文字檔案序列化,供大型語言模型使用
yek 概覽
這是什麼
yek 是一個以 Rust 開發的快速工具,能將儲存庫或目錄中的純文字檔案序列化為單一輸出,專為大型語言模型(LLM)使用而設計。由 Proofline 開發,以 MIT 授權釋出為免費開源軟體。工具會自動遵守 .gitignore 規則、利用 Git 歷史推斷檔案重要性,並偵測二進位或大型檔案予以排除。支援在管道輸出時串流內容、處理多個目錄、使用 glob 模式以及選取個別檔案。可透過 yek.yaml(或 yek.toml/yek.json)設定檔進行配置。
主要功能
- 使用
.gitignore規則跳過不需要的檔案。 - 利用 Git 歷史優先處理較重要的檔案(重要檔案會出現在輸出後段)。
- 自動推斷二進位、大型等非文字檔案的忽略規則。
- 偵測輸出是否被管道化,並串流內容而非寫入檔案。
- 支援在單一指令中處理多個目錄、glob 模式及個別檔案。
- 可透過
yek.yaml設定檔配置自訂忽略規則、優先順序規則、二進位副檔名及輸出設定。 - 提供基於 token 或 byte 的大小限制、JSON 輸出、行號及目錄樹標頭。
使用情境
- 為 LLM 上下文視窗準備儲存庫的文字內容。
- 序列化程式碼庫以供 AI 驅動的程式碼分析或摘要。
- 建立專案的單一檔案快照,供語言模型使用。
- 在遵守
.gitignore及重要性啟發式規則下,快速從目錄中提取相關檔案。
快速開始
使用以下任一方式安裝 yek: bash curl -fsSL https://proofline.sh/yek/install.sh | bash Windows(PowerShell): powershell irm https://proofline.sh/yek/install.ps1 | iex 使用 Homebrew: bash brew install yek 使用 Cargo: bash cargo install yek 從原始碼建置: bash git clone https://github.com/prooflinedev/yek cd yek cargo install --path . 基本用法:在目錄中執行 yek 即可序列化所有檔案,並印出輸出檔案路徑。
授權與價格
yek 為開源且免費。授權為 MIT,如儲存庫中繼資料所述。
內容整理自該專案公開的 README 與儲存庫資訊。