mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-17 20:52:15 +03:00

Files

Ravi Tharuma fbc67f1338 fix(models): honor MODELS_DEV_SYNC_ENABLED=0 over dashboard settings (#10299 )

* fix(deps): bump nanoid, dompurify for 2 new Dependabot alerts (#189, #190)

Bumps: nanoid ^3.3.17 (was transitive, now overridden), dompurify ^3.4.13
(with monaco-editor scoped override). Closes Dependabot #189, #190.

Remaining #182-#188 (js-yaml + mermaid) already closed by #9651 merge —
awaiting Dependabot re-scan.

npm audit → 0 vulnerabilities.

* fix(repo): harden .gitignore to also ignore a _tasks symlink (/_tasks)

_tasks is a SEPARATE nested git repo (gitignored). The pattern _tasks/ (trailing
slash) ignores only a directory, not a SYMLINK named _tasks. A self-referential
_tasks symlink can slip in via git add -A and, once pulled, checkout materializes
it over the real _tasks repo (destroying plans/specs/hands-off). Anchored /_tasks
ignores the symlink too, preventing re-capture.

* Hide health-check excluded models from /v1/models catalog (#10026)

Mirror the request-time exclusion rule (provider_specific_data.excludedModels)
in the unified catalog builder: a model is hidden when its provider has
connections but none of them is eligible for it. Applied across the
PROVIDER_MODELS, synced, custom, alias-backed, and managed-fallback loops
so ghost models no longer appear as available.

Co-authored-by: ritheshcn25 <ritheshcn25@users.noreply.github.com>

* fix(models): memoize getModelsDevPricing (event loop / healthz) (#10055)

* fix(models): memoize getModelsDevPricing for /v1/models catalog

resolveCatalogPricing called getModelsDevPricing once per model while
building GET /v1/models. Each call re-scanned models_dev_pricing and
JSON.parsed every row (~10k SQL scans + multi-GB parse work), pegging
the event loop so even /healthz timed out (#9685, #10052).

Memoize the parsed map until saveModelsDevPricing / clearModelsDevPricing
and add a unit test for invalidation.

Signed-off-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>

* fix(db): invalidate modelsDevPricing cache on DB reset (#10055)

Copilot review fixes:
1. Register invalidateModelsDevPricingCache() with DB state reset system
   so resetDbInstance() clears the process-local memo, preventing stale
   pricing data from surviving across DB reset/restore operations.
2. Add test assertion verifying DB reset bypasses the memo (Copilot #10055).

The process-local memo at modelsDevSync.ts:204 caches getModelsDevPricing()
results until saveModelsDevPricing()/clearModelsDevPricing() to avoid
re-scanning all pricing rows on every /v1/models request. Without this hook,
backup restore and test DB resets would serve stale cached data from the
previous connection.

Tests: npm run test:unit:serial -- tests/unit/modelsDevSync-extended.test.ts

---------

Signed-off-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
Co-authored-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>

* fix(models): honor MODELS_DEV_SYNC_ENABLED=0 over dashboard settings

The file header already advertised this env var but nothing read it.
When catalog/compression pin the event loop, the dashboard (same process)
cannot turn models.dev sync off. Let 0/false/off win over sqlite so an
operator can recover with env + restart. Skip getModelsDevPricing SQL
scans while the kill switch is set.

* fix(models): restore prettier formatting after base merge

Co-authored-by: diegosouzapw <diegosouza.pw@gmail.com>

* test(models): cover env kill switch during live settings updates

Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>

---------

Signed-off-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
Co-authored-by: diegosouzapw <diegosouzapw@users.noreply.github.com>
Co-authored-by: Diego Rodrigues de Sa e Souza <diegosouza.pw@outlook.com>
Co-authored-by: diegosouzapw <diegosouza.pw@gmail.com>
Co-authored-by: ritheshcn25 <rithesh.chandran@snb.ca>
Co-authored-by: ritheshcn25 <ritheshcn25@users.noreply.github.com>
Co-authored-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: adevwithpurpose <adevwithpurpose@users.noreply.github.com>
Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>

2026-08-17 08:02:47 -03:00

architecture

Merge remote-tracking branch 'origin/release/v3.8.50' into fix/radar-oss-cumulative-integration

2026-08-14 21:00:01 -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

comparison

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

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

compression

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

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

diagrams

fix(release): clear v3.8.50 base quality reds

2026-08-17 04:58:39 -03:00

frameworks

fix(radar): reconcile cumulative release integration

2026-08-14 12:21:43 -03:00

getting-started

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

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

guides

perf(electron): verify better-sqlite3 v13 Node-API prebuilds instead of source rebuild (#10367 )

2026-08-16 02:20:53 -03:00

i18n

fix(api-manager): allow empty combo restrictions (#10066 )

2026-08-17 07:00:05 -03:00

ops

feat(proxy): non-destructive auto-disable mode for the proxy health scheduler (#10342 )

2026-08-17 08:02:16 -03:00

providers

fix(providers): refresh the translate-path golden for the bailian Token Plan endpoint (#10410 )

2026-08-14 16:52:00 -03:00

reference

fix(models): honor MODELS_DEV_SYNC_ENABLED=0 over dashboard settings (#10299 )

2026-08-17 08:02:47 -03:00

routing

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

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

screenshots

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

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

security

feat: add Video Bridge frame sampling (#10483 )

2026-08-15 14:23:29 -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

openapi.yaml

feat: add Video Bridge frame sampling (#10483 )

2026-08-15 14:23:29 -03:00

README.md

docs(settings): Thinking Budget modes + fix Auto i18n collision (#10169 )

2026-08-13 07:53:12 -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.
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.