mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-07-31 12:22:14 +03:00

Files

Diego Rodrigues de Sa e Souza 624aba2498 feat(cli): add Grok Build CLI tool setup (~/.grok/config.toml) (#7241 )

* feat(cli): add Grok Build CLI tool setup (~/.grok/config.toml)

Registers xAI's Grok Build TUI coding agent as a configurable CLI tool in
/dashboard/cli-code, so OmniRoute can write itself in as a custom model
provider in ~/.grok/config.toml.

Mechanism: Grok Build reads a TOML config that can hold several user-defined
[model.*] sections plus a [models].default pointer. Unlike the sibling Forge
handler (which owns its whole config file and can full-replace it), this one
surgically upserts ONLY the [model.omniroute] section and rewrites
[models].default, leaving every other section byte-intact. Apply records the
previous default in an `# omniroute-prev-default` marker comment so Reset can
restore the user's original default instead of guessing.

Built on OmniRoute's existing CLI-tools infrastructure rather than replaying
the upstream shape: getCliRuntimeStatus() for detection (no ad-hoc
`which grok` exec), Zod validation via cliModelConfigSchema, the write guard,
createBackup(), the cliToolState DB module, and sanitizeErrorMessage() for
every error path (Hard Rule #12).

Security: GET reaches getCliRuntimeStatus(), which spawns a child process to
locate and healthcheck the `grok` binary. That is the same transitive-spawn
surface that classified /api/skills/collect/, so the route is registered in
LOCAL_ONLY_API_PREFIXES and loopback-enforced before any auth check
(Hard Rules #15 + #17). Writing a local CLI's config file is inherently a
local-machine operation, so this costs no real capability.

Co-authored-by: rixzkiye <rizkiyemubarok05@gmail.com>
Inspired-by: https://github.com/decolua/9router/pull/2571

* chore(changelog): fragment for #7241

* fix(cli): shrink cliTools.ts/cliRuntime.ts under the file-size ratchet + fix stale catalog counts

The grok-build registry/runtime entries pushed cliTools.ts (916->932) and
cliRuntime.ts (1128->1137) past their frozen file-size caps. Extract the
grok-build entries into cliToolsGrokBuild.ts (registry, typed) and
cliRuntimeGrokBuild.ts (runtime metadata, deliberately untyped/no
cliCatalog import so it doesn't drag that schema file into the
typecheck:core curated allowlist's transitive graph). The amp runtime
entry rides along in the same runtime file for the extra headroom needed
to clear cliRuntime.ts's cap with zero slack.

Also update the two catalog-cardinality canaries (cli-tools-schema.test.ts,
cli-catalog-counts.test.ts) and EXPECTED_CODE_COUNT to include grok-build:
20->21 visible code entries, 24->25 total code entries, 32->33 grand total.

Fixes CI reds on #7241 surviving a release/v3.8.49 merge: Fast Quality
Gates (check:file-size) and Unit Tests fast-path (1/4, 2/4).

* test(stryker): register grok-build route-guard test in tap.testFiles

check:mutation-test-coverage --strict flagged
tests/unit/route-guard-grok-build-settings-local-only.test.ts as a covering
unit test for src/server/authz/routeGuard.ts missing from
stryker.conf.json's tap.testFiles allowlist (only became reachable once the
Fast Quality Gates job got past the file-size fix earlier in this branch).

---------

Co-authored-by: rixzkiye <rizkiyemubarok05@gmail.com>

2026-07-17 10:40:41 -03:00

architecture

fix: add dashboard-scoped typecheck gate covering src/app/(dashboard) TSX (#7033 ) (#7203 )

2026-07-14 23:24:14 -03:00

comparison

Release v3.8.44 (#5925 )

2026-07-04 13:00:30 -03:00

compression

feat(dashboard): add compression-mode selector to Context & Cache combos page (#6760 ) (#7219 )

2026-07-17 10:40:05 -03:00

diagrams

Release v3.8.45 (#6202 )

2026-07-06 02:25:17 -03:00

frameworks

feat: add TinyFish Fetch support to web-fetch provider and update related documentation (#6349 )

2026-07-06 21:32:15 -03:00

getting-started

Release v3.8.42 (#5459 )

2026-06-30 06:54:29 -03:00

guides

Release v3.8.47 (#6569 )

2026-07-13 09:12:40 -03:00

i18n

fix: stop opencode-go quota lookup defaulting to Z.AI endpoint (#7022 ) (#7187 )

2026-07-14 21:45:23 -03:00

ops

feat(homolog): real-environment E2E homologation suite (npm run homolog) (#7133 )

2026-07-14 16:24:11 -03:00

providers

Release v3.8.47 (#6569 )

2026-07-13 09:12:40 -03:00

reference

feat(cli): add Grok Build CLI tool setup (~/.grok/config.toml) (#7241 )

2026-07-17 10:40:41 -03:00

routing

feat(sse): preserve tools/tool_choice for tool-bearing requests through fusion combos (#6771 ) (#7235 )

2026-07-17 10:40:33 -03:00

screenshots

Release v3.8.28 (#4053 )

2026-06-17 19:26:32 -03:00

security

feat(api): add Vary: Accept-Encoding to token-authenticated /v1* responses (#6737 ) (#7217 )

2026-07-17 10:39:58 -03:00

combo-context-requirements.md

Release v3.8.47 (#6569 )

2026-07-13 09:12:40 -03:00

meta.json

Release v3.8.40

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

openapi.yaml

chore(release): bump v3.8.49 (development cycle version)

2026-07-13 18:57:22 -03:00

README.md

Release v3.8.47 (#6569 )

2026-07-13 09:12:40 -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, 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.
TROUBLESHOOTING.md — fix common issues.

guides/

SETUP_GUIDE.md — first-time setup of OmniRoute.
USER_GUIDE.md — daily usage of the dashboard and API.
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.
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.

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.

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.
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.

routing/

Combo routing, scoring, and replay.

AUTO-COMBO.md — Auto-Combo (multi-factor scoring, 17 strategies).
QUOTA_SHARE.md — quota sharing engine.
REASONING_REPLAY.md — reasoning replay cache.

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.
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.
AGENTROUTER.md — AgentRouter setup.
ZED-DOCKER.md — Zed IDE integration 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.
QUALITY_GATE_PLAYBOOK.md — quality-gate playbook.
BRANCH_PROTECTION_MAIN.md — main branch protection.
COVERAGE_PLAN.md — test coverage plan.
DATABASE_GUIDE.md — DB schema and operations.
SQLITE_RUNTIME.md — SQLite driver resolution chain.
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.