Skip to content
Agent Note Agent Note

Getting Started

Agent Note is for teams that want the story behind AI-assisted commits to survive code review. It records the prompts, responses, touched files, model, and attribution signals that explain why a commit changed.

Use this page as the map. It explains the path from a fresh repository to the first PR Report without forcing you through every option up front.

What You Are Setting Up

Section titled “What You Are Setting Up”

Local capture

Agent hooks collect prompts, responses, file edits, and attribution clues while you work.

Git-native history

Each commit gets a git note under refs/notes/agentnote, so your branch stays clean.

Pull Request context

The GitHub Action turns those notes into a PR Report for reviewers.

Optional Dashboard

Teams that want one shared history page can publish Dashboard on GitHub Pages.

Agent Note Dashboard showing Pull Request history, commits, prompts, and diffs
Dashboard is optional, but it shows the kind of review history Agent Note can build from ordinary commits and Pull Requests.
Section titled “Recommended Path”

  1. Install Agent Note in the repository.

    Go to Installation when you are ready to run npx agent-note init.

  2. Commit the generated agent config and workflow files.

    Those files make the setup repeatable for the team, while local git hooks are installed per clone.

  3. Open a Pull Request.

    The generated GitHub Action reads refs/notes/agentnote and writes the PR Report.

  4. Add Dashboard only if your team wants a shared Pages view.

    PR Report is enough for many teams. Dashboard is useful when you want to browse open and merged PR history outside a single PR.

Which Page Should I Read Next?

Section titled “Which Page Should I Read Next?”
NeedRead
Install Agent Note nowInstallation
Configure the Pull Request reportGitHub Action
Publish a shared team viewDashboard
Check each agent’s capture limitsAgent Support
Understand stored data and visibilityData & Privacy
Fix missing notes or promptsTroubleshooting

What Success Looks Like

Section titled “What Success Looks Like”

After setup, a normal git commit and git push should be enough. Your Pull Request gets an Agent Note section with AI Ratio, model, commit table, and the prompts that explain each commit.

If you prefer to see the raw commit data first, run:

Terminal window
npx agent-note status
npx agent-note show