文件快照 · CLI 7.30.1 · SDK 2.6.53。Desktop 使用各自發行版隨附的執行環境。指令與範例保留英文原文。英文原文

建立及使用第一個 AX Wiki

開始之前

AX Wiki 將選取的儲存庫原始資料整理成架構與工作流程頁面。這是儲存庫知識，與 AX Code 網站文件不同。請先連接提供方並選擇可用模型。產生過程會將選取的證據傳送至該提供方，並可能產生使用費用。

從專案資料夾執行。Git 專案會使用最近的工作樹根目錄，即使從子目錄啟動也一樣。請檢查目前 checkout，並決定是否將產生的檔案納入版本控制。

預覽與產生

規劃會預覽選取的檔案與頁面，不會呼叫模型。產生前請先檢閱：

ax-code wiki plan

接著使用設定的模型產生內容，驗證結果並開啟本機閱讀器：

ax-code wiki generate
ax-code wiki doctor
ax-code wiki viz --open

預設輸出為 .ax-wiki/，從 .ax-wiki/quickstart.md 開始閱讀；.ax-wiki/.manifest.json 記錄來源及雜湊值。產生過程可能更新 AGENTS.md 中的 Wiki 指引區塊；使用 --skip-agents 可略過此步驟。請檢閱產生的差異。

閱讀與提出有用的問題

先閱讀快速入門頁，追蹤引用的檔案，並詢問工作流程在哪裡實作。檢視器呈現頁面、引用與已記錄的關係。按 Ctrl+C 可停止在前景執行的 CLI 檢視器。

用 Wiki 掌握方向，再檢查目前程式碼與測試。精確符號、呼叫者及參照應使用程式碼智慧工具或 LSP。頁面為最新狀態，不代表涵蓋完整、內容正確或已證明執行效能。

保持內容更新

原始碼變更後，更新受影響頁面並檢查健康狀態：

ax-code wiki update
ax-code wiki status
ax-code wiki doctor

即使 Wiki 不存在，狀態指令仍可能成功結束；請查看回報的存在及健康狀態。過期或不健康的輸出需要調查。CLI 檢視器使用固定快照，更新後請重新開啟。

目前 TUI 版本中，/wiki-viz 會開啟檢視器並要求維護。互動式閒置維護預設啟用；前景工作優先。無介面執行不會啟用該排程器。

控制產生行為

將下列選用設定合併至專案 ax-code.json。以連線可用的模型 ID 替換佔位值。此範例停用背景維護，但保留明確執行的指令：

{
  "wiki": {
    "enabled": true,
    "auto": false,
    "model": "provider/model"
  }
}

明確指定 --model provider/model 會覆寫該次執行的 Wiki 模型。對推理模型，Wiki 產生需要可辨識的低強度或關閉推理控制；若此原則拒絕請求，請改選其他支援的模型。

維護者筆記應放入保護區塊，才能在更新時保留：

<!-- AX-WIKI:PROTECTED:START project-note -->

Deployment requires maintainer review.

<!-- AX-WIKI:PROTECTED:END -->

問題復原

沒有模型或驗證錯誤：確認提供方存取權及設定的 Wiki 模型。聊天模型可以使用，不代表另一個 Wiki 模型也能使用。
逾時或建置中斷：檢查 ax-code wiki doctor 與 .ax-wiki/.build-report.json，排除原因後再試。已驗證的暫存頁面可能重用；建置失敗不代表所有頁面都已發布。
手動修改衝突：將筆記保留於保護區塊，並在重試前檢閱變更。--force 允許取代保護區塊外的修改；請確認目的後才使用。

後續步驟

Wiki 設定、CI 與疑難排解 · 檢視器與離線匯出 · 模型選擇 · 文件首頁