yek

把整个代码库一键打包成 LLM 能懂的上下文

开源 🏷️完全免费 🔧 仅开源项目，无在线服务，需自行部署开源模型 🍴 复刻 65 🐛 待处理 12 👀 关注 4

GitHub ↗

GitHub 星标 ★ 2475

维护状态低维护

是否开源开源

定价模式 🏷️完全免费开源工具，MIT 许可证，完全免费，可自行部署使用。

项目预览

项目数据

分类开源模型

开发团队mohsen1

GitHubhttps://github.com/mohsen1/yek

定价模式🏷️完全免费

价格说明开源工具，MIT 许可证，完全免费，可自行部署使用。

访问状态🔧 仅开源项目，无在线服务，需自行部署

是否开源是

开源协议MIT

主要语言Rust

技术栈/模型ai,cli,large-language-models,llm,rust-lang,serialization

GitHub 星标★ 2475

上线时间2025-01-11 00:00:00

代码更新2026-06-29

仓库体积1.0 MB

本站数据更新2026-11-09

维护状态低维护

收录时间2026-08-09

浏览次数5

项目介绍

yek 是一个用 Rust 编写的高性能命令行工具，专门用于将仓库或目录中的文本文件序列化为适合大语言模型（LLM）消费的格式。它解决的核心问题是：在将代码库喂给 LLM 时，传统方法（如直接复制文件或使用 grep）效率低、上下文窗口浪费严重。yek 能够快速扫描整个仓库，自动过滤二进制文件、忽略无用文件（如 .git 目录），并将文本内容按结构化方式输出，方便 LLM 理解项目全貌。其核心能力包括极快的处理速度（得益于 Rust 的并发和内存安全）、智能的文件过滤与排序、以及可自定义的输出格式。它特别适合开发者在使用 AI 编程助手时快速提供项目上下文，或用于构建基于代码库的 RAG 系统。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化，观测越久曲线越完整

数据来源：GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 2475

技术标签

ai cli large-language-models llm rust-lang

使用教程

难度：入门约 5 分钟部署方式：命令行工具 5 步

环境要求

Unix-like 系统（macOS 或 Linux）；README 未提供完整的 Windows 安装命令
能访问网络，安装脚本通过 curl 下载
建议在 Git 仓库中运行，以便利用 .gitignore 和 Git 历史推断文件重要性
安装命令依赖 curl（README 安装命令使用 curl -fsSL）

安装与启动步骤

1安装 yek

在 macOS/Linux 终端执行官方安装脚本。注意：README 中 Windows 安装章节内容不完整，未给出命令。
```
curl -fsSL https://azimi.me/yek.sh | bash
```
2进入目标目录

切换到要序列化的仓库或目录，yek 会按当前目录内容处理并应用 .gitignore 规则。
```
cd /your/project
```
3运行序列化

默认直接运行即可序列化整个仓库，结果写入临时文件，控制台会打印该文件路径。
```
yek
```
4管道输出内容

yek 会自动检测输出是否被管道接管，若被管道接管则直接流式输出内容而不写文件。
```
yek > context.txt
```
5使用自定义配置

在项目根目录放置 yek.yaml，或用 --config-file 指定配置路径，自定义忽略规则、输出等。
```
yek --config-file /your/path/yek.yaml
```

关键配置

配置项	必填	说明	示例
`max_size`	否	输出大小上限，也支持用 tokens 单位	`128K`
`json`	否	开启 JSON 格式输出	`false`
`debug`	否	开启调试日志	`false`
`line_numbers`	否	输出中包含行号	`false`
`tree_header`	否	在开头包含目录树	`false`