Comandos

Esta página mostra apenas os comandos que usuários executam diretamente. Para o primeiro setup, comece por Instalação.

Tarefas comuns

• Primeiro setup: agent-note init
• Remover o Agent Note do repositório: agent-note deinit
• Verificar estado: agent-note status
• Revisar atividade recente: agent-note log
• Mostrar dados de um commit: agent-note show
• Entender por que uma linha mudou: agent-note why

Nota

PR Report e Dashboard são recursos do GitHub Actions. agent-note init normalmente cria os arquivos de workflow; os relatórios e o Dashboard são gerados depois por esses workflows.

agent-note init

Configura o Agent Note no repositório.

npx agent-note init --agent claude

Flag	Descrição
--agent <name...>	Escolha um ou mais adaptadores de agent: claude, codex, cursor or gemini
--dashboard	Também cria o workflow do Dashboard compartilhado
--no-hooks	Pula a configuração de hooks do agent
--no-git-hooks	Pula a instalação de Git Hooks
--no-action	Pula a criação de workflows
--no-notes	Pula a configuração de notes auto-fetch
--hooks	Instala apenas hooks do agent
--action	Cria apenas workflows

agent-note deinit

Remove hooks e config do Agent Note para um ou mais agents.

npx agent-note deinit --agent claude

Flag	Descrição
--agent <name...>	claude, codex, cursor or gemini
--remove-workflow	Também remove os workflows de PR Report e Dashboard
--keep-notes	Mantém a configuração de notes auto-fetch

agent-note status

Mostra o estado de rastreamento.

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

Lista commits recentes com 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

Mostra a AI Session de um commit.

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

Mostra o contexto do Agent Note por trás de uma linha alterada.

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

Nota

why aceita path:line, path#Lline, GitHub file URLs, file://..., vscode://file... e paths com @ inicial copiados de um AI Agent.

AI Agent Skill

Instale o Agent Note Skill para pedir essas tarefas em linguagem natural.

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

Para gh skill install, escolha o identificador de agente correto: codex, claude-code, cursor or gemini-cli.