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 | Artifact |
|---|---|---|
| macOS | arm64 | archgate-darwin-arm64 |
| Linux | x86_64 | archgate-linux-x64 |
| Windows | x86_64 | archgate-win32-x64 |
The correct binary is downloaded automatically from GitHub Releases on first run and cached to ~/.archgate/bin/.
Verify installation
Section titled “Verify installation”archgate --versionYou should see the installed version printed to stdout.
Install via proto
Section titled “Install via proto”If you use proto (moonrepo’s toolchain manager), you can install Archgate directly as a proto plugin — no Node.js or npm required.
Add the plugin to your .prototools:
[plugins.tools]archgate = "github://archgate/proto-plugin"Then install and use it like any other proto tool:
proto install archgatearchgate checkProto manages the binary for you, including version pinning and auto-installation. To pin a specific version, add it at the root of .prototools:
archgate = "0.15.0"
[plugins.tools]archgate = "github://archgate/proto-plugin"You can also list available versions and manage installations with proto commands:
proto list-remote archgate # list available versionsproto install archgate 0.15.0 # install a specific versionproto pin archgate 0.15.0 # pin version in .prototoolsNext 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.