Choose your integration
Find the setup guide for your editor, agent, or application on macOS, Linux, and Windows.
On this page
Choose the tool you use, then follow its installation, configuration, and verification steps. New to the API? Start with Quickstart. Prefer to let your coding agent do it? Use the setup prompts.
One command for coding agents: npx routerplex finds Claude Code, Codex, OpenCode, Pi, Hermes, Aider and OpenClaw on your machine and configures them for you. See RouterPlex CLI.
Editors and agents #
| Integration | macOS | Linux | Windows | Start here |
|---|---|---|---|---|
| Cursor | Desktop | Desktop | Desktop | Chat setup and limitations |
| Cline and Continue | VS Code extension | VS Code extension | VS Code extension | Extension setup |
| Roo Code — legacy | Discontinued | Discontinued | Discontinued | Status and migration |
| VS Code built-in Chat | Desktop | Desktop | Desktop | Custom Endpoint |
| Codex VS Code extension | VS Code extension | VS Code extension | Native or WSL | Extension setup |
| Zed | Desktop | Desktop | Desktop | Custom provider |
| Claude Code | Terminal | Terminal | PowerShell or WSL | Claude Code |
| Codex CLI | Terminal | Terminal | PowerShell or WSL | Codex CLI |
| OpenCode | Terminal | Terminal | PowerShell or WSL | OpenCode |
| OpenClaw | Terminal / Gateway | Terminal / Gateway | Native or WSL | OpenClaw |
| Hermes Agent | Terminal | Terminal | WSL | Hermes Agent |
| Pi | Terminal | Terminal | npm or WSL | Pi |
| Aider | Terminal | Terminal | PowerShell or WSL | Aider |
| OpenHands | Docker / CLI | Docker / CLI | WSL2 + Docker | OpenHands |
These are setup paths, not a certification of every OS version, client release, or model. Use each vendor's current supported OS/runtime and a model with the capabilities your tool requires. Cursor custom models are subject to Cursor's own support and account restrictions.
Application libraries #
Python, JavaScript, and TypeScript examples can run on macOS, Linux, and Windows:
- OpenAI Python and JavaScript SDKs
- Anthropic Python and JavaScript SDKs
- LangChain, LlamaIndex, and Vercel AI SDK
Prepare the environment and runtime, then run the complete example in the matching guide.
Pick the right URL #
| Client | Setting | Value |
|---|---|---|
| OpenAI SDKs, OpenCode, Aider, Zed, Cline, Continue, Hermes, Pi | Base URL | https://api.routerplex.com/v1 |
| Claude Code and Anthropic SDKs | Base URL | https://api.routerplex.com |
| Codex | Base URL + wire API | https://api.routerplex.com/v1 + responses |
| VS Code Custom Endpoint | Model endpoint | https://api.routerplex.com/v1/chat/completions |
Use exact model IDs from the catalog. Only tools such as Aider and OpenHands add an openai/ prefix; OpenCode and OpenClaw use their configured routerplex/ provider prefix.
Check a connection #
- Send the short test from your guide.
- Confirm it returned a reply.
- Find the request under your dedicated key in Usage.
- For coding agents, also run one tool round trip: ask the agent to list its tools, read a small
README.md, and reply with its first heading. Run it with your real MCP servers and plugins loaded. The short test sends no tools, and tool schemas are where models differ.
Rotate a key safely #
Keys are independent, so a new key never disturbs the old one. Create the new key, test it with the short test and the tool round trip in a fresh terminal, swap it into the tool's config, and start a new session. Revoke the old key last. Swapping in an untested key breaks every request of a running agent until you fix the config by hand.
If the connection fails, see environment setup and Errors. If an editor rejects a custom model, try the Quickstart with the same key to isolate the problem.