Início Rápido

Este passo a passo conduz você pelo ciclo de governança completo de ponta a ponta: instalar a CLI, fazer o scaffold de um projeto, rodar uma verificação, adicionar um plugin de editor e fazer o seu agente de IA revisar o código contra os seus ADRs. Deve levar menos de 10 minutos.

1. Instale a CLI

   Se você ainda não instalou o Archgate, use o instalador de uma linha (sem necessidade de Node.js):

   macOS / Linux

   curl -fsSL https://cli.archgate.dev/install-unix | sh

   Windows (PowerShell)

   irm https://cli.archgate.dev/install-windows | iex

   Consulte Instalação para proto, npm e todas as outras opções.

2. Inicialize o seu projeto

   A partir da raiz do seu projeto, faça o scaffold da governança:

   cd my-project
   archgate init

   Isso cria um diretório .archgate/ contendo um ADR de exemplo, o arquivo de regras .rules.ts que o acompanha e a configuração do Archgate. Os arquivos gerados são um exemplo funcional sobre o qual você pode construir. O layout completo e o formato do frontmatter do ADR estão documentados no Início Rápido da CLI.

3. Rode a sua primeira verificação

   Rode o verificador determinístico de conformidade contra o seu código:

   archgate check

   O Archgate carrega cada ADR marcado com rules: true, executa o arquivo de regras que o acompanha e reporta quaisquer violações com caminhos de arquivo e números de linha. O código de saída informa o resultado — 0 significa que tudo está em conformidade, 1 significa que uma ou mais violações foram encontradas, 2 significa um erro interno.

   Este é o estágio de detecção do ciclo, e é o portão rígido que você conecta ao CI e ao pre-commit. Para verificar apenas os arquivos no stage:

   archgate check --staged

   Conecte ao seu fluxo de trabalho

   Assim que a verificação passar localmente, adicione-a ao seu pipeline. Consulte Integração com CI e Hooks de Pre-commit.

4. Adicione um plugin de editor

   A CLI funciona de forma standalone, mas é o plugin de editor que fecha o ciclo — ele dá ao seu agente de IA um fluxo de trabalho de governança para que ele leia os seus ADRs antes de programar e valide depois. O plugin está atualmente em beta, então primeiro autentique-se:

   archgate login

   Isso inicia um fluxo de dispositivo do GitHub: a CLI mostra um código de uso único e uma URL, você autoriza no navegador e as credenciais são armazenadas com segurança. Uma vez logado, instale o plugin para o seu editor:

   archgate plugin install

   O Archgate suporta seis editores — Claude Code, Cursor, VS Code, Copilot CLI, Claude Desktop e OpenCode. Para ver o que cada plugin adiciona e a configuração exata por editor, consulte a visão geral dos Plugins.

   Primeira vez em um projeto?

   Rode a skill @onboard uma vez após a instalação. Ela explora o seu código, entrevista você sobre as suas convenções e cria um conjunto inicial de ADRs. Consulte Skills.

5. Rode o reviewer

   Agora exercite a camada de IA. Depois que o seu agente (ou você) fizer uma mudança de código, invoque a skill @reviewer no seu editor:

   @reviewer

   O reviewer reúne todos os ADRs aplicáveis às suas mudanças via archgate review-context, roda as verificações automatizadas e delega cada domínio afetado a um sub-agente focado que verifica a conformidade — detectando os julgamentos que um linter não consegue fazer. Esta é a metade de revisão por IA do estágio de detecção.

   Quando o reviewer ou um incidente real revela um padrão que vale a pena codificar, rode a skill @lessons-learned para capturá-lo em um ADR novo ou atualizado. Essa nova regra retorna à prevenção — na próxima vez que o seu agente escrever código, ele lê essa decisão antes de começar. O ciclo está agora fechado.

O que você acabou de fazer

Você rodou todos os estágios do ciclo de governança:

• Prevenção — archgate init fez o scaffold dos ADRs; o plugin os entrega ao seu agente de IA como contexto.
• Detecção — archgate check validou de forma determinística; @reviewer adicionou julgamento de IA.
• Aprendizado — @lessons-learned transforma descobertas em novas regras que fortalecem a prevenção.

O que vem a seguir

Conceitos: o ciclo de governança Aprofunde-se em prevenção, detecção e aprendizado.

Plugins de Editor Compare os seis editores suportados e suas configurações.

Skills Reviewer, lessons-learned, adr-author, onboard e cli-reference.

ADR Packs Importe ADR packs prontos em vez de escrever cada regra você mesmo.

Início Rápido da CLI Escreva o seu primeiro ADR e regra, com detalhes completos de comando e schema.

Integração com CI Bloqueie merges quando regras forem violadas.