
llmdoc
给编码 Agent 自动生成项目文档,少猜代码多干活
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-09-16 · 当前星标 ★ 482
使用教程
环境要求
- Node.js 18+
- 一个代码仓库
安装与启动步骤
-
1直接跑
一条命令免安装。
npx -y @tokenroll/llmdoc tree -
2搜文档
按关键词找。
npx -y @tokenroll/llmdoc search "revision" -
3取上下文
按文件取相关上下文。
npx -y @tokenroll/llmdoc context --files cli/src/cli.ts -
4起本地服务
需要界面时用它。
npx -y @tokenroll/llmdoc serve
如何确认成功
在一个中型仓库里能查出某个模块的架构文档并取出对应文件的上下文,助手据此给出的改动建议符合现有设计
注意事项
- 它给代码仓库补一份持久的工程上下文文档,让编码助手少猜。
- 核心是文档与代码同步,过期文档比没有更糟。
- 命令不多,tree 与 search 最常用。
- 文档质量取决于维护节奏。
核心亮点
- 自动为代码库生成面向 AI Agent 的结构化文档,减少人工整理成本
- 针对编码 Agent 的上下文消费方式设计,而非传统人类阅读文档
- TypeScript 实现,便于前端/Node 项目直接集成到现有工作流
不足之处
- 项目处于早期,文档和最佳实践可能尚不完善
- 生态与集成案例较少,长期维护活跃度有待观察
适用场景
- 在大型遗留项目中让 Claude Code 等 Agent 快速理解模块职责
- 团队用 AI 辅助开发时统一项目上下文,降低生成代码偏差
- 为多仓库或微服务项目批量生成 Agent 可读的架构说明
替代项目
repomix、aider
上一篇:forall
下一篇:little-coder
同类项目推荐
CopilotForXcode
开源
在 Xcode 里直接获得 GitHub Copilot 的 AI 代码补全,让 Swift 开发飞起来
AI coding assistant for Xcode
token-goat
开源
给 AI 编程工具装上 token 节流阀,省钱又专注
Auto AI improver. Cost and token burn reducer, turn saver, and focus keeper for Clau···
minuet-ai.nvim
开源
在 Neovim 里边写边补全,多家大模型随你换
Dance with Intelligence in Your Code. Minuet offers code completion as-you-type from···
aspens
开源
让 AI 编程助手在大型项目里不迷路,自动拆解指令文件并随代码更新。
Your CLAUDE.md stopped working at 200 lines. Generate scoped skill files from your i···
codemap
开源
给 AI 一张项目地图,少烧 token 也能看懂代码
a project brain for your AI. Give LLMs instant architectural context without burning···
muapi-cli
开源
终端里一句话生成图片、视频和音频,支持14种模型
Official CLI for muapi.ai — generate images, videos & audio from the terminal. MCP ···
pair-programmer
开源
让多个 AI 结对写代码,复杂任务不再卡壳
Pair Programmer for Claude Code, Codex and Cursor
costrict
开源
企业级 AI 编程三件套,写码审查补全一次到位
Costrict - strict AI coder for enterprises, quality first, including AI Agent, AI Co···
codex
开源
终端里一句话改代码,读完文件直接跑命令
Lightweight coding agent that runs in your terminal