工具概览
AutoREADME 是面向开源和企业仓库的自主文档引擎。它作为旁路服务运行,监听定时 cron 触发或显式 API 事件,通过只读静态分析来分析源代码结构,并使用多提供商 LLM 链合成最新文档。它生成 Markdown README,并将实时遥测数据流式传送到交互式仪表盘。
该系统包含多层 LLM 故障切换链,提供商有 Groq、GitHub Models、OpenRouter、Google Gemini 以及确定性的时间戳备份。只读的 AST 和正则解析器会提取类定义、公共方法、函数签名、API 端点、环境变量要求、CLI 参数、依赖和 Docker 配置。SHA-256 哈希优化器会在文档内容已是最新时跳过多余的 LLM 请求。
AutoREADME 被设计为零密钥的公开架构。凭据从环境变量或 GitHub Secrets 中动态加载,RPC 函数对远程数据库修改强制执行安全的密码验证。它还提供基于 React 19、Vite、Recharts 和 Lucide Icons 的仪表盘,用于跟踪 token 消耗、runner 延迟、提交热力图、手动触发、维护模式和紧急停止开关。
定价
价格与限制可能变化,请以官网为准,并确认币种、付款周期、最低席位数和用量上限。
应用场景
- 团队用 AutoREADME 自动生成并更新仓库的 Markdown README。
- 团队用 AutoREADME 通过分析源代码发现未被文档记载的功能。
- 团队用 AutoREADME 通过多层回退链避免 API 速率限制和单一提供商的故障。
- 团队用 AutoREADME 从代码中提取 API 端点和网页路由。
- 团队用 AutoREADME 在 README 内容未变化时跳过多余的 LLM 请求。
- 团队用 AutoREADME 在仪表盘中监控 token 消耗和 runner 延迟。
- 团队用 AutoREADME 触发手动运行或切换维护模式。
- 团队用 AutoREADME 让凭据不进入仓库文件。
功能特性
扫描代码库中的文档缺口
发现尚未记录的功能
自动更新 README 文件
在支持的模型服务间故障切换
支持 Groq、GitHub Models、OpenRouter 和 Gemini
通过实时遥测查看运行情况
用户评论
还没有评论,来分享你的使用体验吧