教學

使用 /init 和 AGENTS.md 啟動專案

使用 /init 為 Bob 提供跨對話和模式的持久專案上下文,它會自動生成 AGENTS.md 檔案。

/init 命令掃描專案並生成一個名為 AGENTS.md 的結構化摘要檔案,Bob 在每次對話中將其用作持久上下文。/init 命令是您向 Bob 提供有關專案結構、約定和程式碼庫知識的方式,而無需 Bob 在每次互動開始時重新讀取每個檔案。

大型語言模型是無狀態的。每次新對話都從沒有先前互動的記憶開始。如果沒有明確的專案上下文,Bob 必須在每次新互動時發現程式碼庫,這是低效的,並且在規模擴大時變得不切實際。

在本教學中,您將在示範應用程式的根目錄中初始化 Bob,探索 Bob 獲得的有關應用程式的上下文,並了解 Bob 針對特定模式上下文的結構。

先決條件

要完成本教學,您需要以下內容:

  • 如果您還沒有,請複製 Galaxium Travels 示範程式碼。複製命令還會檢出包含您在教學中使用的程式碼的 bob-learning-path-branch 分支。
git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels
  • 開啟 Galaxium Travels 示範程式碼的 Bob IDE
  • 雖然不是必需的,但請考慮完成快速入門教學以熟悉 Bob 的介面和功能。

執行 /init

要初始化專案上下文,請在 Bob IDE 中導航至 嗨,我是 Bob 聊天介面。切換到側邊欄底部的 Agent 模式

切換到 Agent 模式

在聊天介面中輸入 /init 命令。如果您停用了自動核准,Bob 會請求您的許可來讀取檔案並寫入 AGENTS.md 檔案。

 /init

在 Bob IDE 中執行 /init 命令

Bob 讀取專案中的相關檔案。然後 Bob 在 Galaxium Travels 根目錄中生成主 AGENTS.md 檔案。Bob 還建立一個 .bob 資料夾,其中包含每個模式的 AGENTS.md

探索 AGENTS.md 檔案

AGENTS.md 檔案的功能類似於 Bob 的入職文件。AGENTS.md 是一個簡潔、可操作的摘要,提供 Bob 理解專案結構和約定所需的一切。

您可以在左側 Bob 檔案總管的底部找到主 AGENTS.md 檔案。開啟檔案以閱讀其內容。

Bob 檔案總管中的 AGENTS.md 檔案

AGENTS.md 檔案通常包含以下元件:

  • 專案概述和目的
  • 目錄結構和關鍵檔案位置
  • 技術堆疊和相依性
  • 架構模式和約定
  • 開發工作流程

Bob 自動將 AGENTS.md 套用於新對話並學習專案上下文。

特定模式的 AGENTS.md 檔案

除了 Galaxium Travels 根目錄中的主 AGENTS.md 之外,/init 還會在 .bob 資料夾中為每個內建模式生成特定模式的上下文檔案。每個特定模式的 AGENTS.md 都會使用與該模式目的相關的上下文擴充主 AGENTS.md。下表列出了特定模式的 AGENTS.md 檔案:

檔案模式
.bob/rules-code/AGENTS-code.mdAgent 模式
.bob/rules-plan/AGENTS-plan.mdPlan 模式
.bob/rules-ask/AGENTS-ask.mdAsk 模式

Plan 模式上下文強調架構約定,而 Code 模式上下文突顯檔案結構和命名模式。

維護 AGENTS.md 檔案

在進行以下專案調整後重新執行 /init

  • 新增新模組或服務
  • 變更目錄結構
  • 採用新技術或框架
  • 入職將使用 Bob 的新團隊成員

您還可以手動編輯 AGENTS.md 以新增 Bob 的自動掃描可能無法擷取的上下文,例如業務規則、部署約定或團隊特定的實踐。

後續步驟

在本教學中,您了解到以下內容:

  • 大型語言模型是無狀態的。執行 /init 命令透過生成 AGENTS.md 來解決此問題,這是 Bob 在每次對話開始時讀取的持久上下文檔案。
  • 特定模式的 AGENTS.md 檔案為 Agent、Plan 和 Ask 模式提供有針對性的上下文。
  • 在重大專案變更後重新執行 /init 以保持上下文最新。
這個主題如何?