Install CMX

CMX provides binaries for Linux, macOS, and Windows on x64 and ARM64. Install the coding client you want to use separately, and sign in to its model provider through that client.

Standalone installer

Linux and macOS
Windows PowerShell

curl -sSfL https://compressi.us/install.sh | sh

The script downloads the matching release binary, checks it against SHA256SUMS, and installs to /usr/local/bin when writable or ~/.local/bin otherwise. It then runs cmx setup --ask-connect-ready unless CMX_SKIP_START=1 is set.

iwr -useb https://compressi.us/install.ps1 | iex

The script verifies the binary checksum, installs to %LOCALAPPDATA%\CMX\bin, adds that folder to your user PATH, and creates a Start menu shortcut. It then runs cmx setup --ask-connect-ready. Open a new terminal if cmx is not found immediately.

Connect ready agents during install

Before the standalone installer changes any coding client settings, it asks for your consent. After setup starts, CMX lists the coding clients and providers it found that are ready to connect, then asks:

CMX found these ready coding clients and providers:
  • codex — ChatGPT
CMX will update their client settings to route requests through the local gateway.
Configure all listed providers now? [y/N]:

Yes (y): CMX routes every listed client through the local gateway. It also turns on a background check that runs at most once every 24 hours when you use cmx commands to connect coding clients you configure later.
No (n, or press Enter): CMX leaves your client settings unchanged. The 24-hour check stays off, and later cmx start runs don’t connect clients on their own.

No is the default. If no interactive terminal is available, such as in CI or a piped non-interactive shell, CMX skips the prompt and makes no routing changes; retry with cmx setup --ask-connect-ready in an interactive terminal.

If you declined, you can connect agents later. Run cmx setup --connect-ready to connect all ready providers and turn on the 24-hour check:

cmx setup --connect-ready

To connect a single agent instead, use cmx harness enable <client> or the CONFIG screen in the cmx terminal interface.

The prompt concerns client routing, not CMX account registration. A CMX account is optional for local use. Provider sign-in remains in the coding client.

npm or pnpm

If you already use Node.js, install the published package:

npm install --global @compressius/cmx
# or
pnpm add --global @compressius/cmx

The package fetches the matching published binary and verifies its checksum. Follow it with cmx setup --ask-connect-ready if setup has not run. Check the package’s current Node.js requirement with your package manager; the binary itself does not require Node.js.

Verify and connect

cmx --version
cmx status
cmx harness list

Use the quickstart to connect one client and confirm real traffic. To keep clients direct, answer n at installation or use Undo and uninstall later.

Uninstall

To remove CMX, run:

cmx uninstall

The command restores your coding agents to their direct connections, stops the gateway, removes background services, and deletes CMX configuration, data, and the executable. See Undo and uninstall for flags and the platform-specific cleanup.