Configure Codex CLI to connect through OmniRoute on Linux, macOS, or Windows. The workflow detects the operating system and shell, creates configuration files and seven profiles, sets environment variables, and verifies the setup.
Step-by-step agent workflow to configure the OpenAI Codex CLI on any machine (Linux, macOS, Windows) to use OmniRoute as an OpenAI-compatible backend. Detects OS and shell, writes config.toml and 7 named profiles, sets environment variables, and verifies the setup.
Review the instructions the agent will receive before you install.
Step-by-step agent workflow to configure the OpenAI Codex CLI on any machine (Linux, macOS, Windows) to use OmniRoute as an OpenAI-compatible backend. Detects OS and shell, writes config.toml and 7 named profiles, sets environment variables, and verifies the setup.
npm install -g omniroute # or: npx omniroute
omniroute --version
No CLI subcommands mapped for this family yet.
<!-- skill:custom-start -->Two OmniRoute defaults silently break multi-hour Codex sessions. Document them whenever configuring Codex for overnight / multi-hour work. Full guide: docs/guides/CODEX-CLI-CONFIGURATION.md → Long-running tasks.
sessionAffinityTtlMs (ms; UI shows Affinity TTL (seconds) under Dashboard → Settings → Routing → Session affinity). Legacy alias: codexSessionAffinityTtlMs.0 = disabled. Each turn can land on a different account and break prompt-cache / session continuity.x-codex-session-id, x-session-id, x-omniroute-session, body prompt_cache_key / session_id) are only used for pinning when TTL > 0.86400 seconds / 86400000 ms (24h). Set TTL above the expected task length (e.g. 43200 s for ~12h).STREAM_IDLE_TIMEOUT_MS (default 600000). Also consider FETCH_BODY_TIMEOUT_MS (same baseline; 0 disables).stream_idle_timeout / StreamIdleTimeoutError). Grep logs for Idle timeout: no data from.43200 (12h) or 86400 (24h max).STREAM_IDLE_TIMEOUT_MS=0
FETCH_BODY_TIMEOUT_MS=0
config.toml as usual (wire_api = "responses", correct base_url).Do not flip ship defaults in code for this skill: sessionAffinityTtlMs stays 0 and STREAM_IDLE_TIMEOUT_MS stays 600000. Long-running operators must opt in. See Discussion #5718 and issue #7287.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Use the command line to send tasks to OmniRoute's A2A server, which supports communication between agents. Inspect execution history and logs, monitor or cancel tasks, and interactively test the JSON-RPC 2.0 communication protocol.
Back up and restore OmniRoute data from the command line. Manage incremental snapshots, scheduled backups, encryption, and cloud synchronization, with options to compare differences and preview data transfers or imports before applying them.
Submit groups of AI requests as batch jobs with the OmniRoute command line. Manage input files, monitor or cancel jobs, save results and errors, and incorporate batch processing into automated build and deployment workflows.
Send prompts to LLMs from a terminal, display answers as they arrive, or hold an ongoing conversation. Use files or standard input for prompts, choose models, and set system instructions through OmniRoute.
Configure prompt compression, which shortens text sent to AI models, through the OmniRoute command line. Adjust RTK filters, Caveman rules, and combined compression modes, then preview the results using real prompts.
Manage OmniRoute context settings from the command line, including token budgets and RTK filters for processing context. Switch saved server connections, import or export configurations, and inspect or expire conversation sessions.