Skip to main content
Version: Next

Spice.ai OSS CLI command reference

spice​

Usage​

spice [command] [--help]

Full Command Reference​

CommandDescription
accelerationManage dataset acceleration features
addAdd Spicepod - adds a Spicepod to the project
catalogsList catalogs loaded by the Spice runtime
chatChat with an LLM
completionsGenerate shell completions for the Spice CLI
cloudManage Spice Cloud resources
clusterCluster operations for the Spice runtime
connectEnroll this host with Spice Cloud (Cloud Connect)
datasetDataset operations (configure datasets)
datasetsLists datasets loaded by the Spice runtime
feedbackOpen the Spice.ai community Slack to share feedback
helpHelp about any command
initInitialize Spice app - creates a new spicepod.yaml
installInstall or reinstall the Spice.ai runtime
loginLogin to Spice.ai or configure credentials for data sources
modelsLists models loaded by the Spice runtime
nsqlText-to-SQL REPL - translate natural language to SQL
podsLists Spicepods loaded by the Spice runtime
querySubmit an async query or start an interactive async query REPL
refreshRefresh a dataset loaded by the Spice runtime
runRun Spice - starts the Spice runtime, installing if necessary
searchSearch datasets with embeddings
sqlStart an interactive SQL query session against the Spice runtime
spicedSpice runtime binary — direct invocation reference
statusSpice runtime status
traceReturn traces for operations that occurred in Spice
upgradeUpgrades the Spice CLI and runtime to the latest or specified version
validateValidate a spicepod.yaml without starting the runtime
versionSpice CLI version
workersLists workers loaded by the Spice runtime

Command Flags​

The following flags are global — they are accepted by every command:

FlagDescription
-h, --helpPrint the help message.
-v, --verboseIncrease log verbosity. -v for debug, -vv for trace.
--machineMachine-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.
--cloudTarget 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.