mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-25 08:32:11 +03:00

Files

Xiangzhe c2df757610 fix(tests): drain base-red cluster from 2026-08-23 merges (#9985 )

Drain the unit-shard reds the 2026-08-23 merge wave left on
release/v3.8.50, each discriminated as stale-test (contract moved
intentionally, test aligned) vs real bug (fixed in code/messages):

1. check-deps 6A.8 allowlist — #11224 added @testing-library/dom and
   @testing-library/user-event to package.json without the gate
   allowlist. Both are legitimate: @testing-library/dom is a required
   peer of @testing-library/react v16, and user-event is the official
   companion for UI tests. Fix: allowlist entries with a justification
   note referencing #11224/#9985.

2. search-route 400-vs-fallback — #11097 intentionally changed the
   zero-credential /v1/search contract: instead of returning 400 it
   promotes the fallback-only duckduckgo-free provider so out-of-the-box
   search works. The test pinned the OLD 400 contract. Fix (contract
   alignment): the test now pins the new fallback contract — 200,
   provider duckduckgo-free, DuckDuckGo lite endpoint called, results
   parsed from lite HTML.

3. codex catalog token limits (4 named reds + 2 sibling sweeps) —
   #11179 raised GPT_5_6_CODEX_CAPABILITIES from the 272K pricing tier
   to the real usable 872K window (live evidence: 390K served past
   272K with HTTP 200) and updated codex-gpt56-catalog.test.ts but
   missed the sibling pins. Stale tests aligned: models-catalog-combo-
   metadata (max_input_tokens now clamps to min(872000, 500000 override)
   = 500000), vscode-token-routes x3 (872000), and two more found in the
   sibling sweep: vscode-token-routes-gpt56 and provider-models-route-
   codex (conservative merge semantics unchanged: pinned 872000 < live
   999999 still wins).

4. CLI catalog counts (3 reds) — #11166 added prime-agent (agent
   category) without the cardinality pins: EXPECTED_AGENT_COUNT 8->9,
   total 34->35, D15 agent list + prime-agent, cli-tools-schema id list.
   Also added the missing English/Vietnamese cliTools descriptions for
   prime-agent (cli-catalog-display-contract) and corrected the stale
   CLI-TOOLS.md agent count (8->9).

5. setup-qwen container guard — since #10057 the container guard exits 2
   on ephemeral runtimes; the two tests exercising the merge/write path
   were environment-sensitive (red on container devboxes). Fix: pass
   allowContainerWrite so the tests are hermetic everywhere; the guard
   keeps its own dedicated coverage.

6. i18n health verdict namespace (real bug, fixed in messages) — #11224
   added the verdict/diagnostics strings to the `sidebar` namespace but
   health/page.tsx reads them via useTranslations("health"), so the page
   rendered raw keys in every locale and the "direct translation calls
   have English messages" gate went red. Fix: keys moved sidebar->health
   in en.json + vi.json (the only locales that had them), plus
   health.healthSubtitle added. The sidebar never referenced them
   (verified: no usage), and sidebar.healthSubtitle (its real sidebar
   key) is untouched.

