Skip to content

Installation

The fastest way to install Archgate — no Node.js or package manager required:

Terminal window
# macOS / Linux
curl -fsSL https://cli.archgate.dev/install-unix | sh
# Windows (PowerShell)
irm https://cli.archgate.dev/install-windows | iex
# Windows (Git Bash / MSYS2)
curl -fsSL https://cli.archgate.dev/install-unix | sh

This downloads a pre-built binary for your platform and installs it to ~/.archgate/bin/. The installer detects your shell profiles and offers to add the directory to your PATH.

On Windows, the PowerShell installer also detects Git Bash shell profiles (.bashrc, .bash_profile, .profile) and offers to configure PATH there as well.

You can customize the install with environment variables:

VariableDescriptionDefault
ARCHGATE_VERSIONInstall a specific version (e.g. v0.11.2)Latest release
ARCHGATE_INSTALL_DIRCustom install directory~/.archgate/bin

You can also download binaries directly from GitHub Releases.

Install Archgate globally using your preferred Node.js package manager:

Terminal window
# npm
npm install -g archgate
# Bun
bun install -g archgate
# Yarn
yarn global add archgate
# pnpm
pnpm add -g archgate

This installs a lightweight wrapper that delegates to a platform-specific binary. The CLI itself is a standalone binary compiled with Bun — Node.js is only needed for the npm/yarn/pnpm wrapper.

You can also add Archgate as a dev dependency in your project and run it through your package manager’s script runner. This is useful for pinning a specific version per project or running checks in CI without a global install.

Terminal window
# npm
npm install -D archgate
# Bun
bun add -d archgate
# Yarn
yarn add -D archgate
# pnpm
pnpm add -D archgate

Then run Archgate via your package manager:

Terminal window
# npm / Yarn / pnpm
npx archgate check
# Bun
bun run archgate check

Or add a script to your package.json:

{ "scripts": { "check:adrs": "archgate check" } }
Terminal window
# Works with any package manager
npm run check:adrs
bun run check:adrs
yarn check:adrs
pnpm check:adrs

Archgate ships pre-built binaries for the following platforms:

PlatformArchitecturePackage
macOSarm64archgate-darwin-arm64
Linuxx86_64archgate-linux-x64
Windowsx86_64archgate-win32-x64

The correct binary is installed automatically as an optionalDependency when you install archgate.

Terminal window
archgate --version

You should see the installed version printed to stdout.

If you manage Node.js with proto (moonrepo’s toolchain manager), globally installed npm binaries require an additional setup step.

Add to your proto configuration:

~/.proto/config.toml
[tools.npm]
shared-globals-dir = true

Then add the globals directory to your shell profile (.bashrc, .zshrc, or equivalent):

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

Restart your shell, then run npm install -g archgate again. The archgate command should now be available globally.

Once installed, run archgate init in your project to set up governance. See the Quick Start guide for a walkthrough.