Skip to main content

​
Quickstart

​
1. Install

Choose one method from the installation guide. For Linux or macOS, the standalone installer is:
For Windows, run in PowerShell:
The standalone installers run setup and ask whether to connect ready coding clients. Yes connects those listed. No leaves them on their direct connections and prints the commands for connecting later. If the terminal cannot read an answer, setup reports an error; open an interactive terminal and run cmx setup --ask-connect-ready.

​
2. Check the gateway and choose a client

If you declined automatic connection, list the providers discovered for your client, then connect one by its displayed ID:
For Codex, use api for its OpenAI API sign-in or chatgpt for its ChatGPT sign-in. Other clients have different IDs; see supported clients. You can also open cmx and choose CONFIG. cmx providers <client> list only reports status; it does not connect the client. If you installed a package without running setup, run cmx setup --ask-connect-ready to make this choice. Plain cmx setup starts the gateway and may connect Codex’s existing sign-in.

​
3. Confirm a real request

Restart the coding client, then run:
Send a short request in the client and run cmx stats again. New activity shows that requests are reaching CMX. A running gateway or a successful harness verify alone does not prove the client sent traffic.

​
4. Return to a direct connection

Use the provider ID you connected. For all supported clients, cmx stop restores direct routing before stopping the gateway. A later cmx start may reconnect routes that stop saved; use the provider disconnect command or cmx harness disable <client> when you want to stay direct. See Undo and uninstall.
Local compression works without CMX account sign-in. Run cmx login only to link this device to your account dashboard.
Last modified on September 24, 2026