ansible-navigator subcommands

ansible-navigator subcommand overview

Available subcommands

Name

Description

CLI Example

Colon command

Version added

builder

Build execution environment (container image)

ansible-navigator builder --help

:builder

v2.0

collections

Explore available collections

ansible-navigator collections --help

:collections

v1.0

config

Explore the current ansible configuration

ansible-navigator config --help

:config

v1.0

doc

Review documentation for a module or plugin

ansible-navigator doc --help

:doc

v1.0

exec

Run a command within an execution environment

ansible-navigator exec --help

:exec

v2.0

images

Explore execution environment images

ansible-navigator images --help

:images

v1.0

inventory

Explore an inventory

ansible-navigator inventory --help

:inventory

v1.0

lint

Lint a file or directory for common errors and issues

ansible-navigator lint --help

:lint

v2.0

replay

Explore a previous run using a playbook artifact

ansible-navigator replay --help

:replay

v1.0

run

Run a playbook

ansible-navigator run --help

:run

v1.0

settings

Review the current ansible-navigator settings

ansible-navigator settings --help

:settings

v2.0

welcome

Start at the welcome page

ansible-navigator welcome --help

:welcome

v1.0

Mapping ansible-navigator commands to ansible commands

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

Mapping to ansible commands

ansible command

ansible-navigator command

ansible-navigator colon command

Notes

ansible

ansible-navigator exec -- ansible

N/A

The exec subcommand requires execution environment support.

ansible-builder

ansible-navigator builder

N/A

ansible-builder is installed with ansible-navigator

ansible-config

ansible-navigator config

:config

ansible-doc

ansible-navigator doc

:doc

ansible-inventory

ansible-navigator inventory

:inventory

ansible-galaxy

ansible-navigator exec -- ansible-galaxy ...

N/A

The exec subcommand requires execution environment support.

ansible-lint

ansible-navigator lint

:lint

ansible-lint needs to be installed locally or in the selected execution-environment.

ansible-playbook

ansible-navigator run

:run

ansible-test

ansible-navigator exec -- ansible-test ...

N/A

The exec subcommand requires execution environment support.

ansible-vault

ansible-navigator exec -- ansible-vault ...

N/A

The exec subcommand requires execution environment support.