Instalação

Name: Archgate CLI
Author: Archgate

Instalar globalmente

Instale o Archgate globalmente usando seu gerenciador de pacotes preferido:

# npm
npm install -g archgate

# Bun
bun install -g archgate

# Yarn
yarn global add archgate

# pnpm
pnpm add -g archgate

Isso instala um wrapper leve que delega para um binário específico da plataforma. A CLI em si é um binário standalone compilado com Bun — o Node.js é necessário apenas para o wrapper do npm/yarn/pnpm.

Instalar como dependência de desenvolvimento

Você também pode adicionar o Archgate como dependência de desenvolvimento no seu projeto e executá-lo através do script runner do seu gerenciador de pacotes. Isso é útil para fixar uma versão específica por projeto ou executar verificações no CI sem uma instalação global.

# npm
npm install -D archgate

# Bun
bun add -d archgate

# Yarn
yarn add -D archgate

# pnpm
pnpm add -D archgate

Depois execute o Archgate pelo seu gerenciador de pacotes:

# npm / Yarn / pnpm
npx archgate check

# Bun
bun run archgate check

Ou adicione um script ao seu package.json:

{
  "scripts": {
    "check:adrs": "archgate check"
  }
}

# Works with any package manager
npm run check:adrs
bun run check:adrs
yarn check:adrs
pnpm check:adrs

Suporte a plataformas

O Archgate disponibiliza binários pré-compilados para as seguintes plataformas:

Plataforma	Arquitetura	Pacote
macOS	arm64	`archgate-darwin-arm64`
Linux	x86_64	`archgate-linux-x64`
Windows	x86_64	`archgate-win32-x64`

O binário correto é instalado automaticamente como optionalDependency quando você instala o archgate.

Verificar a instalação

archgate --version

Você deverá ver a versão instalada impressa no stdout.

Usuários do Proto toolchain

Se você gerencia o Node.js com o proto (gerenciador de toolchain do moonrepo), binários npm instalados globalmente requerem um passo adicional de configuração.

Adicione à sua configuração do proto:

[tools.npm]
shared-globals-dir = true

Depois adicione o diretório de globais ao perfil do seu shell (.bashrc, .zshrc ou equivalente):

export PATH="$HOME/.proto/tools/node/globals/bin:$PATH"

Reinicie seu shell e execute npm install -g archgate novamente. O comando archgate agora deverá estar disponível globalmente.

Próximos passos

Após a instalação, execute archgate init no seu projeto para configurar a governança. Veja o guia de Início Rápido para um passo a passo.