Skip to content

Commands: Management

Well, Ch-aOS needs some way to manage itself, right? After all, it's not just about configuring other systems; you also need to set up and maintain the chaos CLI environment. I am sure that just installing a random CLI tool and it not providing any way to manage itself would be a pain, right?

These commands help you manage the chaos CLI environment itself, from initializing configuration files to discovering available functionality.

chaos init

The chaos init command is a setup wizard that creates boilerplate configuration files, lowering the barrier to entry by generating templates for you.

Subcommands

init chobolo

This command scans your installed plugins for their required configuration keys and generates a template ch-obolo.yml file. This is a great way to discover the data your roles need.

Usage:

chaos init chobolo
This will create a ch-obolo_template.yml in ~/.config/chaos/.

init secrets

This command runs an interactive wizard to set up your secret management with sops. It helps you:

  • Choose between age and gpg as your encryption backend.

  • Generate new keys or use existing ones.

  • Create a .sops.yaml configuration file.

  • Create an initial secrets.yml file.

Usage:

chaos init secrets


chaos set

The chaos set command configures default paths for your most-used files, saving you from having to specify them with flags on every command. These paths are saved to ~/.config/chaos/config.yml.

Subcommands

set chobolo <path>

Sets the default Ch-obolo file to use for apply operations.

Usage:

chaos set chobolo ~/my-chaos-configs/main-chobolo.yml

set secrets <path>

Sets the default secrets file.

Usage:

chaos set secrets ~/my-chaos-configs/secrets.sops.yml

set sops <path>

Sets the default .sops.yaml configuration file.

Usage:

chaos set sops ~/my-chaos-configs/.sops.yaml


chaos check

The chaos check command helps you discover what functionality is available from your installed plugins.

Subcommands

check roles

Lists all available role tags that you can use with chaos apply.

Usage:

chaos check roles

check aliases

Lists all available command aliases for role tags.

Usage:

chaos check aliases

check explanations

Lists all documentation topics that you can read about with chaos explain.

Usage:

chaos check explanations

check providers

Lists all available secret providers.

Usage:

chaos check providers

check boats

Lists all available fleet boats.

Usage:

chaos check boats