Installation
Install standalone (recommended)
Section titled “Install standalone (recommended)”The fastest way to install Archgate — no Node.js or package manager required:
# macOS / Linuxcurl -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 | shThis 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:
| Variable | Description | Default |
|---|---|---|
ARCHGATE_VERSION | Install a specific version (e.g. v0.11.2) | Latest release |
ARCHGATE_INSTALL_DIR | Custom install directory | ~/.archgate/bin |
You can also download binaries directly from GitHub Releases.
Install via npm
Section titled “Install via npm”Install Archgate globally using your preferred Node.js package manager:
# npmnpm install -g archgate
# Bunbun install -g archgate
# Yarnyarn global add archgate
# pnpmpnpm add -g archgateThis 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.
Install as a dev dependency
Section titled “Install as a dev dependency”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.
# npmnpm install -D archgate
# Bunbun add -d archgate
# Yarnyarn add -D archgate
# pnpmpnpm add -D archgateThen run Archgate via your package manager:
# npm / Yarn / pnpmnpx archgate check
# Bunbun run archgate checkOr add a script to your package.json:
{ "scripts": { "check:adrs": "archgate check" } }# Works with any package managernpm run check:adrsbun run check:adrsyarn check:adrspnpm check:adrsPlatform support
Section titled “Platform support”Archgate ships pre-built binaries for the following platforms:
| Platform | Architecture | Package |
|---|---|---|
| macOS | arm64 | archgate-darwin-arm64 |
| Linux | x86_64 | archgate-linux-x64 |
| Windows | x86_64 | archgate-win32-x64 |
The correct binary is installed automatically as an optionalDependency when you install archgate.
Verify installation
Section titled “Verify installation”archgate --versionYou should see the installed version printed to stdout.
Proto toolchain users
Section titled “Proto toolchain users”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:
[tools.npm]shared-globals-dir = trueThen add the globals directory to your shell profile (.bashrc, .zshrc, or equivalent):
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.
Next steps
Section titled “Next steps”Once installed, run archgate init in your project to set up governance. See the Quick Start guide for a walkthrough.