7. i18n pt-BR drift (22 keys) — the 08-23 wave (#11224/#11228/#11215/
   #11204/#11195) added English keys never translated: common.batch*,
   endpoint.*, cliCommon.concept.acp.warning, resilienceConnections.*,
   plus the moved health.* keys and the prime-agent cliTools
   description. Fix: pt-BR translations added — 0 missing keys vs en;
   vi strict parity re-verified (0 missing, 0 extra).

Validation: every touched test file RED->GREEN individually
(node --import tsx/esm --test), typecheck:core clean, docs-counts-sync
soft-pass, cli-i18n gate PASS, 8/8 unit shards re-run on the branch.

Refs #9985

2026-08-23 14:45:05 -03:00

architecture

feat(codex): self-contained codex app-server transport (executor + provider + sign-in) (#11205 )

2026-08-23 10:20:06 -03:00

assets

fix(build): exec native esbuild binary directly in prepublish (dast-smoke base-red) (#9558 )

2026-08-06 02:19:57 -03:00

changelog/fragments

fix(catalog): declare GLM reasoning effort tiers (#10963 )

2026-08-22 22:54:49 -03:00

comparison

feat(providers): integrate audited free-tier gateways (#9210 )

2026-08-12 16:19:25 -03:00

compression

fix(deps): upgrade @atjsh/llmlingua-2 to 2.0.5 and drop @tensorflow/tfjs (#10610 )

2026-08-20 22:02:14 -03:00

diagrams

feat(codex): self-contained codex app-server transport (executor + provider + sign-in) (#11205 )

2026-08-23 10:20:06 -03:00

frameworks

feat(search): first-class X Search via SuperGrok x_search (#10988 )

2026-08-21 14:16:42 -03:00

getting-started

feat(providers): add Logfare as a free OpenAI-compatible provider (#10644 ) (#10987 )

2026-08-22 23:01:04 -03:00

guides

feat(codex): self-contained codex app-server transport (executor + provider + sign-in) (#11205 )

2026-08-23 10:20:06 -03:00

i18n

feat(codex): self-contained codex app-server transport (executor + provider + sign-in) (#11205 )

2026-08-23 10:20:06 -03:00

ops

feat(redis): add configurable key namespace prefix (#11042 )

2026-08-22 18:56:45 -03:00

providers

feat(providers): Cursor PKCE login with Bearer quota, auto router, and empty-turn errors (#9909 )

2026-08-21 10:28:01 -03:00

reference

fix(tests): drain base-red cluster from 2026-08-23 merges (#9985 )

2026-08-23 14:45:05 -03:00

routing

feat(sse): add STRICT_ZERO_COST opt-in free-access policy (#10965 )

2026-08-21 14:59:11 -03:00

screenshots

feat(providers): integrate audited free-tier gateways (#9210 )

2026-08-12 16:19:25 -03:00

security

fix(cli): restore packaged machine-token authentication (#10468 )

2026-08-20 15:07:19 -03:00

DEVELOPER-ENVIRONMENT.md

Sanitize test fixtures, add developer .env guidance, and add gitleaks… (#10411 )

2026-08-17 08:23:10 -03:00

DEVIN_CLAUDE_BRIDGE.md

feat(executors): add isolated Claude Code bridge over Devin ACP (#8914 )

2026-08-06 11:08:37 -03:00

meta.json

Release v3.8.40

2026-06-29 08:40:06 -03:00

OMNIROUTE_ALLOCATION_HANDOFF.md

feat(api): add provider quota telemetry, adaptive routing, and status inventory (#10148 )

2026-08-18 11:31:53 -03:00

OMNIROUTE_PROVIDER_FAILOVER.md

feat(api): add provider quota telemetry, adaptive routing, and status inventory (#10148 )

2026-08-18 11:31:53 -03:00

OMNIROUTE_QUOTA_TELEMETRY.md

feat(api): add provider quota telemetry, adaptive routing, and status inventory (#10148 )

2026-08-18 11:31:53 -03:00

OMNIROUTE_ROUTING_POLICY.md

feat(api): add provider quota telemetry, adaptive routing, and status inventory (#10148 )

2026-08-18 11:31:53 -03:00

openapi.yaml

fix(api): refuse creating a routing combo without any model (#11162 )

2026-08-22 21:51:19 -03:00

README.md

docs: document runtime RAM for coding-agent /v1/responses (#10983 )

2026-08-21 14:17:25 -03:00

README.md

title, version, lastUpdated

title	version	lastUpdated
OmniRoute Documentation	3.8.40	2026-06-28

OmniRoute Documentation

Navigable index of the OmniRoute documentation set. Topics are grouped by intent so you can find what you need quickly.

Looking for the project overview, install steps, or release notes? See the root README.md, ROADMAP.md, CHANGELOG.md, and CONTRIBUTING.md.

For Non-Tech Users

Simple guides for using OmniRoute — no technical background needed.

getting-started/

QUICK-START.md — install and run OmniRoute in 3 minutes.
AUTO-COMBO-GUIDE.md — let OmniRoute pick the best AI for you.
PROVIDERS-GUIDE.md — how to connect AI providers.
FREE-TIERS-GUIDE.md — get free AI with no credit card.
WEB-COOKIE-GUIDE.md — web cookie providers (session-credential setup).

guides/

SETUP_GUIDE.md — first-time setup of OmniRoute.
USER_GUIDE.md — daily usage of the dashboard and API.
THINKING_BUDGET.md — thinking/reasoning budget modes (passthrough vs auto-strip).
FEATURES.md — dashboard feature gallery.
TIERS.md — OmniRoute tiers explained (user guide).
USAGE_QUOTA_GUIDE.md — usage, quota & spend tracking.
COST_TRACKING.md — cost and spend tracking.
FREE_PROVIDER_RANKINGS.md — free provider rankings (Arena ELO).
DOCKER_GUIDE.md — running OmniRoute under Docker, including runtime RAM for coding agents.
ELECTRON_GUIDE.md — desktop (Electron) builds.
TERMUX_GUIDE.md — running on Android via Termux.
PWA_GUIDE.md — installing the dashboard as a PWA.
REMOTE-MODE.md — exposing OmniRoute remotely + scoped tokens.
CLI-INTEGRATIONS.md — master table of setup-* CLI integrations.
CLAUDE-CODE-CONFIGURATION.md — Claude Code CLI with OmniRoute.
CODEX-CLI-CONFIGURATION.md — Codex CLI with OmniRoute.
KIRO_SETUP.md — Kiro setup.
ANTIGRAVITY-ONBOARDING.md — Antigravity (Google One AI) onboarding.
MANAGEMENT-AUTH.md — management authentication.
I18N.md — translation and locale workflow.
TROUBLESHOOTING.md — detailed troubleshooting reference.
UNINSTALL.md — clean removal steps.

For Tech Users

Technical documentation for developers and contributors.

architecture/

How the system is put together — read these to understand the runtime, code layout, and resilience model.

ARCHITECTURE.md — high-level system architecture (request pipeline, layers, modules).
CODEBASE_DOCUMENTATION.md — engineering reference for the codebase.
REPOSITORY_MAP.md — directory-by-directory navigation guide.
AUTHZ_GUIDE.md — authorization pipeline (route classifier + policy engine).
RESILIENCE_GUIDE.md — provider circuit breaker, connection cooldown, and model lockout.
QUALITY_GATES.md — quality-gate scripts and CI jobs inventory.
MONITORING_SECTIONS.md — monitoring/costs dashboard navigation.
cluster-decisions.md — optional sidecar/cluster profile decisions.
DESIGN_SYSTEM.md — design system & visual identity.
ROUTER_BACKENDS.md — router backends & embedded services architecture contract (ADR).
admission-lanes.md — the two admission-lane systems and what gates each.
persistence-backend-boundary.md — pluggable persistence boundary (ADR).

reference/

Lookup material — API surface, environment variables, CLI flags, provider catalog.

API_REFERENCE.md — REST API endpoints and shapes.
PROVIDER_REFERENCE.md — auto-generated provider catalog (do not edit by hand).
PROVIDER_PLUGIN_MANIFEST.md — sidecar-safe provider plugin contract for Bifrost and CLIProxyAPI migration.
openapi.yaml — OpenAPI spec for the public API.
ENVIRONMENT.md — environment variables reference.
FEATURE_FLAGS.md — feature flags and their defaults.
CLI-TOOLS.md — bundled CLI commands.
FREE_TIERS.md — free-tier LLM provider directory.
FREE_PROXIES_API.md — free proxies API.
RELAY_BACKEND_STRATEGY.md — relay backend strategy.
RELAY_TROUBLESHOOTING.md — relay troubleshooting.

frameworks/

Pluggable subsystems exposed to clients, agents, and operators.

MCP-SERVER.md — Model Context Protocol server.
A2A-SERVER.md — Agent-to-Agent (A2A) JSON-RPC server.
ACP.md — Agent Client Protocol.
AGENT_PROTOCOLS_GUIDE.md — A2A / ACP / Cloud agent overview.
AGENTBRIDGE.md — IDE agent bridge.
AGENT-SKILLS.md — agent skills catalog.
CLOUD_AGENT.md — cloud agent runtime and providers.
SKILLS.md — Skills framework (sandboxed extension).
MEMORY.md — persistent memory (FTS5 + Qdrant).
WEBHOOKS.md — webhook events and dispatch.
EVALS.md — eval suites.
GAMIFICATION.md — gamification & leaderboard system.
EMBEDDED-SERVICES.md — embedded sidecar services (9Router, CLIProxyAPI).
NOTION_CONTEXT.md — Notion context source.
OBSIDIAN_CONTEXT.md — Obsidian context source.
LOCAL_CORPUS_CONTEXT.md — local corpus context source (approved directory exposed to MCP).
OPENCODE.md — OpenCode integration.
OPEN_SSE_ARCHITECTURE.md — open-sse streaming engine internals.
PLAYGROUND_STUDIO.md — Playground Studio UI.
SEARCH_TOOLS_STUDIO.md — Search Tools Studio UI.
TRAFFIC_INSPECTOR.md — traffic inspector (MITM).
PLUGINS.md — CLI plugin system overview.
PLUGIN_SDK.md — plugin SDK reference.
PLUGIN_MARKETPLACE.md — plugin marketplace.
RADAR.md — Radar free-model catalog overlay (optional, off by default).

routing/

Combo routing, scoring, and replay.

AUTO-COMBO.md — Auto-Combo (multi-factor scoring, 19 strategies).
QUOTA_SHARE.md — quota sharing engine.
REASONING_REPLAY.md — reasoning replay cache.
REASONING_ROUTING.md — reasoning routing rules (effort/budget rule engine).

security/

Guardrails, compliance, stealth, and the mandatory patterns for handling public credentials and error messages.

GUARDRAILS.md — PII, prompt injection, vision guardrails.
COMPLIANCE.md — audit trails and compliance.
STEALTH_GUIDE.md — TLS / fingerprint stealth.
PUBLIC_CREDS.md — mandatory pattern for embedding public upstream OAuth client_id/secret + Firebase Web keys without tripping secret scanners.
ERROR_SANITIZATION.md — mandatory pattern for routing every error response through sanitizeErrorMessage to prevent stack-trace exposure.
ROUTE_GUARD_TIERS.md — route-guard classification tiers.
CLI_TOKEN.md — CLI machine-ID token (HMAC + legacy SHA-256) auth.
EGRESS_POLICY.md — egress IP family (IPv4/IPv6) policy.
BAN_DETECTION.md — account-ban / banned-keyword detection.
AGENTROUTER_WAF.md — agentrouter.org WAF.
CORS.md — CORS configuration & security.
MITM-TPROXY-DECRYPT.md — transparent MITM decrypt.
SUPPLY_CHAIN.md — supply-chain gates (SLSA, SBOM, Trivy, osv-scanner, Scorecard).
SOCKET_DEV_FINDINGS.md — supply-chain finding attestations.

compression/

Prompt compression engines, rules, and language packs.

COMPRESSION_GUIDE.md — top-level compression overview.
COMPRESSION_ENGINES.md — available compression engines.
COMPRESSION_RULES_FORMAT.md — rule file format.
COMPRESSION_LANGUAGE_PACKS.md — language packs.
RTK_COMPRESSION.md — RTK engine deep dive.
CONTEXT_EDITING.md — delegated context editing (Anthropic).
EXTENDING_COMPRESSION.md — adding a custom compression engine.

providers/

Provider-specific integration guides.

CLAUDE_WEB.md — Claude Web (cookie-auth) provider.
CHATGPT_WEB.md — ChatGPT Web (Plus/Pro + Codex) providers.
ALIBABA-QWEN-PROVIDER-FAMILIES.md — Alibaba and Qwen provider families.
AGENTROUTER.md — AgentRouter setup.
ZED-DOCKER.md — Zed IDE integration under Docker.
CURSOR-DOCKER.md — Cursor model listing under Docker.

comparison/

OMNIROUTE_VS_ALTERNATIVES.md — how OmniRoute compares to alternatives.

ops/

Release, deployment, proxies, tunnels, coverage, database, monitoring.

RELEASE_CHECKLIST.md — release flow checklist.
RELEASE_GREEN.md — keeping the PR queue and release branch green.
BRANCHING_MODEL.md — branching & release model.
MERGE_TRAIN.md — merge queue & manual merge-train runbook.
HOMOLOGATION.md — homologation suite (npm run homolog).
QUALITY_GATE_PLAYBOOK.md — quality-gate playbook.
RUNNER_BOX.md — self-hosted runner box operations.
BRANCH_PROTECTION_MAIN.md — main branch protection.
CONTRIBUTION_GOLDEN_PATH.md — contribution golden path (focused checks per change type).
COVERAGE_PLAN.md — test coverage plan.
DATABASE_GUIDE.md — DB schema and operations.
SQLITE_RUNTIME.md — SQLite driver resolution chain.
REDIS_PRODUCTION_CONFIG.md — Redis production configuration.
MONITORING_GUIDE.md — monitoring & observability.
FLY_IO_DEPLOYMENT_GUIDE.md — Fly.io deployment.
VM_DEPLOYMENT_GUIDE.md — generic VM deployment.
PROXY_GUIDE.md — upstream proxy configuration.
TUNNELS_GUIDE.md — Cloudflare tunnel and friends.

diagrams/

Mermaid sources and exported SVG/PNG diagrams referenced from the docs above. See diagrams/README.md.

i18n/

Translated mirrors of the documentation in 43 locales. See i18n/README.md for the supported language list.

screenshots/

Static screenshots used by the dashboard and the README. Not part of the doc body.

Auto-generated artifacts

reference/PROVIDER_REFERENCE.md is generated by scripts/docs/gen-provider-reference.ts from src/shared/constants/providers.ts. Do not edit by hand.
The /docs UI is backed by Fumadocs MDX source generation from the subfolders above.