Skip to content

Team Payloads

chaos.lib.args.dataclasses.TeamPrunePayload

Bases: BasePayload

Payload for pruning stale team configurations.

Attributes:

Name Type Description
companies list[str]

Optional list of specific company names to prune. If empty, all companies are checked.

i_know_what_im_doing bool

If True, bypasses interactive confirmation prompts.

confirmed bool

Internal state tracking whether the user has confirmed the pruning action.

chaos.lib.args.dataclasses.TeamListPayload

Bases: BasePayload

Payload for listing active team configurations.

Attributes:

Name Type Description
company str | None

Optional company name to filter the listed teams. If None, all teams from all companies are listed.

no_pretty bool

If True, disables rich CLI formatting for the output.

json bool

If True, forces the output to be in JSON format (usually combined with no_pretty).

chaos.lib.args.dataclasses.TeamClonePayload

Bases: BasePayload

Payload for cloning a team's Git repository.

Attributes:

Name Type Description
target str

The target repository URL or identifier to clone.

path str | None

Optional local path where the repository should be cloned. If None, clones to the current directory or default structure.

chaos.lib.args.dataclasses.TeamInitPayload

Bases: BasePayload

Payload for initializing a new team repository structure.

Attributes:

Name Type Description
target str

The target team identifier, usually in the format 'company.team.person'.

path str | None

Optional directory path where the team should be initialized.

i_know_what_im_doing bool

If True, bypasses interactive confirmation prompts.

confirmed bool

Internal state tracking whether the user confirmed the initialization.

init_git bool

Internal state tracking whether a new Git repository should be initialized.

overwrite_sops bool

Internal state tracking whether to overwrite an existing SOPS config.

engine str | None

The encryption engine to use (e.g., 'age', 'gpg', or 'both').

use_vault bool

Internal state tracking whether HashiCorp Vault integration should be configured.

continue_no_vault bool

Internal state tracking whether to continue if Vault is not present.

chaos.lib.args.dataclasses.TeamActivatePayload

Bases: BasePayload

Payload for activating a team configuration repository.

Attributes:

Name Type Description
path str | None

The path to the team repository that should be symlinked and activated.

chaos.lib.args.dataclasses.TeamDeactivatePayload

Bases: BasePayload

Payload for deactivating active team configurations.

Attributes:

Name Type Description
company str

The company name under which the teams reside.

teams list[str]

The specific teams to deactivate. If empty, all teams for the company are deactivated.

confirmed bool

Internal state tracking whether the deactivation action was confirmed by the user.