From d2669ea14bd5ec7ace2bccb2d8211e179dd78d11 Mon Sep 17 00:00:00 2001 From: Paco Cartones <253313177+pacocartones@users.noreply.github.com> Date: Tue, 13 Oct 2026 13:34:13 +0200 Subject: [PATCH] docs(env): document four CLI environment variables (#16441) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 146459b116df. 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 --- .env.example | 23 +++++++++++++++++++++++ docs/reference/ENVIRONMENT.md | 6 +++++- 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/.env.example b/.env.example index 7ba51c5a92..d9d9a7221b 100644 --- a/.env.example +++ b/.env.example @@ -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) diff --git a/docs/reference/ENVIRONMENT.md b/docs/reference/ENVIRONMENT.md index 2f859d3799..d1e440a305 100644 --- a/docs/reference/ENVIRONMENT.md +++ b/docs/reference/ENVIRONMENT.md @@ -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. | ---