CLI reference: sparkwing profiles

CLI reference: sparkwing profiles

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

sparkwing profilesSection anchor link

Manage controller connection profiles

SubcommandsSection anchor link

  • add -- Add a controller connection profile
  • list -- Print every registered profile
  • remove -- Remove a controller connection profile
  • set -- Update a connection or select the default profile
  • show -- Print one controller connection profile

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 profiles addSection anchor link

Add a controller connection profile

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.
--controller URLController URL for this connection profile. (required)
--profile NAMEName for this saved connection; defaults to the controller host.
--token-stdinRead the controller credential from standard input.
--forceReplace an existing object.
--no-probeSkip checking the controller connection.

sparkwing profiles listSection anchor link

Print every registered profile

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 profiles removeSection anchor link

Remove a controller connection profile

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.
--profile NAMEController connection profile from your config. Must be supplied explicitly. (required)
--keep-tokenRemove only the local connection, without revoking its token at the controller.

sparkwing profiles setSection anchor link

Update a connection or select the default profile

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.
--profile NAMEController connection profile from your config. Must be supplied explicitly. (required)
--controller URLController URL for this connection profile.
--token-stdinRead the controller credential from standard input.
--defaultUse this profile when an optional --profile is omitted. --default=false restores local selection if this is the default.

sparkwing profiles showSection anchor link

Print one controller connection profile

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.
--profile NAMEController connection profile from your config. Must be supplied explicitly. (required)