CLI reference

CLI reference

Every sparkwing command, flag, and argument, generated from the CLI's own command registry and split into one page per top-level command group. For the conceptual overview -- which binaries exist, the flag-naming rule, and what to reach for when -- see cli.md.

Command groups

• sparkwing billing -- Inspect Cloud standing, contact operators and set automatic refill
• sparkwing cache -- Inspect or trim the compiled pipeline binary cache
• sparkwing commands -- Search the command index or export the CLI reference
• sparkwing completion -- Emit a shell completion script
• sparkwing daemon -- Inspect and manage the local controller
• sparkwing dashboard -- Manage the local dashboard
• sparkwing debug -- Interactive debugging for pipeline runs
• sparkwing docs -- Embedded user docs (offline)
• sparkwing doctor -- Inspect local controller and machine diagnostics
• sparkwing examples -- Read complete example pipelines
• sparkwing info -- Describe Sparkwing and the selected project
• sparkwing operator -- Manage deployment operations
• sparkwing overflow -- Manage your Cloud overflow allowance
• sparkwing pipeline -- This repo's pipelines
• sparkwing pools -- Manage team runner pools
• sparkwing profiles -- Manage controller connection profiles
• sparkwing queue -- Inspect queued work and scheduling priority
• sparkwing repos -- The machine's fleet of sparkwing repos and their SDK pins
• sparkwing run -- Invoke a pipeline
• sparkwing runners -- Manage runners
• sparkwing runs -- Inspect and control pipeline runs
• sparkwing schedules -- Manage scheduled pipeline runs
• sparkwing secrets -- Manage secrets in this machine's local store or on a controller
• sparkwing team -- Manage your team
• sparkwing tokens -- Manage team credentials
• sparkwing update -- Update the CLI binary
• sparkwing upgrade -- Upgrade repository SDK pins
• sparkwing version -- Inspect versions (CLI, SDK, sparks)

sparkwing

Run and inspect pipelines

Run pipelines locally with run, or submit them to a controller with pipeline trigger. Use commands --search to find commands and --help for their flags.

Flags

Examples

# Run a pipeline locally
sparkwing run build

# Inspect a pipeline
sparkwing pipeline describe --pipeline build

# Start the local dashboard
sparkwing dashboard start