Spice.ai OSS CLI documentation
The Spice CLI is a set of commands to create and manage Spicepods and interact with the Spice runtime.
Install​
The Spice CLI can be installed by:
- macOS, Linux, and WSL
- Windows
- Running
curl https://install.spiceai.org | /bin/bash - Using
brew:brew install spiceai/spiceai/spice - Downloading the binary from GitHub Releases
- Shell command
curl -L "https://install.spiceai.org/Install.ps1" -o Install.ps1 && PowerShell -ExecutionPolicy Bypass -File ./Install.ps1 - Downloading the binary from GitHub Releases
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, ensure you've got the correct version by running spice version. The Runtime version is not expected to be shown, as the runtime will be downloaded and installed automatically upon first run.
Getting started​
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:
# Start the runtime
spice run
Run new shell in the same folder:
# Init new app
spice init spice_app
# Add the Quickstart Spicepod
spice add spiceai/quickstart
Common commands are:
| Command | Description |
|---|---|
| spice add | Add Pod - adds a pod to the project |
| spice run | Run Spice - starts the Spice runtime, installing if necessary |
| spice version | Spice CLI version |
| spice help | Help about any command |
| spice upgrade | Upgrades the Spice CLI to the latest release |
See Spice CLI command reference for the full list of available commands.
Updating​
To update to latest CLI, run the upgrade command.
spice upgrade
Upgrade command is supported from CLI v0.3.1. For version < 0.3.1 users have to re-run the install script.
Uninstall​
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.