Skip to content

Check Payloads

chaos.lib.args.dataclasses.CheckPayload

Bases: BasePayload

Payload for checking and listing available Ch-aOS components.

Attributes:

Name Type Description
checks Literal

The specific type of component to check (e.g., 'roles', 'aliases', 'secrets').

chobolo str | None

Optional override for the Ch-obolo file path to read from.

json bool

If True, forces the output of the check to be in JSON format.

team str | None

Optional team context string to resolve paths when checking team-specific components.

sops_file_override str | None

Optional override for the .sops.yaml configuration file path.

secrets_file_override str | None

Optional override for the secrets file path.

update_plugins bool

If True, forces a refresh of the plugin cache before performing the check.