Skip to main content
Version: Next

init

Initialize Spice app in the current working directory.

Usage​

spice init [app_name]
  • app_name: The name of the app. If this is not provided, Spice will prompt for the name, defaulting to the name of the current working directory.

Flags​

  • -h, --help Print this help message

Examples​

> spice init taxi-trips

Initialized taxi-trips/spicepod.yaml

Next steps:
  cd taxi-trips
  spice dataset configure   # add a dataset interactively
  spice run                 # start the runtime

Docs: https://spiceai.org/docs/

The command creates a spicepod.yaml with basic initial metadata about the app, including a yaml-language-server schema directive for editor support (VS Code, Neovim, IntelliJ). For this example, the spicepod.yaml file is initialized to the following:

# File: ./taxi-trips/spicepod.yaml

# yaml-language-server: $schema=https://raw.githubusercontent.com/spiceai/spiceai/trunk/.schema/spicepod.schema.json
version: v2
kind: Spicepod
name: taxi-trips

If no app name is provided, Spice initializes the Spicepod in the current working directory. For example:

> spice init

name: (taxi-trips)? 
Initialized spicepod.yaml

Next steps:
  spice dataset configure   # add a dataset interactively
  spice run                 # start the runtime

Docs: https://spiceai.org/docs/

After execution, the current working directory contains the file spicepod.yaml with the same configuration as the previous example:

# File: ./spicepod.yaml

# yaml-language-server: $schema=https://raw.githubusercontent.com/spiceai/spiceai/trunk/.schema/spicepod.schema.json
version: v2
kind: Spicepod
name: taxi-trips