CLI reference: sparkwing info
CLI reference: sparkwing info
Every sparkwing info command, flag, and argument, generated from the CLI's own command registry. All command groups are indexed in cli-reference.md.
sparkwing info
Describe Sparkwing and the selected project
Reports the CLI version, whether the current directory is inside a sparkwing project (and how many pipelines it has), whether the Go toolchain is on PATH, a curated list of next-step commands, and the docs URL. When a project declares a git hook that is not firing, repairing it is the first next step.
If the pipeline catalog cannot be read, JSON reports project.pipelines_error. Pipeline counts are unavailable when that field is present.
Use -o json for structured output that an agent can parse, or -o plain to emit one next-step command per line for shell pipelines (head -n1 yields the most-likely next command).
Flags
| Flag | Description |
|---|---|
-o, --output FORMAT | Output format: pretty | json | plain (default: pretty on TTY, json when piped) |
--for-agent | Emit current discovery context for one agent wake (no ANSI, no extras) |
--first-time | Print the post-install onboarding card (used by install.sh; re-runnable any time) |
-C, --sw-cd DIR | Operate as if started in this directory (re-anchors the .sparkwing search) |
Examples
# Human-readable card
sparkwing info
# Agent-readable record
sparkwing info -o json
# Load current agent discovery
sparkwing info --for-agent
# Reprint the post-install onboarding card
sparkwing info --first-time