Skip to content

Latest commit

 

History

History
396 lines (288 loc) · 12.7 KB

File metadata and controls

396 lines (288 loc) · 12.7 KB

Agent Note

[en] [ja] [fr] [de] [it] [es] [ko] [zh-CN] [zh-TW] [ru] [id] [pt-BR]

Agent Note — percakapan AI disimpan ke Git

CI License: MIT npm

Ketahui mengapa kode berubah, bukan hanya apa yang berubah.

Agent Note menyimpan percakapan dengan AI dan file yang berubah untuk setiap Commit. Jika datanya cukup, Agent Note juga menampilkan perkiraan praktis seberapa besar perubahan yang dibuat dengan bantuan AI.

Anggap saja sebagai git log ditambah percakapan AI di balik perubahan.

Dokumentasi

Agent Note dashboard preview

Mengapa Agent Note

  • Rekam prompt, respons, file yang berubah, dan AI Ratio untuk setiap Commit yang dibantu AI.
  • Tetap gunakan git commit biasa; Agent Note mencatat konteks di background.
  • Berikan PR Report untuk reviewer manusia dan AI Review tool, dengan ringkasan terlihat dan Reviewer Context tersembunyi.
  • Buka Dashboard bersama, atau jalankan agent-note why <file:line> untuk kembali dari satu baris ke percakapan Commit.
  • Simpan semuanya secara Git-native di refs/notes/agentnote — tanpa Hosted Service, tanpa Telemetry.

Persyaratan

  • Git
  • Node.js 20 atau lebih baru
  • Coding Agent yang didukung, sudah terpasang dan terautentikasi

Quick Start

  1. Aktifkan Agent Note untuk Coding Agent Anda.
npx agent-note init --agent claude
# atau: codex / cursor / gemini

Setiap pengembang harus menjalankannya sekali secara lokal setelah Clone.

Anda dapat mengaktifkan lebih dari satu Agent dalam Repository yang sama:

npx agent-note init --agent claude cursor

Jika juga ingin shared Dashboard di GitHub Pages:

npx agent-note init --agent claude --dashboard
  1. Commit file yang dibuat dan Push.
git add .github/workflows/agentnote-pr-report.yml .claude/settings.json
# ganti .claude/settings.json dengan config agent Anda di bawah
# dengan --dashboard, tambahkan juga .github/workflows/agentnote-dashboard.yml
git commit -m "chore: enable agent-note"
git push
  • Claude Code: Commit .claude/settings.json
  • Codex CLI: Commit .codex/config.toml dan .codex/hooks.json
  • Cursor: Commit .cursor/hooks.json
  • Gemini CLI: Commit .gemini/settings.json
  1. Terus gunakan Workflow git commit normal.

Dengan Git Hooks yang dibuat, Agent Note otomatis merekam Commit dari git commit biasa.

AI Agent Skill

Jika AI Agent Anda mendukung GitHub Agent Skills, pasang Agent Note Skill agar Anda bisa meminta tugas Agent Note dengan bahasa natural.

gh skill install wasabeef/AgentNote agent-note --agent codex --scope user

Untuk gh skill install, pilih identifier agent yang sesuai: codex, claude-code, cursor or gemini-cli. Skill biasanya hanya mengarahkan agent ke enam command publik: init, deinit, status, log, show, dan why.

Data yang disimpan

Agent Note menyimpan cerita Commit:

  • Percakapan: permintaan dan jawaban AI yang mengarah ke perubahan

  • Context: catatan singkat yang tampil sebagai 📝 Context saat permintaan saja terlalu pendek

    Agent Note Dashboard showing Context before a short prompt
  • File: file yang berubah dan apakah AI ikut mengeditnya

  • AI Ratio: perkiraan persentase keseluruhan, plus jumlah baris jika Agent Note dapat memperkirakannya

Temporary Session Data berada di .git/agentnote/. Permanent Record berada di refs/notes/agentnote dan dibagikan melalui git push.

Keluarkan generated bundle dari AI Ratio

