工具概覽
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
通過即時遙測檢視執行情況
使用者評論
還沒有評論，來分享你的使用體驗吧