跳转到内容

快速开始

先理解几个组成部分,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