跳到內容

快速開始

先理解幾個組成部分,Agent Note 會更容易導入:local hooks 收集 context,git notes 把 context 綁到 commit,GitHub Action 再產生 PR Report。

這一頁是路線圖。安裝指令放在下一頁,讓你先確認自己將啟用什麼。

Local capture

agent hooks 會在工作時收集 prompt、response、touched files 和 attribution signal。

Git-native history

每個 commit 都會得到 refs/notes/agentnote 下的 git note,不會改動 branch 內容。

Pull Request context

GitHub Action 讀取 notes,並為 reviewer 寫入 PR Report。

Optional Dashboard

如果團隊需要共享畫面,Dashboard 可以發布到 GitHub Pages。

Agent Note Dashboard showing Pull Request history, commits, prompts, and diffs
Dashboard 是 optional 的,但它能展示 Agent Note 如何從一般 commits 和 Pull Requests 建立 review history。
  1. 先讀完這個簡短模型。
  2. 前往 安裝 執行 npx agent-note init
  3. 開啟 Pull Request,確認 PR Report。
  4. 只有在團隊需要共享頁面時再啟用 Dashboard。
需求頁面
現在安裝 Agent Note安裝
設定 PR ReportGitHub Action
發布共享視圖Dashboard
查看各 agent 的能力邊界Agent Support
了解保存的資料Data & Privacy
排查缺失資料Troubleshooting