CLI reference: sparkwing repos

CLI reference: sparkwing repos

Every sparkwing repos command, flag, and argument, generated from the CLI's own command registry. All command groups are indexed in cli-reference.md.

sparkwing reposSection anchor link

The machine's fleet of sparkwing repos and their SDK pins

SubcommandsSection anchor link

  • add -- Register a checkout
  • info -- Inspect repository versions, worktrees, and pipelines
  • list -- List the machine's fleet of sparkwing repos
  • prune -- Remove checkouts whose pipeline directory is gone
  • remove -- Remove a registered checkout
  • update -- Update repository SDK versions and compare pipeline plans

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing repos addSection anchor link

Register a checkout

--checkout is required; it must be a local path.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing repos infoSection anchor link

Inspect repository versions, worktrees, and pipelines

--checkout is required; repository identity is distinct from local checkout.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing repos listSection anchor link

List the machine's fleet of sparkwing repos

Inventory includes each checkout SDK kind (go or typescript) and its native SDK pin. TypeScript pins come from the npm lockfile when present. JSON uses sdk and pin; plain appends SDK kind after name, pin and primary path.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.
--checkoutsList each registered local checkout with its status instead of the per-repository version summary.
--pipelinesWith --checkouts, include each checkout's pipeline names, on by default and turned off with --pipelines=false; refused without --checkouts.

sparkwing repos pruneSection anchor link

Remove checkouts whose pipeline directory is gone

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing repos removeSection anchor link

Remove a registered checkout

--checkout is required; registry basename fallback is refused.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing repos updateSection anchor link

Update repository SDK versions and compare pipeline plans

Apply by default; --dry-run previews. --all-repos requires --yes for bulk changes.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.
--version TAGSDK release tag to move repositories to, latest by default.
--verifyAfter the bump, run pre-commit run --all-files and treat a failure as a broken update; refused with --in-place.
--in-placeBump the current checkout's SDK pin directly, skipping the before and after plan comparison and the commit.
--dry-runShow what would change without changing anything.
--all-reposUpdate every registered repository instead of only the current one; requires --yes unless --dry-run is given.
--yesConfirm a destructive change without prompting.