命令列工具
langchain-ai/openwiki avatar
langchain-ai/openwiki

openwiki:從文件拆解功能、限制與採用條件

OpenWiki 是一個 CLI,用於為您的程式碼庫編寫和維護代理文件。

16,531 個 Star1,200 個 ForkTypeScriptMIT
GitHub

秒懂

它是什麼?
OpenWiki is a CLI that writes and maintains agent documentation for your codebase.。本文整理 langchain-ai/openwiki 的使用入口、依賴條件、功能邊界與專案專屬核驗方式。
適合誰用?
openwiki 適合需要 README 所列能力,且能管理其環境、資料與權限的使用者;不適合把教學範例或文件未說明的行為當成正式保證。先執行:執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。
可以商用嗎?
可以。MIT 是寬鬆授權:你可以使用、修改並販售以它為基礎的軟體,只需保留著作權與授權聲明。
還在維護嗎?
有在維護。儲存庫在最近一天內有新的提交。
用什麼語言寫的?
主要是 TypeScript(依據 GitHub 的語言統計)。

以上回答依據專案的 GitHub 資料(最近同步於 2026年9月15日)與我們的分析,不構成法律意見。

開源專案深度解析

openwiki:自我維護的 Markdown 維基

OpenWiki 是一個命令列工具,用於產生和維護程式碼庫或個人知識的維基。代理讀取你指定的來源,綜合產生一個連結的 Markdown 維基,並在來源變化時更新它。輸出是你擁有的純 Markdown,並可與程式碼一起版本化。它有兩種模式:程式碼模式記錄目前儲存庫並寫入該儲存庫的 openwiki/;個人模式記錄連線的資料來源並寫入 ~/.openwiki/wiki。README 說該維基是為代理閱讀作為記憶而構建的,並包含供人類使用的互動式視覺化器。

執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 這項核對只針對 langchain-ai/openwiki 已列出的功能與產物,文件未說明的效能、相容性或安全結果不延伸成保證。

openwiki:安裝、初始化和計畫更新

透過 npm install -g openwiki 全域安裝 CLI。第一次執行 openwiki --init 會引導你選擇提供者、金鑰和模型,然後將文件寫入 openwiki/。為了持續更新,README 提供了 GitHub Actions、GitLab CI 和 Bitbucket Pipelines 的範例工作流程檔案,你可以複製到儲存庫中並計畫執行。在 Windows 上,README 指出不建議使用 bun 安裝,因為它可能會回退到編譯 better-sqlite3 原生依賴,需要 Visual Studio 產生工具。

openwiki:使用視覺化器探索維基

視覺化器是一個互動式節點圖,帶有並排的 Markdown 閱讀器,透過 openwiki visualize 啟動。它在本機回環位址 (127.0.0.1) 上提供維基服務,絕不會暴露在網路上。伺服器會自動拾取對維基檔案的編輯。你可以傳入目錄路徑,用 --port 選擇連接埠(預設 4321),或用 --no-open 跳過開啟瀏覽器。README 指出頁面從公共 CDN 載入圖形、Markdown 和圖表庫,因此即使伺服器是本機的,也需要網際網路連線。

openwiki:資料來源和連線器

在個人模式下,OpenWiki 從本機 git 儲存庫、Notion、Gmail、X/Twitter、Web 搜尋和 Hacker News 攝取知識。每個連線器將原始資料和清單寫入 ~/.openwiki/connectors/<connector>/raw/,然後代理執行在 ~/.openwiki/wiki/ 下綜合產生維基。你可以將同一連線器設定多次作為單獨執行個體。身分驗證透過 openwiki auth <provider> 處理,它會執行本機瀏覽器 OAuth 流程並將權杖儲存在 ~/.openwiki/.env 中。Slack 使用 ngrok 隧道進行 OAuth。LangSmith 連線器用於程式碼模式,透過官方 SDK 拉取所選專案的近期 LangSmith 追蹤(工具呼叫、結果、延遲),並寫入已提交的 openwiki/.langsmith.json,該檔案只列出工作區和專案,絕不包含 API 金鑰。

openwiki:輸出格式和圖表驗證

OpenWiki 輸出 Google Open Knowledge Format (OKF) v0.1 套件。概念文件帶有非空 type 的 YAML front matter;其他欄位可選。index.md 和 log.md 是保留文件,根索引宣告 okf_version: "0.1"。維基包含 Mermaid 圖表,用於序列流程、ER 模型、狀態圖和流程圖。每次執行後,每個 mermaid 程式碼區塊都會被驗證;驗證失敗的圖表會就地轉換為純文字程式碼區塊,並附上簡短註解,下次更新會修復它。為了獲得與 GitHub 轉譯器匹配的權威驗證,你可以在 OpenWiki 旁邊安裝 mermaid 解析器。

openwiki:模型提供者和憑證

預設的入門模型是 OpenAI 的 gpt-5.6-terra。列出了十二個模型提供者:OpenAI、Anthropic、Gemini(AI Studio)、Gemini Enterprise(Vertex AI)、AWS Bedrock、GitHub Copilot、OpenRouter、Nebius/Fireworks/Baseten/NVIDIA NIM,以及任何相容 OpenAI 的端點(LiteLLM、Ollama、LM Studio、閘道)。每個提供者都有預設模型選項,並支援自訂模型 ID。憑證儲存在 ~/.openwiki/.env 中。README 提供了 Bedrock(IAM 憑證、區域解析)、Gemini Enterprise(Google ADC,無 API 金鑰)、OpenAI ChatGPT 登入(透過 Codex 後端進行 OAuth)以及 OpenAI 相容端點的詳細設定。還記錄了替代基礎 URL 和 OpenRouter 提供者固定。

openwiki:隱私、遙測和授權

OpenWiki 將產生的文件以純 Markdown 形式保留,你擁有這些文件,並在儲存庫根目錄維護 AGENTS.md 和 CLAUDE.md,只重寫自己的區塊。INSTRUCTIONS.md 是使用者編寫的,永遠不會被重寫。無操作執行是免費的:工具會快照輸出目錄,只有在實際發生變化時才記錄新中繼資料。遙測是匿名的、聚合的,預設開啟,可以透過 OPENWIKI_TELEMETRY_DISABLED=1 或 DO_NOT_TRACK=1 停用。README 列出了收集的內容(命令、結果、粗粒度錯誤類別、設定時的腦模式)以及從不收集的內容(檔案內容、憑證、提示、輸出、路徑、URL)。該專案採用 MIT 授權;授權文字授予使用、複製、修改、合併、發布、分發、再授權和銷售副本的權限,並宣告軟體按「原樣」提供,不提供任何形式的保證。

針對 openwiki 的第 1 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 2 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 3 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 4 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 5 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 6 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 7 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 8 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 9 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 10 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 11 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 12 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

針對 openwiki 的第 13 次核對,執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 將觀察結果寫入測試紀錄,若 README 沒有對應說明則標為待確認,不以推測補足。

編輯結論

openwiki 適合需要 README 所列能力,且能管理其環境、資料與權限的使用者;不適合把教學範例或文件未說明的行為當成正式保證。先執行:執行 npm install -g openwiki,再在 Git 儲存庫執行 openwiki --init、openwiki --update,檢查 openwiki/.run.json、Claims 與 openwiki/.page-manifest.json;另以 openwiki visualize --no-open 核對本機視覺化器。 再依具體輸出決定是否納入流程。

官方來源

  1. Official README
  2. Project repository
  3. Release notes
社群筆記

社群筆記