OS Manuals

/usr/bin/chainctl

Chainguard CLI

From chainctl 0.2.399-r0 (extra-packages), captured 2026-11-10 by running chainctl --help (exit 0). permalink

Also provided by 1 other package version
  Chainguard Control (chainctl) manages Chainguard resources from the command
  line.

  Exit codes:

  • 0: the command succeeded, or a confirmation prompt was declined and
  nothing was changed.
  • 1: the command failed. This covers every error, including invalid
  arguments and flags, and commands that act as a gate: a check that failed, a
  policy that denied, a --check or --exit-code gate that matched, or "chainctl
  images repos build apply --dry-run" finding changes to apply.
  • 2: "chainctl checks status" only. The platform created no Run for the
  commit or pull request, so there is no verdict.
  • 3-8: "chainctl starter init" only. Each names a way the signup ended;
  "chainctl starter init --help" lists them.
  • 130: the command was interrupted with SIGINT (Ctrl-C) and did not finish.
  A command that unwinds after the first Ctrl-C may exit 1, or 0 if it treats
  the cancellation as a clean stop; "chainctl starter init" exits 7 once it
  has created the organization. A second Ctrl-C forces 130.
  • 143: the command was terminated with SIGTERM.

  "chainctl develop" and "chainctl develop attach" exit with the session
  shell's exit code when the shell exits. "chainctl develop exec" exits with
  the command's exit code, 124 when --timeout killed it, and 255 when the
  command's outcome is unknown. "chainctl develop check" exits 0 when the
  checks pass and 1 when a step fails.

  The number in brackets in some error messages, such as "[4] ...", is
  chainctl's internal error code, also shown as "code" with --output json. It
  is not the process exit code.

Usage: chainctl [flags]
  chainctl [command]

Available Commands:
  actions      Interact with the Chainguard Actions product.
  agent        Agent-powered commands.
  auth         Auth related commands for the Chainguard platform.
  checks       Inspect and manage a repository's Checks on the Chainguard sandbox plane.
  completion   Generate the autocompletion script for the specified shell
  config       Local config file commands for chainctl.
  develop      Open or resume a cloud development session.
  events       Events related commands for the Chainguard platform.
  guardener    Manage guardener integrations.
  iam          IAM related commands for the Chainguard platform.
  images       Images related commands for the Chainguard platform.
  libraries    Ecosystem library related commands.
  packages     Interact with Chainguard packages
  plans        Show your organization's plan, limits, and usage.
  policy       Manage policies.
  skills       Skills registry related commands.
  starter      Manage Chainguard Starter organizations
  update       Update chainctl.
  version      Prints the version

Flags:
  --version:
      version for chainctl


Global Flags:
  --api:
      The url of the Chainguard platform API., for example:
      https://console-api.enforce.dev

  --audience:
      The Chainguard token audience to request., for example:
      https://console-api.enforce.dev

  --config:
      A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable
      if a file is not passed explicitly.

  --console:
      The url of the Chainguard platform Console., for example:
      https://console.chainguard.dev

  --force-color:
      Force color output even when stdout is not a TTY.

  -h, --help:
      Help for chainctl

  --issuer:
      The url of the Chainguard STS endpoint., for example:
      https://issuer.enforce.dev

  --log-level:
      Set the log level (debug, info)

  -o, --output:
      Output format. One of: [csv, env, go-template, id, json, markdown, none,
      table, terse, tree, wide]

  -v, --v:
      Set the log verbosity level.


Use "chainctl [command] --help" for more information about a command.
Options (11)
OptionDescriptionSource
--versionversion for chainctlhelp
--apiThe url of the Chainguard platform API., for example: https://console-api.enforce.devhelp
--audienceThe Chainguard token audience to request., for example: https://console-api.enforce.devhelp
--configA specific chainctl config file.help
--consoleThe url of the Chainguard platform Console., for example: https://console.chainguard.devhelp
--force-colorForce color output even when stdout is not a TTY.help
-h, --helpHelp for chainctlhelp
--issuerThe url of the Chainguard STS endpoint., for example: https://issuer.enforce.devhelp
--log-levelSet the log level (debug, info)help
-o, --outputOutput format.help
-v, --vSet the log verbosity level.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.