Explain Payloads
chaos.lib.args.dataclasses.ExplainPayload
Bases: BasePayload
Payload for retrieving explanatory documentation about Ch-aOS concepts and roles.
Attributes:
| Name | Type | Description |
|---|---|---|
topics |
list[str]
|
A list of topics or sub-topics to explain (e.g., 'apply', 'secrets.edit'). |
no_pretty |
bool
|
If True, disables rich CLI formatting for the output. |
json |
bool
|
If True, formats the raw explanation output as JSON. |
details |
str
|
The level of detail requested ('basic', 'intermediate', or 'advanced'). |
complexity |
str
|
The complexity level of the explanation. |