Skip to content
Agent Note Agent Note

Agent Note

A git commit records what changed. Agent Note records why it changed.
Get Started GitHub

Why I built this

Six months ago I reread some code the AI had written for me and couldn’t answer “why did I do it this way?”. git log only had the diff. The prompts, the responses — all gone.

So I started attaching the AI conversation to every commit.

Agent Note dashboard preview

What it does

Section titled “What it does”

Keep AI-assisted work on record

See which commits and files came from AI help. When Agent Note has enough evidence, it also estimates AI-written lines.

Prompts and responses, saved alongside

Model name and tool usage too — all bundled into git notes with the change.

Automatic PR Reports

AI Ratio, prompts, commit hashes, plus hidden Reviewer Context for AI review tools.

Written only to git notes

Branches stay clean. Share through push / fetch, or publish a Dashboard on GitHub Pages when your team wants one shared view.

Where To Go Next

Section titled “Where To Go Next”
If you want to…Read this
Understand what Agent Note adds before installingGetting Started
Install Agent Note in a repositoryInstallation
Add the PR description that reviewers seeGitHub Action
Publish a shared history page for the teamDashboard
Check what each coding agent can captureAgent Support
Understand what gets stored and who can see itData & Privacy
Fix missing notes, prompts, or Dashboard dataTroubleshooting

Setup

Section titled “Setup”

  1. Run init in your repository

    Terminal window
    npx agent-note init --agent claude
    • Codex CLI: npx agent-note init --agent codex
    • Cursor: npx agent-note init --agent cursor
    • Gemini CLI: npx agent-note init --agent gemini
    • Multiple agents at once: npx agent-note init --agent claude cursor

  2. Commit the generated files

    Terminal window
    git add .claude/settings.json .github/workflows/agentnote-pr-report.yml
    git commit -m "chore: enable agent-note"
    git push
    • Codex CLI: commit .codex/config.toml and .codex/hooks.json
    • Cursor: commit .cursor/hooks.json
    • Gemini CLI: commit .gemini/settings.json

  3. Start coding with your agent. Plain git commit works when the generated git hooks are installed.

Check Your Setup

Section titled “Check Your Setup”
Terminal window
npx agent-note status
agent-note v1.x.x


agent:   active (cursor)
capture: cursor(prompt, response, edits, shell)
git:     active (prepare-commit-msg, post-commit, pre-push)
commit:  tracked via git hooks
session: a1b2c3d4…
agent:   cursor
linked:  3/20 recent commits

agent: shows the enabled adapter, capture: shows what the active hooks collect, git: shows whether the managed git hooks are installed, and commit: shows whether plain git commit is the main path.

See It In Action

Section titled “See It In Action”
commit:  ce941f7 feat: add JWT auth middleware
session: a1b2c3d4-5678-4abc-8def-111122223333


ai:      60% (45/75 lines) [█████░░░]
model:   claude-sonnet-4-20250514
agent:   claude
files:   3 changed, 2 by AI


  src/middleware/auth.ts  🤖
  src/types/token.ts  🤖
  CHANGELOG.md  👤

Agent Capability Matrix

Section titled “Agent Capability Matrix”
Capability
Claude Code
Codex CLI
Cursor
Gemini CLI
Status
Full support
Supported
Supported
Preview
Prompt
Yes
Yes
Yes
Yes
Response
Yes
Yes
Yes
Yes
Files
Yes
Yes
Yes
Yes
AI Ratio
Yes
Yes
Yes
Yes
Line Estimate
Default
Codex patch history matches final Commit
Edit count matches and final file still matches the latest AI edit
Not yet

For details, see Agent Support.