vrr/OmniRoute
2
0
Fork 0
mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-10-19 05:20:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 17

docs(env): document four CLI environment variables (#16441)

Browse source 
Thanks @pacocartones — `.env.example` and `docs/reference/ENVIRONMENT.md` now document `OMNIROUTE_NO_UPDATE_NOTIFIER`, `OMNIROUTE_DOCTOR_LIVENESS_URL`, `OMNIROUTE_PROVIDER_CATALOG_PATH`, and `OMNIROUTE_PROVIDER_TEST_MODEL`.


Boarded on release/v3.8.52 at 146459b116. Focused tests: 76 passed, 0 failed. Changelog integrity passed. File-size shows only the inherited executeTargetAttempt.ts overage (1288 > frozen 1284).

⚠️ base-red inherited: #15306
This commit is contained in:
Paco Cartones 2026-10-13 13:34:13 +02:00 • committed by GitHub
parent d4a12fa44a
commit d2669ea14b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 28 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
.env.example
View file

@ -2207,6 +2207,29 @@ APP_LOG_TO_FILE=true
# CLI-only: the server-side plugin scanner is pointed by OMNIROUTE_PLUGINS_DIR (section 2).
# OMNIROUTE_PLUGIN_PATH=
# Suppress the CLI's update notification when the process exits.
# Default: unset. Any non-empty value disables the notice.
# Used by: bin/omniroute.mjs
# OMNIROUTE_NO_UPDATE_NOTIFIER=1
# Override the liveness URL probed by `omniroute doctor`.
# Default: the local dashboard's /api/health/degradation endpoint. A programmatic
# livenessUrl option takes precedence; otherwise this value is used verbatim.
# Used by: bin/cli/commands/doctor.mjs
# OMNIROUTE_DOCTOR_LIVENESS_URL=http://127.0.0.1:20128/api/health/degradation
# Override the provider catalog path used by CLI provider commands. Absolute paths
# are used as-is; relative paths resolve from the project root. A programmatic
# catalogPath option takes precedence. Default: src/shared/constants/providers/.
# Used by: bin/cli/provider-catalog.mjs
# OMNIROUTE_PROVIDER_CATALOG_PATH=src/shared/constants/providers
# Global fallback model for CLI provider connection tests. Resolution order is:
# configured connection model, provider-specific override, this value, then the
# provider's built-in test model. Default: provider-specific built-in model.
# Used by: bin/cli/provider-test.mjs
# OMNIROUTE_PROVIDER_TEST_MODEL=
# ── Prompt cache (system prompt deduplication) ──
# Used by: open-sse/services — caches identical system prompts across requests.
# PROMPT_CACHE_MAX_SIZE=50 # Max cached entries (default: 50)

6
docs/reference/ENVIRONMENT.md
View file

@ -1,7 +1,7 @@
---
title: "Environment Variables Reference"
version: 3.8.52
lastUpdated: 2026-10-05
lastUpdated: 2026-10-11
---
# Environment Variables Reference
@ -550,6 +550,10 @@ detection above).
| `OMNIROUTE_READY_TIMEOUT_MS` | `60000` | `bin/cli/utils/pid.mjs` | Maximum time (ms) the CLI waits for the server health endpoint before printing a timeout warning. Useful for slow cold starts (e.g. Windows). Also settable via `--ready-timeout`. |
| `OMNIROUTE_VERBOSE` | `0` | `bin/cli/api.mjs` | Set to `1` to print retry/backoff diagnostics to stderr during CLI commands. |
| `OMNIROUTE_PLUGIN_PATH` | _(unset)_ | `bin/cli/plugins.mjs` | Custom directory for CLI plugin discovery (`omniroute-cmd-*` packages). Defaults to `~/.omniroute/plugins/` when unset. CLI-only — it never reaches the server-side plugin scanner, which is pointed by `OMNIROUTE_PLUGINS_DIR` (section 2). |
| `OMNIROUTE_NO_UPDATE_NOTIFIER` | _(unset)_ | `bin/omniroute.mjs` | Suppress the CLI update notification at process exit when set to any non-empty value. The notice remains disabled independently in CI, quiet mode, and non-text output modes. |
| `OMNIROUTE_DOCTOR_LIVENESS_URL` | _(derived)_ | `bin/cli/commands/doctor.mjs` | Liveness URL probed by `omniroute doctor`. A programmatic `livenessUrl` option takes precedence; otherwise this value is used verbatim. Unset, the CLI derives the local dashboard's `/api/health/degradation` endpoint. |
| `OMNIROUTE_PROVIDER_CATALOG_PATH` | `src/shared/constants/providers/` | `bin/cli/provider-catalog.mjs` | Provider catalog path used by CLI provider commands. A programmatic `catalogPath` option takes precedence. Absolute paths are used as-is; relative paths resolve from the project root. Unset, the CLI uses the provider constants directory, with the legacy `providers.ts` file as fallback. |
| `OMNIROUTE_PROVIDER_TEST_MODEL` | _(provider default)_ | `bin/cli/provider-test.mjs` | Global fallback model for CLI provider connection tests. Precedence is configured connection model, provider-specific model override, this value, then the provider's built-in test model. |
---