Instalar Agent Skills do ADR Guard
As Agent Skills e a CLI .NET do ADR Guard são instalações independentes. A skill orienta o agente; a CLI executa operações determinísticas e valida a documentação. É possível discutir decisões sem a ferramenta, mas o agente não pode afirmar que validou arquivos sem executá-la.
Pré-requisitos
Seção intitulada “Pré-requisitos”- Um agente compatível com Agent Skills, como o Codex.
- Node.js e
npxpara executar o Skills CLI. Verifique as políticas da sua organização antes de executar pacotes comnpx. - A .NET Tool do ADR Guard para tarefas que dependem de comandos. Revisão ou escrita com provedores de IA são opcionais e exigem provedor, modelo e credenciais específicos.
1. Descubra as skills
Seção intitulada “1. Descubra as skills”Execute no repositório que vai consumir as skills:
npx skills add rodri-oliveira-dev/adr-guard --listLeia as instruções antes de instalar: uma skill contém orientações executáveis pelo agente, e seu conteúdo deve ser tratado com o mesmo cuidado de outras dependências.
Atenção à branch: o comando acima descobre skills da branch padrão. Ao revisar alterações ainda não incorporadas, consulte diretamente a branch da proposta, sem presumir que já estão disponíveis na listagem padrão.
2. Instale somente o necessário
Seção intitulada “2. Instale somente o necessário”Para criar ADRs usando o Codex:
npx skills add rodri-oliveira-dev/adr-guard --skill adr-guard-create --agent codexPara comparar alternativas:
npx skills add rodri-oliveira-dev/adr-guard --skill adr-guard-tradeoff-analysis --agent codexO catálogo descreve as 11 skills. Para outros agentes, confirme no help atual do Skills CLI os identificadores e modos suportados. Evite instalar todas sem necessidade.
3. Instale o ADR Guard separadamente
Seção intitulada “3. Instale o ADR Guard separadamente”Se a tarefa utilizar init, new, check, index ou review, instale a .NET Tool e confira sua versão:
dotnet tool install --global RodriOliveira.AdrGuardadr-guard --versionAtualização de uma instalação global existente:
dotnet tool update --global RodriOliveira.AdrGuardNão instale ferramentas ou altere o repositório sem autorização. Equipes podem adotar ferramentas locais com versões fixadas.
4. Experimente uma tarefa segura
Seção intitulada “4. Experimente uma tarefa segura”Peça ao agente:
Analise este repositório e explique se a escolha do Redis como cache distribuído precisa de um ADR. Liste restrições conhecidas, dúvidas, alternativas e pessoas que devem revisar. Ainda não altere arquivos.
Se decidir documentar, autorize o agente a visualizar uma proposta antes de escrever:
adr-guard new docs/adr --title "Usar Redis para cache" --template extended --culture pt-BR --previewO diretório de ADRs deve existir. Com autorização, o agente pode executar new, check e index; o registro começa como Proposed.
Solução de problemas
Seção intitulada “Solução de problemas”| Problema | O que verificar |
|---|---|
--list não encontra as skills |
Elas já foram incorporadas à branch padrão? |
A skill é reconhecida, mas o comando adr-guard não existe |
Instale ou restaure a .NET Tool independente e execute adr-guard --version. |
| A CLI rejeita um ADR | Verifique .adrguard.yml, seções canônicas, formato e diagnósticos reais; veja validação. |
| A revisão com IA pede credenciais | Defina provedor e modelo e autorize o envio de contexto. Não há escolha automática de provedor. |
| MADR 4.0 não corresponde ao template gerado | MADR é escrito separadamente e validado com --adr-format madr-4; new não gera arquivos MADR. |
Próximos passos: catálogo, exemplos e limites de segurança.