Skip to content

docs(cli): spice version always names the runtime path, managed install included #2190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukekim merged 1 commit into from
Sep 10, 2026
Merged

docs(cli): spice version always names the runtime path, managed install included #2190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions website/docs/cli/reference/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 '<path>' (<source>).`). 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

Expand Down
21 changes: 19 additions & 2 deletions website/docs/cli/reference/version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Loading