Skip to main content
This page walks you through installing CMX, signing in with your free account, connecting your coding agent, and verifying that requests are flowing through the gateway. You’ll be up and running in under a minute.
1

Install CMX

Choose the install method that fits your setup. The npm and pnpm methods require Node.js 18 or later. The curl method installs a standalone binary with no Node.js dependency.
After the install completes, open a new terminal and confirm the binary is available:
If the command is not found, see the Installation page for PATH setup instructions.
2

Complete Setup

Run the setup command to sign in and start the local gateway:
CMX opens a browser window for account sign-in. Complete the sign-in flow, then return to the terminal. CMX will detect any supported coding agents on your machine and prompt you to choose one to connect.
3

Connect Your Agent

Open the CMX terminal interface, navigate to CONFIG, select your coding agent, choose your provider, and press Connect. Then restart your coding agent so it picks up the new gateway address (127.0.0.1:17322).Verified agents and their connection steps:
  • Codex — CONFIG → Codex → select your connection → Connect → restart Codex
  • OpenCode — CONFIG → OpenCode → refresh the provider list → connect your provider → restart OpenCode
To confirm the connection is working, run:
4

Check Your Activity

Send a few messages in your coding agent, then check your local statistics:
Look for new requests in the output. If requests appear, CMX is receiving traffic from your agent and compression will activate once your session context grows large enough.
Short sessions often show little or no token savings. CMX only applies compression once a session crosses the configured context threshold, and the net saving must be positive before any summary is applied. Run a longer coding session — one with many back-and-forth turns — to see meaningful compression take effect.
Ready to explore further? The Installation page covers all install methods and platform-specific options. The Configuration page explains how to tune compression thresholds and manage agent connections.