Jika bundle atau generated output yang di-commit harus tetap terlihat tetapi tidak memengaruhi AI Ratio, tambahkan ke .agentnoteignore di repository root:

packages/cli/dist/**
packages/pr-report/dist/**

File tersebut tetap muncul di Notes, PR Report, dan Dashboard. File hanya dikeluarkan dari penyebut AI Ratio.

Agent Support

Agent Status Prompt Response Files AI Ratio Line Estimate
Claude Code Full support Ya Ya Ya Ya Default
Codex CLI Supported Ya Ya Ya Ya Saat riwayat patch Codex cocok dengan Commit akhir
Cursor Supported Ya Ya Ya Ya Saat jumlah edit cocok dan file akhir masih cocok dengan edit AI terakhir
Gemini CLI Preview Ya Ya Ya Ya Belum

Files berarti Agent Note dapat menunjukkan file yang di-commit dan disentuh oleh Agent. Line Estimate berarti Agent Note juga dapat memperkirakan baris yang ditulis AI, bukan hanya menghitung file.

Periksa Setup

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: menunjukkan agent adapters yang aktif. capture: merangkum data yang dikumpulkan hooks aktif. git: menunjukkan apakah Git Hooks repository-local yang dikelola sudah terpasang. commit: memberi tahu apakah git commit biasa adalah jalur tracking utama.

Yang Anda dapatkan

Setiap Commit punya Story

$ npx agent-note show

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  🤖
  src/middleware/__tests__/auth.test.ts  🤖
  CHANGELOG.md  👤
  README.md  👤

prompts: 2

  1. Implement JWT auth middleware with refresh token rotation
  2. Add tests for expired token and invalid signature

Scan history sekilas

$ npx agent-note log

ce941f7 feat: add JWT auth middleware  [a1b2c3d4… | 🤖60% | 2p]
326a568 test: add auth tests          [a1b2c3d4… | 🤖100% | 1p]
ba091be fix: update dependencies

PR Report

Secara default, GitHub Action memposting AI Session Report ke PR Description:

Blok agentnote-reviewer-context disimpan sebagai hidden comment di PR body. AI Review tool yang membaca raw PR description, seperti Copilot, CodeRabbit, Devin, dan Greptile, dapat menggunakannya sebagai intent dan review focus tambahan.

## 🧑💬🤖 Agent Note

**Total AI Ratio:** ████████ 73%
**Model:** `claude-sonnet-4-20250514`

<!-- agentnote-reviewer-context

Generated from Agent Note data. Use this as intent and review focus, not as proof that the implementation is correct.

Changed areas:

- Documentation: `README.md`, `docs/usage.md`
- Source: `src/auth.ts`
- Tests: `src/auth.test.ts`

Review focus:

- Check that docs and examples match the implemented behavior.
- Compare the stated intent with the changed source files and prompt evidence.

Author intent signals:

- Commit: feat: add auth
- Prompt: Add JWT authentication and update the PR docs
-->

| Commit | AI Ratio | Prompts | Files |
|---|---|---|---|
| ce941f7 feat: add auth | ████░ 73% | 2 | auth.ts 🤖, token.ts 🤖 |

<div align="right"><a href="https://OWNER.github.io/REPO/dashboard/?pr=123" target="_blank" rel="noopener noreferrer">Open Dashboard ↗</a></div>

Cara kerja

Anda mengirim Prompt ke Coding Agent
        │
        ▼
Hooks menyimpan percakapan dan informasi Session
        │
        ▼
Agent mengedit file
        │
        ▼
Hooks atau Local Transcripts mencatat file yang berubah
        │
        ▼
Anda menjalankan `git commit`
        │
        ▼
Agent Note menulis Git Note untuk Commit itu
        │
        ▼
Anda menjalankan `git push`
        │
        ▼
`refs/notes/agentnote` ikut di-push bersama Branch

Untuk Flow detail, cara Agent Note memperkirakan pekerjaan yang ditulis AI, dan Schema yang disimpan, lihat Cara kerja.

Commands

Command Fungsi
agent-note init Menyiapkan Hooks, Workflow, Git Hooks, dan notes auto-fetch
agent-note deinit Menghapus hooks dan config Agent Note
agent-note status Menampilkan status pelacakan
agent-note log [n] Mendaftar commit terbaru dengan AI Ratio
agent-note show [commit] Menampilkan sesi AI di balik HEAD atau Commit SHA
agent-note why <target> Menjelaskan konteks Agent Note di balik satu baris atau rentang baris file

GitHub Action

Root action punya dua mode:

  • PR Report Mode memperbarui Pull Request description atau memposting comment.
  • Dashboard Mode membangun data Dashboard bersama dan memublikasikan /dashboard/ melalui GitHub Pages.

PR Report Mode adalah default:

- uses: wasabeef/AgentNote@v1
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Atur prompt_detail ke compact atau full jika ingin riwayat Prompt yang fokus atau lengkap. Default-nya adalah compact: preset ini menjaga laporan tetap mudah dibaca dengan menampilkan Prompt yang menjelaskan Commit, sedangkan full menampilkan semua Prompt yang tersimpan.

Dashboard Mode memakai action yang sama dengan dashboard: true:

- uses: wasabeef/AgentNote@v1
  with:
    dashboard: true
    prompt_detail: compact

Data Dashboard

Untuk sebagian besar repositori, Anda tidak perlu menulis Workflow manual. Generate dengan init:

npx agent-note init --agent claude --dashboard

Lalu Commit .github/workflows/agentnote-pr-report.yml dan .github/workflows/agentnote-dashboard.yml, aktifkan GitHub Pages dengan Source GitHub Actions, dan buka /dashboard/.

Jika Anda sudah punya GitHub Pages Site, lihat Dashboard Docs untuk Setup gabungan yang aman.

Full example with outputs
- uses: wasabeef/AgentNote@v1
  id: agent-note
  with:
    base: main

# Use structured outputs
- run: echo "Total AI Ratio: ${{ steps.agent-note.outputs.overall_ai_ratio }}%"
Yang disimpan
$ git notes --ref=agentnote show ce941f7
{
  "v": 1,
  "agent": "claude",
  "session_id": "a1b2c3d4-...",
  "timestamp": "2026-04-02T10:30:00Z",
  "model": "claude-sonnet-4-20250514",
  "interactions": [
    {
      "prompt": "Implement JWT auth middleware",
      "contexts": [
        {
          "kind": "scope",
          "source": "current_response",
          "text": "I will create the JWT auth middleware and wire it into the request pipeline."
        }
      ],
      "selection": {
        "schema": 1,
        "source": "primary",
        "signals": ["primary_edit_turn"]
      },
      "response": "I'll create the middleware...",
      "files_touched": ["src/auth.ts"],
      "tools": ["Edit"]
    }
  ],
  "files": [
    { "path": "src/auth.ts", "by_ai": true },
    { "path": "CHANGELOG.md", "by_ai": false }
  ],
  "attribution": {
    "ai_ratio": 60,
    "method": "line",
    "lines": { "ai_added": 45, "total_added": 75, "deleted": 3 }
  }
}

Security & Privacy

  • Agent Note Local-first. Core CLI bekerja tanpa Hosted Service.
  • Temporary Session Data disimpan di .git/agentnote/ dalam repositori Anda.
  • Permanent Record disimpan di refs/notes/agentnote, bukan di Tracked Source Files.
  • Untuk Agents yang menyimpan log percakapan lokal, Agent Note membaca file tersebut dari Data Directory milik Agent.
  • CLI tidak mengirim Telemetry.
  • Commit Tracking bersifat Best-effort. Jika Agent Note gagal saat Hook, git commit Anda tetap berhasil.

Design

Zero runtime dependencies · Git notes storage · Never breaks git commit · No telemetry · Agent-agnostic architecture

Detail arsitektur →

Contributing

Contributing guide → · Code of Conduct →

License

MIT — LICENSE