Skip to content

The ProtoMap CLI scans repositories on your computer or in CI and uploads the scans to your ProtoMap Server. It also connects coding agents to the graph.

On macOS and Linux:

bash
curl -fsSL https://protomap.ai/install.sh | sh

On Windows, in PowerShell:

powershell
irm https://protomap.ai/install.ps1 | iex

The scripts install the latest release from the releases page, after checking it against the release’s SHA256SUMS. The CLI goes to ~/.local/bin on macOS and Linux, and to %LOCALAPPDATA%\protomap\bin on Windows, or to the folder PROTOMAP_INSTALL_DIR names. On Windows, the script adds the folder to your PATH; on macOS and Linux, it adds it to your shell’s profile (zsh, bash, or fish) when it is not on your PATH yet, so open a new terminal afterwards.

System Architectures Notes
macOS x86_64, arm64
Linux x86_64, arm64 Needs glibc 2.28 or newer (not Alpine/musl).
Windows x86_64, arm64

To match the release your server runs, pass the version:

bash
curl -fsSL https://protomap.ai/install.sh | sh -s -- 1.2.3
powershell
& ([scriptblock]::Create((irm https://protomap.ai/install.ps1))) 1.2.3

Run the install command again. Check the installed version with:

bash
protomap --version

When you log in, the CLI warns you if its release differs from the server’s.

Run protomap logout to revoke this computer’s key, then delete the protomap program from the folder it was installed to, and the .protomap folder in your home folder, which holds your login.

Command What it does
protomap login --server=<URL> Logs in to your server in a browser, so scans upload as you. See Authentication.
protomap logout Forgets the server and revokes this computer’s key on it.
protomap scan [PATH] Scans the repository that contains PATH (the current folder by default) and uploads the scan. See Scanning.
protomap mcp serve Serves the graph to a coding agent over MCP. See Coding Agents.

Run protomap --help, or protomap <command> --help, for every option.