archgate adr

archgate adr create

Cria um novo ADR interativamente ou via flags.

archgate adr create [options]

Quando executado sem --title e --domain, o comando solicita interativamente o domínio, título e padrões de arquivo opcionais. Quando ambos --title e --domain são fornecidos, ele executa de forma não interativa.

O ID do ADR é gerado automaticamente com o prefixo do domínio e o próximo número de sequência disponível (ex.: ARCH-002, BE-001).

Opções

Opção	Descrição
--title <title>	Título do ADR (pula o prompt interativo)
--domain <domain>	Domínio do ADR. Integrados: backend, frontend, data, architecture, general. Domínios personalizados devem ser registrados antes via archgate adr domain add.
--files <patterns>	Padrões de arquivo, separados por vírgula
--body <markdown>	Corpo completo do ADR em markdown (pula o template)
--rules	Define rules: true no frontmatter
--json	Saída como JSON

Exemplos

Modo interativo:

archgate adr create

Modo não interativo:

archgate adr create \
  --title "API Response Envelope" \
  --domain backend \
  --files "src/api/**/*.ts" \
  --rules

---

archgate adr list

Lista todos os ADRs do projeto.

archgate adr list [options]

Opções

Opção	Descrição
--json	Saída como JSON
--domain <domain>	Filtrar por domínio

Exemplos

Listar todos os ADRs em formato de tabela:

archgate adr list

ID          Domain        Rules  Title
────────────────────────────────────────────────────────
ARCH-001    architecture  true   Command Structure
ARCH-002    architecture  true   Error Handling
BE-001      backend       true   API Response Envelope

Listar ADRs como JSON:

archgate adr list --json

Filtrar por domínio:

archgate adr list --domain backend

---

archgate adr show

Exibe um ADR específico pelo ID.

archgate adr show <id>

Imprime o conteúdo completo do ADR (frontmatter e corpo) na saída padrão.

Argumentos

Argumento	Descrição
<id>	ID do ADR (ex.: ARCH-001, BE-003)

Exemplo

archgate adr show ARCH-001

---

archgate adr update

Atualiza um ADR existente pelo ID.

archgate adr update --id <id> --body <markdown> [options]

Substitui o corpo do ADR pelo markdown fornecido. Campos do frontmatter (--title, --domain, --files, --rules) são atualizados apenas quando passados explicitamente; caso contrário, os valores existentes são preservados.

Opções

Opção	Obrigatório	Descrição
--id <id>	Sim	ID do ADR a atualizar (ex.: ARCH-001)
--body <markdown>	Sim	Corpo completo do ADR em markdown (substitui o existente)
--title <title>	Não	Novo título do ADR (preserva o existente se omitido)
--domain <domain>	Não	Novo domínio. Integrados: backend, frontend, data, architecture, general. Domínios personalizados devem ser registrados antes via archgate adr domain add.
--files <patterns>	Não	Novos padrões de arquivo, separados por vírgula (preserva existente se omitido)
--rules	Não	Define rules: true no frontmatter
--json	Não	Saída como JSON

Exemplo

archgate adr update \
  --id ARCH-001 \
  --title "Updated Command Structure" \
  --body "## Context\n\nUpdated context..."

---

archgate adr domain

Gerencia domínios ADR personalizados. Domínios personalizados são mapeamentos nome → prefixo de ID persistidos em .archgate/config.json e mesclados com os cinco integrados (backend, frontend, data, architecture, general) no momento da leitura.

Use este comando quando uma decisão não se encaixar claramente em nenhum domínio integrado. Antes de registrar um novo, verifique se a decisão pode ser agrupada sob um domínio existente — integrados são o padrão e um domínio personalizado deve ser introduzido apenas quando nenhum integrado for uma opção genuína.

archgate adr domain <subcommand> [options]

Subcomandos

Subcomando	Descrição
archgate adr domain list	Exibe todos os domínios mesclados (integrados + personalizados) e seus prefixos
archgate adr domain add <name> <prefix>	Registra um domínio personalizado
archgate adr domain remove <name>	Remove um domínio personalizado (integrados não podem ser removidos)

Regras de nomenclatura

• <name> — kebab-case em minúsculas, 2–32 caracteres (ex.: security, ml-ops)
• <prefix> — letras maiúsculas, dígitos ou underscores, 2–10 caracteres (ex.: SEC, MLOPS)
• Nomes e prefixos personalizados não podem colidir com integrados ou com qualquer outra entrada personalizada.

Opções

Opção	Aplica-se a	Descrição
--json	todos os subcomandos	Saída como JSON

Exemplos

Listar domínios integrados e personalizados:

archgate adr domain list

Domain          Prefix    Source
────────────────────────────────
architecture    ARCH      default
backend         BE        default
data            DATA      default
frontend        FE        default
general         GEN       default
security        SEC       custom

Registrar um domínio personalizado:

archgate adr domain add security SEC

Remover um domínio personalizado:

archgate adr domain remove security