CLI reference: sparkwing debug

CLI reference: sparkwing debug

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

sparkwing debugSection anchor link

Interactive debugging for pipeline runs

SubcommandsSection anchor link

  • attach -- Attach to a running Kubernetes target (Cloud jobs unsupported)
  • env -- Inspect public job, executor and pause diagnostics
  • resume -- Resume a paused job

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 debug attachSection anchor link

Attach to a running Kubernetes target (Cloud jobs unsupported)

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.
--run IDRun ID or per-team run number. (required)
--job JOBJob within the selected run. (required)
--namespace NAMEKubernetes namespace to pass to kubectl exec, overriding the namespace recorded for the job's pod.
--profile NAMEController connection profile from your config. Optional profiles use the saved default, then local; --profile= selects local.

sparkwing debug envSection anchor link

Inspect public job, executor and pause diagnostics

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.
--run IDRun ID or per-team run number. (required)
--job JOBJob within the selected run. (required)
--profile NAMEController connection profile from your config. Optional profiles use the saved default, then local; --profile= selects local.

sparkwing debug resumeSection anchor link

Resume a paused job

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.
--run IDRun ID or per-team run number. (required)
--job JOBJob within the selected run. (required)
--profile NAMEController connection profile from your config. Optional profiles use the saved default, then local; --profile= selects local.