import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
The Spice CLI is a set of commands to create and manage Spicepods and interact with the Spice runtime.
The Spice CLI can be installed by:
The spice program will be added to the PATH automatically for bash, fish, and zsh shells.
After installing the Spice CLI for the first time, verify the installation by running spice version. Expected output:
The runtime is downloaded and installed automatically upon first run of spice run.
For getting started with Spice using the Spice CLI, see the Getting Started Guide.
Use spice help for all commands and spice [command] --help for more information about a command.
A typical command-line workflow might be as follows:
Run new shell in the same folder:
Common commands are:
| Command | Description |
|---|---|
spice run | Start the Spice runtime, installing if necessary |
spice sql | Open an interactive SQL REPL connected to the running runtime |
spice chat | Open an interactive chat REPL for AI model conversations |
spice init | Initialize a new Spice app with a spicepod.yaml |
spice add | Add a Spicepod dependency to the project |
spice login | Log in to Spice.ai Cloud Platform or other data sources |
spice trace | Inspect traces for AI chat, SQL queries, and other runtime tasks |
spice version | Display CLI and runtime versions |
spice upgrade | Upgrade the Spice CLI to the latest release |
spice help | Display help for any command |
See Spice CLI command reference for the full list of available commands.
To update to latest CLI, run the upgrade command.
:::note Upgrade command is supported from CLI v0.3.1. For version < 0.3.1 users have to re-run the install script. :::
The Spice CLI is installed by default to $HOME/.spice/bin/spice and a line added to the shell config, such as .zshrc
It can be uninstalled by deleting the spice binary and removing the PATH addition from the rc file.
