Spiral is currently installed from source. The repository workspace contains the spiral command-line client, the query engine crate, benchmarks, and this documentation site.

Prerequisites

• A Rust toolchain. The repository pins the expected toolchain in rust-toolchain.toml.
• The vortex/ submodule initialized.
• Network access on the first build for any dependencies that are not already cached locally.

Initialize the submodule:

git submodule update --init --recursive

Build the client:

cargo build -p spiral-cli

Verify the command

From the repository root, run:

./target/debug/spiral sql

You can also run through Cargo:

cargo run -p spiral-cli -- sql

The REPL prints:

Spiral SQL REPL. Enter .help for commands.
spiral>

Press Ctrl-D, or enter .quit, to leave the REPL.

Build the workspace

When you are working on the engine and client together, build the full workspace:

cargo build --workspace

Next step

Follow the quickstart to load data and run your first query.