docs(cli): spice add also takes a local path and an @version pin
The `spice add` reference described its argument as a spicerack.org slug
only. Since the Rust CLI rewrite (spiceai/spiceai#9061, first released in
v2.0.0) the argument is routed by `registry::is_local_path`: a path
starting with `/`, `../`, or `file://`, or one that already exists on
disk, is copied from the local filesystem; everything else goes to
spicerack.org, where a trailing `@<version>` pins the published version.
2 months ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago
docs: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
docs(cli): document spice dataset add and the manifest body flags
The `spice dataset` reference listed only the interactive `configure`
subcommand and `-h/--help`. Since spiceai/spiceai#10815 (shipped in
v2.0.0) `spice dataset` also has an `add` subcommand, and `configure`
accepts the shared manifest body flags (--from, --ref, --description,
--param, --env, --set, --depends-on, --enable/--disable, --file/--stdin,
--manifest) — falling back to interactive prompts only when given no
name and no body flags.
2 months ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
docs(cli): list the 14 missing Spicepod manifest-editing commands
The CLI command reference table omitted every command added by
spiceai/spiceai#10815 (shipped in v2.0.0): catalog, model, view,
embedding, reranker, tool, worker, function, secret, runtime,
management, snapshots, extension, and metadata.
Adds each with its clap `about` string, corrects the `dataset` row to
match, and adds a short section describing the shared add/configure
shape and which sections are singleton-only.
2 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
docs: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago
docs: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
docs: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago
Add versioned docs for v2.1 (#1903)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 months ago
docs(cli): complete the deferred versioned pass for the CLI reference (2.0.x, 2.1.x) (#2015)
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.
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
2 months ago