Installation

Recommended: One-command setup

The fastest way to get started is with uv, the fast Python package manager:

# Install uv if you don't have it
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install sparkrun and set up your cluster in one step
uvx sparkrun setup

This runs the setup wizard, which walks you through everything interactively — cluster creation, SSH mesh, CX7 networking, and more. Each phase is optional and can be revisited later.

See the Setup Wizard Walkthrough for a detailed step-by-step guide.

Alternative: Install only

If you just want to install sparkrun without running the full wizard:

uvx sparkrun setup install

This creates a managed virtual environment, installs sparkrun, creates a shell-ready command, and sets up tab completion — all in one. You can run the wizard later with sparkrun setup wizard.

Verify installation

sparkrun --version

Updating

sparkrun update

This updates sparkrun to the latest version and refreshes all recipe registries. Use --no-update-registries to skip the registry update.

Requirements

• Python 3.12+
• SSH access to one or more NVIDIA DGX Spark systems
• Docker installed on target hosts (SSH user must be in the docker group)