Skip to content

Installation

The fastest way to get started:

Terminal window
npx @openlatch/client init

This 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.

  • An internet connection for the initial setup and the control plane

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:

Terminal window
curl -LsSf https://openlatch.ai/install.sh | sh

Windows:

Terminal window
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.

  • Installs for your user only. No administrator rights are needed.
  • Places two binaries, openlatch and openlatch-hook, in ~/.local/bin on macOS and Linux, or %LOCALAPPDATA%\openlatch\bin on 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 init by 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.

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 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

If you prefer to install globally, with Node.js already on the machine:

Terminal window
npm install -g @openlatch/client
openlatch init

Or with pnpm:

Terminal window
pnpm add -g @openlatch/client
openlatch init

After installation, verify that OpenLatch is running:

Terminal window
openlatch status

You should see output confirming the client is active and connected to the control plane.

Once installed, follow the Getting Started guide to see OpenLatch in action.