Yek 项目使用与启动教程

Yek 项目使用与启动教程

yek A fast Rust based tool to serialize text-based files in a repository or directory for LLM consumption 项目地址: https://gitcode.com/gh_mirrors/ye/yek

1. 项目介绍

Yek 是一个快速的 Rust 语言编写的工具，用于将仓库或目录中的文本文件序列化，以便于大型语言模型（LLM）的消费。它通过以下方式提高处理效率：

• 默认使用 .gitignore 规则跳过不需要的文件。
• 利用 Git 历史推断哪些文件更重要。
• 推断额外的忽略模式（如二进制文件、大文件等）。
• 检测输出是否被重定向并相应地流式传输内容。
• 支持单个命令处理多个目录。
• 支持使用 glob 模式和单独文件选择。
• 可通过 yek.yaml 文件进行配置。

2. 项目快速启动

安装

根据您的操作系统选择安装方式：

Unix-like 系统（macOS, Linux）

curl -fsSL https://bodo.run/yek.sh | bash

Windows (PowerShell)

irm https://bodo.run/yek.ps1 | iex

从源代码构建

git clone https://github.com/bodo-run/yek.git
cd yek
cargo install --path .

使用

Yek 有合理的默认设置，您可以在目录中简单地运行 yek 来序列化整个仓库。它会序列化仓库中的所有文件并将它们写入一个临时文件。文件路径将被打印到控制台。

处理当前目录并写入临时目录

yek

将输出重定向到剪贴板（macOS）

yek src/ | pbcopy

限制最大输出大小为 128K tokens

yek --tokens 128k

处理多个目录

yek src/ tests/

处理多个文件

yek file1.txt file2.txt file3.txt

使用 glob 模式

yek "src/**/*.ts"
yek "src/main.rs" "tests/*.rs" "docs/README.md"

当使用 glob 模式时，请确保将其引号括起来以防止 shell 展开它们。

3. 应用案例和最佳实践

以下是一些使用 Yek 的场景和最佳实践：

• 代码审查：使用 Yek 生成项目快照，便于代码审查。
• 持续集成：在 CI/CD 流程中使用 Yek 生成项目的序列化版本，以便于自动化测试和审查。
• 文档生成：利用 Yek 序列化项目的文档，以便于生成项目文档。

4. 典型生态项目

Yek 可以与多种项目配合使用，以下是一些典型的生态项目：

• Repomix：一个类似 Yek 的工具，用于将仓库序列化为单个文件。
• Aider：一个集成了 AI 的 IDE 类似体验的开发工具。

通过上述教程，您可以快速上手并使用 Yek，提高您的开发效率。

yek A fast Rust based tool to serialize text-based files in a repository or directory for LLM consumption 项目地址: https://gitcode.com/gh_mirrors/ye/yek