---
title: CLI Overview
description: sparkrun command-line interface reference.
---

sparkrun provides a unified CLI for managing LLM inference workloads on DGX Spark systems.

## Global options

| Option | Description |
|---|---|
| `-v` / `--verbose` | Enable verbose/debug output |
| `--version` | Show version and exit |
| `--help` | Show help for any command |

## Command groups

### Workload commands

| Command | Description |
|---|---|
| `sparkrun run <recipe>` | Launch an inference workload |
| `sparkrun stop <recipe>` | Stop a running workload |
| `sparkrun logs <recipe>` | Re-attach to workload logs |
| `sparkrun benchmark <recipe>` | Benchmark an inference recipe (auto: run → benchmark → stop) |

### Recipe commands

| Command | Description |
|---|---|
| `sparkrun list [query]` | List available recipes (alias) |
| `sparkrun show <recipe>` | Show recipe details + VRAM estimate (alias) |
| `sparkrun search <query>` | Search recipes (alias) |
| `sparkrun recipe list [query]` | List available recipes from all registries |
| `sparkrun recipe show <recipe>` | Show detailed recipe information |
| `sparkrun recipe search <query>` | Search for recipes by name, model, or description |
| `sparkrun recipe validate <recipe>` | Validate a recipe file |
| `sparkrun recipe vram <recipe>` | Estimate VRAM usage for a recipe |

:::tip
Recipes can be local names, file paths, URLs, or [Spark Arena](https://spark-arena.com) shortcuts (`@spark-arena/<recipe-id>`). For example: `sparkrun run @spark-arena/abc123` or `sparkrun show @spark-arena/abc123 --save my-recipe.yaml`.
:::

### Registry commands

| Command | Description |
|---|---|
| `sparkrun registry list` | List configured recipe registries |
| `sparkrun registry add <url>` | Add a registry from a repo manifest |
| `sparkrun registry remove <name>` | Remove a recipe registry |
| `sparkrun registry enable <name>` | Enable a recipe registry |
| `sparkrun registry disable <name>` | Disable a recipe registry |
| `sparkrun registry update [name]` | Update registries from git |
| `sparkrun registry list-benchmark-profiles` | List available benchmark profiles |
| `sparkrun registry show-benchmark-profile <name>` | Show benchmark profile details |

[Spark Arena](https://spark-arena.com) is included as a default registry. See [Registries](/recipes/registries/) for details.

### Cluster commands

| Command | Description |
|---|---|
| `sparkrun cluster create <name>` | Create a new named cluster |
| `sparkrun cluster update <name>` | Update hosts, description, or user |
| `sparkrun cluster list` | List all saved clusters |
| `sparkrun cluster show <name>` | Show details of a saved cluster |
| `sparkrun cluster delete <name>` | Delete a saved cluster |
| `sparkrun cluster set-default <name>` | Set the default cluster |
| `sparkrun cluster unset-default` | Remove the default cluster setting |
| `sparkrun cluster default` | Show the current default cluster |
| `sparkrun cluster status` | Show sparkrun containers running on cluster hosts |

### Tune commands

| Command | Description |
|---|---|
| `sparkrun tune sglang <recipe>` | Tune SGLang fused MoE Triton kernels |
| `sparkrun tune vllm <recipe>` | Tune vLLM fused MoE Triton kernels |

See [tune](/cli/tune/) for details.

### Setup commands

| Command | Description |
|---|---|
| `sparkrun setup install` | Install sparkrun as a uv tool + tab-completion + registry sync |
| `sparkrun setup completion` | Install shell tab-completion (bash/zsh/fish) |
| `sparkrun setup update` | Update sparkrun + registries (`--no-update-registries` to skip) |
| `sparkrun setup ssh` | Set up passwordless SSH mesh across hosts |
| `sparkrun setup cx7` | Detect and configure ConnectX-7 NICs across hosts |
| `sparkrun setup fix-permissions` | Fix root-owned HF cache files on cluster hosts |
| `sparkrun setup clear-cache` | Drop Linux page cache on cluster hosts to free memory |
