docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) - #2015
Merged
Conversation
… (2.0.x, 2.1.x) docs #2011 corrected the vNext CLI reference and deliberately deferred the versioned snapshots, because '--output' arrived per command across releases. Verified command-by-command at v2.0.1 and v2.1.2: both releases expose the identical surface, so both snapshots carry the same wrong claims. Verified at v2.0.1 and v2.1.2 (bin/spice/src/**, clap derive attrs): - main.rs: the same seven 'global = true' args, --programmatic alias, SPICE_API_KEY env fallback, us-east-1 and http://127.0.0.1:8090 defaults, --cloud-region requires = "cloud" - the same ten commands declare short = 'o' output: OutputFormat - upgrade.rs: target_version positional, -f/--force, leading-v validation, 'latest or specified version' about string - version.rs --cli-only, refresh.rs refresh_jitter_max, trace.rs truncate (default_missing_value = 80) Scoped per version: the dynamic 'tool_use::<tool>' trace task name goes to 2.1.x only — at v2.0.1 only the 'tool_use::<server>/<tool>' form is emitted (tools/mcp/tool.rs), the bare form arrived with the runtime-tools MCP server. version-1.11.x and older declare a different, smaller global-flag set (5 at v1.11.6) and need their own verified pass.
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
|
🚀 deployed to https://dcc1e0c7.spiceai-org-website.pages.dev |
Collaborator
Author
|
@copilot review |
lukekim
approved these changes
Aug 1, 2026
lukekim
enabled auto-merge (squash)
August 1, 2026 20:56
Contributor
|
🚀 deployed to https://90eed427.spiceai-org-website.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs #2011 corrected the vNext CLI reference and explicitly deferred the versioned snapshots:
This is that pass, done command-by-command against the release tags. The result:
v2.0.1andv2.1.2expose the identical CLI surface — same seven global flags, same ten commands with-o/--output, sameupgrade/version/refresh/traceflags — so both snapshots carry the same wrong claims and both are fixed here.What the 2.0.x / 2.1.x docs said vs. what the released binaries do:
--helpor-h" — presented as the complete set of global flagsglobal = trueargs:-v/--verbose,--machine,--api-key,--cloud,--cloud-region,--http-endpoint,--tls-root-certificate-file. Several are already used in per-command examples on these same pages (spice chat --cloud --api-key …) without ever being defined.-o/--outputdocumented only onquery,search,logincatalogs,chat,datasets,models,pods,refresh,sql,status,trace,versionspice upgrade [flags], "to the latest release",--helpthe only flagspice upgrade [target_version] [flags], "to the latest or specified version", plus-f/--force; atarget_versionwithout the leadingvis rejectedversion,refresh,traceflag lists incompleteversion --cli-only,refresh --refresh-jitter-max,trace --truncate [<length>](defaults to80when passed bare)Verification
Read the
clapderive attributes at each tag —git show <tag>:bin/spice/src/....Global flags —
bin/spice/src/main.rs,struct Cli: sevenglobal = trueargs at bothv2.0.1andv2.1.2, with the documented details identical at both:alias = "programmatic"on--machine,env = "SPICE_API_KEY"on--api-key,requires = "cloud"on--cloud-region,DEFAULT_CLOUD_REGION = "us-east-1",default_value = "http://127.0.0.1:8090"on--http-endpoint.-o/--output— enumerated by greppingshort = 'o'acrossbin/spice/src/commands/**at each tag. Identical sets:catalogs,chat,datasets,models,pods,refresh,sql,status,trace,version(plus the already-documentedquery/mod.rs,search.rs,login/mod.rs, and the undocumentedacceleration,workers,cloud).OutputFormat { Table (default), Json }.upgrade—commands/upgrade.rsat both tags:#[arg(name = "target_version")] version: Option<String>,#[arg(short, long)] force, the!version.starts_with('v')rejection, andabout = "Upgrades the Spice CLI and runtime to the latest or specified version".Per-command flags —
version.rs#[arg(long)] cli_only;refresh.rsrefresh_jitter_max;trace.rs#[arg(long, default_missing_value = "80")] truncate: Option<usize>. All present at both tags.Scoped per version — not a flat copy
tool_use::<tool>trace task names → 2.1.x only. The vNexttrace.mdparagraph documents both the baretool_use::<tool>and thetool_use::<server>/<tool>forms. Atv2.1.2both exist (crates/runtime-tools/src/mcp/server.rs:169andmcp/tool.rs:93). Atv2.0.1onlytool_use::<server>/<tool>is emitted (crates/runtime/src/tools/mcp/tool.rs:93; that release'stools/mcp/server.rsrecords no task span at all), so 2.0.x gets the flag rows without that paragraph.version-1.11.xand older are deliberately untouched.v1.11.6declares a different, smaller set — 5global = trueargs, not 7 — so a copy of this table would be wrong there. Those snapshots need their own verified pass; noted rather than guessed.version-2.0.xwas byte-identical to the pre-changeversion-2.1.xfor all 12 pages, so the two snapshots genuinely shared one set of claims rather than being independently stale.Grep coverage
The CLI reference pages are the only place these flags are enumerated:
grep -rln 'cli-only\|refresh-jitter-max\|target_version'returns no other page type.Test plan
cd website && npm run buildpasses (onBrokenLinks/onBrokenAnchors/onInlineTagsallthrow) — 3750 documents,Generated static files in "build". The newrefresh.mdlinks (../../reference/duration,../../features/data-acceleration/data-refresh#refresh-jitter) were confirmed to resolve in both snapshots before building.version-2.1.x/cli/reference/, 12 underversion-2.0.x/cli/reference/(matches the diff)