From 1f46aa7490048b41e48c0c1a1188ca28b4210583 Mon Sep 17 00:00:00 2001 From: claudespice Date: Thu, 10 Sep 2026 01:23:01 -0700 Subject: [PATCH] docs(cli): spice version always names the runtime path, managed install included The version page said the path/source line appears only 'for a runtime outside the managed install'. version.rs prints it whenever a runtime resolves, with no test on the source, so a reader on an ordinary managed install is told they will not see a line they do see. The conditional does exist, but it belongs to 'spice run': report_resolved_runtime logs at info for a non-managed runtime and at debug for the managed one. Splits the two commands' behavior apart, lists the four source strings, and says when the line is genuinely absent. --- website/docs/cli/reference/run.md | 9 +++++++-- website/docs/cli/reference/version.md | 21 +++++++++++++++++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/website/docs/cli/reference/run.md b/website/docs/cli/reference/run.md index ac05d254e..f18356ae3 100644 --- a/website/docs/cli/reference/run.md +++ b/website/docs/cli/reference/run.md @@ -19,8 +19,13 @@ Run Spice - starts the Spice runtime, installing if necessary. 4. Under `sudo`, the invoking user's `~/.spice/bin/spiced`. `PATH` is not searched. An invalid `$SPICED_PATH` causes an error; otherwise, `spice run` installs -the runtime if none is found. For a runtime outside the managed install, the CLI reports -its path and source. [`spice version`](./version) also reports these values. +the runtime if none is found. + +Before launching, `spice run` logs the runtime it resolved and the rung it came from +(`Using the Spice.ai runtime at '' ().`). It is logged at `info` only when the +runtime is *not* the one [`spice install`](./install) manages — the case worth noticing — and at +`debug` otherwise, so an ordinary managed install does not add a line to every run. +[`spice version`](./version) reports the same path and source unconditionally. ### Usage diff --git a/website/docs/cli/reference/version.md b/website/docs/cli/reference/version.md index 80f89c760..b8aefcbbe 100644 --- a/website/docs/cli/reference/version.md +++ b/website/docs/cli/reference/version.md @@ -43,7 +43,19 @@ CLI version: v1.1.0 Runtime version: v1.1.0+models ``` -For a runtime outside the managed install, the output also includes its path and source: +**Runtime path and source**: whenever a runtime is found, the output names it and the +[selection rung](./run#runtime-selection) it came from — including the ordinary managed install: + +```shell +> spice version + +CLI version: v1.1.0 +Runtime version: v1.1.0+models +Runtime path: /Users/me/.spice/bin/spiced (installed by spice install) +``` + +The parenthetical is one of `pinned by SPICED_PATH`, `beside the spice CLI`, `installed by spice install`, +or `installed by spice install, by the sudo invoker`: ```shell > spice version @@ -53,4 +65,9 @@ Runtime version: v1.1.0+models Runtime path: /usr/local/bin/spiced (beside the spice CLI) ``` -JSON output includes `runtime_path` and `runtime_source`, following the same [runtime selection rules](./run#runtime-selection). +The line is omitted only when no runtime resolves (`Runtime version: not installed`) or with +`--cli-only`, which skips the runtime lookup entirely. A runtime that was found but could not be +asked for its version reports `Runtime version: unavailable — the runtime at the path below did not +report a version` and still names the path. + +JSON output includes `runtime_path` and `runtime_source`, following the same [runtime selection rules](./run#runtime-selection). `runtime_source` carries the enum value rather than the prose above, and both are `null` when no runtime resolves.