Installation
Quick Install
Section titled “Quick Install”The fastest way to get started:
npx @openlatch/client initThis downloads the OpenLatch client, configures your agent hooks, and starts protecting your environment. No global install required.
npx is part of Node.js, so this command needs Node.js on the machine. The client itself does not — it is a native binary.
Prerequisites
Section titled “Prerequisites”- An internet connection for the initial setup and the control plane
Install Without Node.js
Section titled “Install Without Node.js”On a machine that does not have Node.js, install from a script. The script needs nothing beyond what the operating system ships.
macOS and Linux:
curl -LsSf https://openlatch.ai/install.sh | shWindows:
powershell -ExecutionPolicy Bypass -c "irm https://openlatch.ai/install.ps1 | iex"Both scripts download the same client build from the npm registry that the npx command installs, then run openlatch init for you.
What the Install Does
Section titled “What the Install Does”- Installs for your user only. No administrator rights are needed.
- Places two binaries,
openlatchandopenlatch-hook, in~/.local/binon macOS and Linux, or%LOCALAPPDATA%\openlatch\binon Windows. - Adds that directory to your PATH. When the shell you ran the command in cannot see it yet, the result shown at the end of setup tells you to open a new terminal.
- Runs
openlatch initby its full path when the install finishes, so enrolment still works in that first shell. Its result is the last thing the script shows. - Checks the download before installing it. A SHA-512 digest is compared against the digest the package registry publishes for that release. This detects a corrupted or truncated download. It is not a signature, and it does not detect a compromised registry.
Exit Status
Section titled “Exit Status”For deployment tools that read the script’s exit status:
| Status | Meaning |
|---|---|
0 |
Installed and set up. The result may still name one thing to look at |
6 |
Installed, but setup did not finish. The result on screen says why |
7 |
Installed, waiting for an AI agent: none is on the machine yet. Install one and run the script again |
2–5 |
Nothing usable was installed. The script prints an OL-21xx code naming the reason |
Platform Support
Section titled “Platform Support”| Platform | Status |
|---|---|
| macOS — Apple silicon and Intel | Supported |
| Linux with glibc — x86_64 and arm64 | Supported |
| Windows — x64 | Supported |
| Linux with musl, such as Alpine | Not supported — the install script stops and names the reason |
| Windows on ARM64 | Not supported — the install script stops and names the reason |
Global Install With npm or pnpm
Section titled “Global Install With npm or pnpm”If you prefer to install globally, with Node.js already on the machine:
npm install -g @openlatch/clientopenlatch initOr with pnpm:
pnpm add -g @openlatch/clientopenlatch initVerifying the Installation
Section titled “Verifying the Installation”After installation, verify that OpenLatch is running:
openlatch statusYou should see output confirming the client is active and connected to the control plane.
Next Steps
Section titled “Next Steps”Once installed, follow the Getting Started guide to see OpenLatch in action.