DeepWiki-Open將GitHub或GitLab倉庫一鍵轉為交互式Wiki
DeepWiki-Open?是由 AsyncFuncAI 開發(fā)的開源工具,主打 AI 驅動的代碼分析和自動化文檔生成。
它將 GitHub 或 GitLab 倉庫一鍵轉為交互式 Wiki,生成結構化文檔和 Mermaid 圖表,讓開發(fā)者快速掌握項目全貌。
基于 FastAPI(后端)、Next.js(前端)和 RAG 技術。通過分析代碼庫的結構、文件和 README,生成交互式 Wiki 文檔,包含架構圖、模塊說明和依賴關系。
讓每個開發(fā)者都能輕松理解代碼庫。
主要功能
??一鍵生成交互式 Wiki: 自動將 GitHub/GitLab 倉庫轉為交互式 Wiki 文檔 ??支持私有倉庫:支持 Git 私鑰配置,安全接入你的企業(yè)/私有項目 ??AI 智能分析:利用 LLM 解析模塊結構、函數含義、依賴關系等 ??Mermaid 圖表可視化: 自動繪制項目模塊架構圖、函數依賴圖(Mermaid.js) ??類維基導航結構:文件、模塊、類、函數逐層展開,邏輯層次清晰 ??交互式前端:清爽 UI,支持全文檢索、代碼預覽、圖譜瀏覽
快速上手
DeepWiki Open 支持 Docker 和手動部署,硬件需求適中。
Docker 快速部署
#?1.克隆項目 git?clone?https://github.com/AsyncFuncAI/deepwiki-open.git cd?deepwiki-open #?創(chuàng)建環(huán)境變量,配置API?KEY echo?"GOOGLE_API_KEY=your_google_api_key"?>?.env echo?"OPENAI_API_KEY=your_openai_api_key"?>>?.env #?運行Docker docker-compose?up
本地手動部署
同樣克隆項目到本地,準備好谷歌和OpenAI的API Key。
① 運行后端服務
#?安裝Python項目依賴 pip?install?-r?api/requirements.txt #?啟動API服務 python?-m?api.main
② 運行前端服務
#?安裝?JS?依賴 npm?install #?or yarn?install #?啟動Web服務 npm?run?dev #?or yarn?dev
然后打開?http://localhost:3000,輸入倉庫 URL。
對于私有倉庫需點擊“+ Add access tokens”,輸入 GitHub/GitLab 個人訪問令牌。
然后點擊“Generate Wiki”,AI 分析后生成文檔和圖表。
適用人群
??開發(fā)者:快速熟悉新項目結構,少走彎路 ??學習者:閱讀大型開源項目更高效,理解各模塊作用 ??維護者:便于生成文檔、交流設計意圖、交接代碼 ??團隊協(xié)作:替代傳統(tǒng)文檔系統(tǒng),一處同步維護代碼與文檔
寫在最后
拿到一個新項目,我最怕的是:一大堆 .py / .ts / .go 文件,深得像迷宮,函數和類飛來飛去,全靠人肉 grep。
更糟的是:沒有文檔、沒有注釋、沒人愿意解釋。
這不是我一個人的痛點,而是幾乎所有程序員在接手新項目時的共鳴。
而現在有了 DeepWiki-Open,幫助我們把晦澀代碼變成可視知識地圖!
把任何 GitHub / GitLab 倉庫一鍵轉換為交互式 Wiki,自動生成架構圖、流程圖、代碼說明,像看文檔一樣看懂整個項目。
如果你經常要讀別人寫的代碼,如果你恨過“這代碼誰寫的?”—那么 DeepWiki-Open 可以值得一試。
GitHub 項目地址:https://github.com/AsyncFuncAI/deepwiki-open
關注公眾號:拾黑(shiheibook)了解更多
友情鏈接:
關注數據與安全,洞悉企業(yè)級服務市場:https://www.ijiandao.com/
安全、綠色軟件下載就上極速下載站:https://www.yaorank.com/