| Command | Description |
|---|---|
| acceleration | Manage dataset acceleration features |
| add (opens in a new tab) | Add Spicepod - adds a Spicepod to the project |
| catalog | Add or configure catalog entries in spicepod.yaml |
| catalogs (opens in a new tab) | List catalogs (opens in a new tab) loaded by the Spice runtime |
| chat (opens in a new tab) | Chat with an LLM |
| completions (opens in a new tab) | Generate shell completions for the Spice CLI |
| cloud | Manage Spice Cloud resources |
| cluster | Cluster operations for the Spice runtime |
| connect (opens in a new tab) | Connect to a Spice.ai Cloud Platform app |
| dataset (opens in a new tab) | Add or configure dataset entries in spicepod.yaml |
| datasets (opens in a new tab) | Lists datasets loaded by the Spice runtime |
| embedding | Add or configure embedding entries in spicepod.yaml |
| extension | Add or configure entries under extensions: in spicepod.yaml |
| feedback (opens in a new tab) | Open the Spice.ai community Slack to share feedback |
| function | Add or configure function entries in spicepod.yaml |
| help | Help about any command |
| init (opens in a new tab) | Initialize Spice app - creates a new spicepod.yaml |
| install (opens in a new tab) | Install or reinstall the Spice.ai runtime |
| login (opens in a new tab) | Login to Spice.ai or configure credentials for data sources |
| management | Configure the management: section of spicepod.yaml |
| metadata | Add or configure key/value entries under metadata: in spicepod.yaml |
| model | Add or configure model entries in spicepod.yaml |
| models (opens in a new tab) | Lists models loaded by the Spice runtime |
| nsql (opens in a new tab) | Text-to-SQL REPL - translate natural language to SQL |
| pods (opens in a new tab) | Lists Spicepods loaded by the Spice runtime |
| query (opens in a new tab) | Submit an async query or start an interactive async query REPL |
| refresh (opens in a new tab) | Refresh a dataset loaded by the Spice runtime |
| reranker | Add or configure reranker entries in spicepod.yaml |
| run (opens in a new tab) | Run Spice - starts the Spice runtime, installing if necessary |
| runtime | Configure the runtime: section of spicepod.yaml |
| search (opens in a new tab) | Search datasets with embeddings |
| secret | Add or configure secret entries in spicepod.yaml |
| snapshots | Configure the snapshots: section of spicepod.yaml |
| sql (opens in a new tab) | Start an interactive SQL query session against the Spice runtime |
| spiced (opens in a new tab) | Spice runtime binary — direct invocation reference |
| status (opens in a new tab) | Spice runtime status |
| tool | Add or configure tool entries in spicepod.yaml |
| trace (opens in a new tab) | Return traces for operations that occurred in Spice |
| upgrade (opens in a new tab) | Upgrades the Spice CLI and runtime to the latest or specified version |
| validate (opens in a new tab) | Validate a spicepod.yaml without starting the runtime |
| version (opens in a new tab) | Spice CLI version |
| view | Add or configure view entries in spicepod.yaml |
| worker | Add or configure worker entries in spicepod.yaml |
| workers | Lists workers loaded by the Spice runtime |
catalog, dataset, embedding, function, model, reranker, secret, tool, view, and worker all edit the matching list section of spicepod.yaml and share the same two subcommands and body flags:
runtime, management, and snapshots edit singleton sections, so they expose only configure. extension edits the extensions: map (add and configure), and metadata edits the metadata: map (add, configure, and set <KEY> <VALUE>).
See spice dataset (opens in a new tab) for the shared body-flag reference. The other list editors accept the same flags, plus the type-specific ones: --sql / --sql-ref for views, --cron for workers, and --body / --body-ref for functions. Run spice <command> --help for the per-command help.
The following flags are global — they are accepted by every command:
| Flag | Description |
|---|---|
-h, --help | Print the help message. |
-v, --verbose | Increase log verbosity. -v for debug, -vv for trace. |
--machine | Machine-readable mode for LLMs and automation: prefer JSON output where supported, and always emit structured JSON errors. Alias: --programmatic. |
--api-key <key> | API key used to authenticate with the runtime or the Spice.ai Cloud Platform. Also read from the SPICE_API_KEY environment variable. |
--cloud | Target the Spice.ai Cloud Platform instead of a local runtime. Requires --api-key. |
--cloud-region <region> | Spice.ai Cloud Platform runtime endpoint region, used with --cloud. Defaults to us-east-1. |
--http-endpoint <endpoint> | HTTP endpoint of the Spice runtime to talk to. Defaults to http://127.0.0.1:8090. |
--tls-root-certificate-file <file> | Path to a PEM root certificate used to verify the runtime's TLS server certificate. |
