ansible-navigator subcommands

Available subcommands

builder

Build execution environment (container image)

CLI Example: ansible-navigator builder --help

Colon command: :builder

Version added: :v2.0

collections

Explore available collections

CLI Example: ansible-navigator collections --help

Colon command: :collections

Version added: :v1.0

config

Explore the current ansible configuration

CLI Example: ansible-navigator config --help

Colon command: :config

Version added: :v1.0

doc

Review documentation for a module or plugin

CLI Example: ansible-navigator doc --help

Colon command: :doc

Version added: :v1.0

exec

Run a command within an execution environment

CLI Example: ansible-navigator exec --help

Colon command: :exec

Version added: :v2.0

images

Explore execution environment images

CLI Example: ansible-navigator images --help

Colon command: :images

Version added: :v1.0

inventory

Explore an inventory

CLI Example: ansible-navigator inventory --help

Colon command: :inventory

Version added: :v1.0

lint

Lint a file or directory for common errors and issues

CLI Example: ansible-navigator lint --help

Colon command: :lint

Version added: :v2.0

replay

Explore a previous run using a playbook artifact

CLI Example: ansible-navigator replay --help

Colon command: :replay

Version added: :v1.0

run

Run a playbook

CLI Example: ansible-navigator run --help

Colon command: :run

Version added: :v1.0

settings

Review the current ansible-navigator settings

CLI Example: ansible-navigator settings --help

Colon command: :settings

Version added: :v2.0

welcome

Start at the welcome page

CLI Example: ansible-navigator welcome --help

Colon command: :welcome

Version added: :v1.0

Mapping ansible-navigator commands to ansible commands

Some ansible-navigator commands map to ansible commands. The list below provides some examples.

ansible

Use ansible-navigator exec -- ansible from shell. The exec subcommand requires execution environment support.

ansible-builder

Use ansible-navigator builder from shell.ansible-builder is installed with ansible-navigator

ansible-config

Use ansible-navigator config from shell, or :config from the ansible-navigator prompt.

ansible-doc

Use ansible-navigator doc from shell, or :doc from the ansible-navigator prompt.

ansible-inventory

Use ansible-navigator inventory from shell, or :inventory from the ansible-navigator prompt.

ansible-galaxy

Use ansible-navigator exec -- ansible-galaxy ... from shell. The exec subcommand requires execution environment support.

ansible-lint

Use ansible-navigator lint from shell, or :lint from the ansible-navigator prompt. ansible-lint needs to be installed locally or in the selected execution-environment.

ansible-playbook

Use ansible-navigator run from shell or :run from the ansible-navigator prompt.

ansible-test

Use ansible-navigator exec -- ansible-test ... from shell. The exec subcommand requires execution environment support.

ansible-vault

Use ansible-navigator exec -- ansible-vault ... from shell. The exec subcommand requires execution environment support.