Theme / v1.6.0

Codegraph

程式碼知識圖譜工具

指令詳解

codegraph init 指令詳解

如何使用 codegraph init 快速初始化本地圖譜配置,並配置語言與排除規則

指令用途

在一個專案中啟用 Codegraph 之前,首先需要在本地建立圖譜的管理目錄與解析規則。如果直接對整個資料夾盲目索引,可能會引入很多不必要的編譯目錄(如 .build/.svelte-kit/ 等),導致圖譜體積過大且解析緩慢。

codegraph init 是一個命令列初始化指令。它會在專案根目錄下自動建立隱藏的 .codegraph/ 目錄,並在內部生成預設的 config.yaml 配置檔。這份配置檔定義了專案所使用的語言解析器、檔案排除清單與圖譜儲存路徑,為後續的圖譜建置提供基礎導航。


運作流程

  1. 環境探查:檢測專案根目錄下主要的程式語言類型(如偵測到 package.json 則判定為 TypeScript 專案)。
  2. 目錄建立:在專案根目錄下建立 .codegraph/ 目錄。
  3. 配置模板套用:根據探查到的語言,自動寫入預設的 .codegraph/config.yaml。例如自動排除 .gitnode_modulesdist
  4. 初始化成功:提示使用者已完成配置,可以開始執行圖譜建置。

非互動安裝與 GitHub Copilot 支援(v1.6.0 新增)

v1.6.0 為 codegraph install 帶來兩項實用強化。

非互動安裝:加上 --yes --init 旗標,即可用一條指令完成安裝與圖譜初始化,直接跳過 agent 選擇提示,適合腳本與 CI 場景。若配置需要留在專案本機(例如 Codex CLI 環境),再補上 --location=local

codegraph install --yes --init --location=local

支援的用戶端擴大codegraph install 現在涵蓋 VS Code、GitHub Copilot CLI 與 JetBrains IDE 的 GitHub Copilot;對應的清除則使用 codegraph uninstall


實戰對話範例

範例:在 TypeScript / Node 專案中初始化 Codegraph

  • You:
    /opsx:explore "我想在當前的 TypeScript 後端專案中啟用 Codegraph,請幫我初始化。"
  • AI:

    好的,我將在您的專案根目錄下執行命令列初始化指令 codegraph init,為您建立圖譜配置。

    命令執行: codegraph init
    輸出回傳:

    [codegraph] Initializing codegraph repository...
    [codegraph] Detected Language: TypeScript / JavaScript
    [codegraph] Created directory: .codegraph/
    [codegraph] Generated config: .codegraph/config.yaml
    [codegraph] Codegraph initialized successfully. Run 'codegraph watch' to build the index.

    分析
    初始化已成功完成!生成的 .codegraph/config.yaml 已自動為您配置了 TypeScript 解析規則,並將 node_modulesdist 列入排除名單。

    接下來,您希望我們檢視剛產生的 config.yaml 設定,還是直接啟動監控同步?