| title | Spice.ai OSS CLI command reference |
|---|---|
| sidebar_label | Spice CLI command reference |
| description | Spice CLI command reference |
| pagination_next |
spice [command] [--help]| Command | Description |
|---|---|
| acceleration | Manage dataset acceleration features |
| add | Add Spicepod - adds a Spicepod to the project |
| catalogs | List catalogs loaded by the Spice runtime |
| chat | Chat with an LLM |
| completions | Generate shell completions for the Spice CLI |
| cloud | Manage Spice Cloud resources |
| cluster | Cluster operations for the Spice runtime |
| connect | Connect to a Spice.ai Cloud Platform app |
| dataset | Dataset operations (configure datasets) |
| datasets | Lists datasets loaded by the Spice runtime |
| feedback | Open the Spice.ai community Slack to share feedback |
| help | Help about any command |
| init | Initialize Spice app - creates a new spicepod.yaml |
| install | Install or reinstall the Spice.ai runtime |
| login | Login to Spice.ai or configure credentials for data sources |
| models | Lists models loaded by the Spice runtime |
| nsql | Text-to-SQL REPL - translate natural language to SQL |
| pods | Lists Spicepods loaded by the Spice runtime |
| query | Submit an async query or start an interactive async query REPL |
| refresh | Refresh a dataset loaded by the Spice runtime |
| run | Run Spice - starts the Spice runtime, installing if necessary |
| search | Search datasets with embeddings |
| sql | Start an interactive SQL query session against the Spice runtime |
| spiced | Spice runtime binary — direct invocation reference |
| status | Spice runtime status |
| trace | Return traces for operations that occurred in Spice |
| upgrade | Upgrades the Spice CLI and runtime to the latest release |
| validate | Validate a spicepod.yaml without starting the runtime |
| version | Spice CLI version |
| workers | Lists workers loaded by the Spice runtime |
All commands have a help flag --help or -h to print its usage documentation:
- --help | -h : Print the help message