Usage

Basic Usage

The general usage pattern obtained by running andebox --help is:

 Usage: andebox [OPTIONS] COMMAND [ARGS]...

 Ansible Developer (Tool)Box v2.1.0

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version                             Show version and exit.                 │
│ --collection          -c      <str>   fully qualified collection name (not   │
│                                       necessary if a proper galaxy.yml file  │
│                                       is available)                          │
│ --venv                -V      <path>  path to the virtual environment where  │
│                                       andebox and ansible are installed      │
│ --install-completion                  Install completion for the current     │
│                                       shell.                                 │
│ --show-completion                     Show completion for the current shell, │
│                                       to copy it or customize the            │
│                                       installation.                          │
│ --help                -h              Show this message and exit.            │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ test      runs ansible-test in a temporary environment                       │
│ context   returns information from running context                           │
│ docsite   builds collection docsite                                          │
│ ignores   gathers stats on ignore*.txt file(s)                               │
│ nox-test  runs ansible-test within nox, for testing in multiple              │
│           ansible/python versions                                            │
│ runtime   returns information from runtime.yml                               │
│ tox-test  runs ansible-test within tox, for testing in multiple ansible      │
│           versions                                                           │
│ vagrant   runs 'andebox test -- integration' within a VM managed with        │
│           vagrant                                                            │
│ yaml-doc  analyze and/or reformat YAML documentation in plugins              │
╰──────────────────────────────────────────────────────────────────────────────╯

See Actions for available actions.

Shell Completion

andebox provides tab completion for sub-commands and options via typer (which supports Bash, Zsh, Fish, and PowerShell).

To install completion for your current shell, run once:

andebox --install-completion

Restart your shell (or source its configuration file) and tab completion will be active.

To inspect the generated script without installing it:

andebox --show-completion

After setup, pressing <TAB> after andebox will show available sub-commands, and pressing <TAB> after a sub-command will show its options.