コマンド

このページは、Agent Note の全体像を把握したあとに、ユーザーが直接使うコマンドや flag を確認するための reference です。最初の導入手順だけ見たい場合は、先に インストール を読んでください。

よく使うコマンド

• 最初のセットアップ: agent-note init
• Agent Note をリポジトリから削除する: agent-note deinit
• hook と有効な adapter を確認する: agent-note status
• 最近の活動を一覧する: agent-note log
• コミットに何が記録されたか見る: agent-note show
• その行がなぜ変わったか見る: agent-note why

ノート

PR Report と Dashboard は GitHub Actions の機能です。通常は agent-note init が workflow ファイルを作成し、実際の report と Dashboard は後でその workflow が生成します。

agent-note init

リポジトリに Agent Note をセットアップします。

npx agent-note init --agent claude

フラグ	説明
--agent <name...>	1 つ以上の Agent adapter を選びます: claude, codex, cursor or gemini
--dashboard	共有 Dashboard workflow も作成
--no-hooks	Agent hook 設定をスキップ
--no-git-hooks	Git Hooks のインストールをスキップ
--no-action	workflow 作成をスキップ
--no-notes	notes auto-fetch 設定をスキップ
--hooks	Agent hooks だけをインストール
--action	workflow だけを作成

agent-note deinit

1 つ以上の Agent の hooks と config を削除します。

npx agent-note deinit --agent claude

フラグ	説明
--agent <name...>	claude, codex, cursor or gemini
--remove-workflow	PR Report と Dashboard の workflow も削除
--keep-notes	notes auto-fetch 設定を残す

agent-note status

現在の記録状態を表示します。

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-note log

最近の Commit と AI Ratio を一覧します。

npx agent-note log
npx agent-note log 20

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

agent-note show

Commit の AI Session 詳細を表示します。

npx agent-note show
npx agent-note show abc1234

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  👤

prompts: 2

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

agent-note why

指定した行を最後に変更した Commit を git blame で調べ、その Commit に紐づく Agent Note context を表示します。

npx agent-note why src/middleware/auth.ts:42
npx agent-note why src/middleware/auth.ts:42-55
npx agent-note why src/middleware/auth.ts:42:7
npx agent-note why src/middleware/auth.ts#L42
npx agent-note why src/middleware/auth.ts#L42-L55
npx agent-note why src/middleware/auth.ts#L42C7
npx agent-note why @src/middleware/auth.ts#L42
npx agent-note why https://github.com/owner/repo/blob/main/src/middleware/auth.ts#L42
npx agent-note why file:///workspace/repo/src/middleware/auth.ts#L42
npx agent-note why vscode://file/workspace/repo/src/middleware/auth.ts:42:7

ノート

why は path:line、path:line-end、path:line:column、path#Lline、path#Lline-Lend、path#LlineCcol、GitHub file URL、file://...、vscode://file...、AI Agent の出力からコピーした先頭 @ 付き path を受け付けます。

AI Agent Skill

利用している AI Agent が GitHub Agent Skills に対応している場合は、Agent Note Skill を入れておくと自然言語で Agent Note の作業を頼めます。

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

gh skill install の --agent には、利用する Agent に合わせて codex, claude-code, cursor or gemini-cli を指定します。