Commands overview

Use --help at any level:

hawkbit --help
hawkbit targets --help
hawkbit distributions --help

Complete command reference

Command Description
hawkbit config set Create or update a local profile with URL, credentials or OIDC token, and SSL verification settings.
hawkbit config show Show profile configuration values (password is masked).
hawkbit config path Show the config file location used by the CLI.
hawkbit config use Set the active profile used when --profile is omitted.
hawkbit config current Show the active profile.
hawkbit config list List all profiles and indicate which one is active.
hawkbit targets list List targets from hawkBit Management API.
hawkbit targets get <target-id> Get details of a specific target.
hawkbit targets delete-inactive Delete stale/inactive targets by time window or inactive flag.
hawkbit target-filters list List target filters from hawkBit Management API.
hawkbit target-filters get <filter-id> Get details of a specific target filter.
hawkbit target-filters create Create a target filter with name + query.
hawkbit target-filters delete <filter-id> Delete a target filter by id.
hawkbit distributions list List distribution sets.
hawkbit distributions create Create distribution set only (--name + --version) or run full flow (--module-name + --artifact + --version).
hawkbit distributions delete <distribution-id> Delete a distribution set by id, optionally deleting associated software modules with --delete-modules.
hawkbit modules list List software modules.
hawkbit modules delete <module-id> Delete a software module by id.
hawkbit rollouts list List rollouts.
hawkbit rollouts create Create a rollout from distribution set + target filter query.
hawkbit deployment get <target-id> Show assigned distribution for a target.
hawkbit deployment history <target-id> List deployment action history for a target.
hawkbit deployment progress <target-id> <action-id> Show status/progress entries for one target action.
hawkbit deployment assign <target-id> [distribution-id] Assign an existing distribution id, or run full flow with --artifact --module-name --version and then assign it.
hawkbit deployment remove <target-id> Remove assigned distribution from a target.

Common behavior

  • Output format: --output json|table (-o table is useful in terminals)
  • Auth/context resolution order:
  • command flags
  • environment variables
  • active/default profile
  • OIDC authentication: --oidc-token or HAWKBIT_OIDC_TOKEN

See each group page for focused examples and flags.

Group pages: