Package: ansible-navigator
ansible-navigatorA text-based user interface (TUI) for Ansible.A demo of the interface can be foundon YouTube.ContributingAny kind of contribution to this project is very welcome and appreciated,
whether it is a documentation improvement,bug report,pull requestreview, or a patch.See theContributing guidelinesfor details.Quick startInstallingGetting started with ansible-navigator is as simple as:pip3 install 'ansible-navigator[ansible-core]'
ansible-navigator --help(Users wishing to install within a virtual environment might find the relevantPython documentationuseful.)By default, ansible-navigator uses a container runtime (podmanordocker,
whichever it finds first) and runs Ansible within an execution environment
(a pre-built container image which includesansible-corealong with a set
of Ansible collections.)This default behavior can be disabled by starting ansible-navigator with--execution-environment false. In this case, Ansible and any collections
needed must be installed manually on the system.AdditionalLinux,macOSandWindows with WSL2installation
instructions are available in theInstallation guide.WelcomeWhen runningansible-navigatorwith no arguments, you will be presented with
thewelcome page. From this page, you can run playbooks, browse collections,
explore inventories, read Ansible documentation, and more.A full list of key bindings can be viewed by typing:help.Output modesThere are two modes in which ansible-navigator can be run:Theinteractivemode, which provides a curses-based user interface and
allows you to "zoom in" on data in real time, filter it, and navigate between
various Ansible components; andThestdoutmode, which doesnotuse curses, and simply returns the
output to the terminal's standard output stream, as Ansible's commands
would.Theinteractivemode is the default and this default can be overwritten by
passing--mode stdout(-m stdout) or settingmodeinconfiguration.Example commandsAll of ansible-navigator's features can be accessed from thewelcome pagedescribed above, but as a shortcut, commands can also be provided directly as
command-line arguments.Some examples:Review and explore available collections:ansible-navigator collectionsReview and explore current Ansible configuration:ansible-navigator configReview and explore Ansible documentation:ansible-navigator doc ansible.netcommon.cli_commandReview execution environment images available locally:ansible-navigator imagesReview and explore an inventory:ansible-navigator inventory -i inventory.yamlRun and explore a playbook:ansible-navigator run site.yaml -i inventory.yamlOr using thestdoutmode described above:Show the current Ansible configuration:ansible-navigator config dump -m stdoutShow documentation:ansible-navigator doc sudo -t become  -m stdout... and so on. A full list of subcommands and their relation to Ansible
commands can be found in thesubcommand documentation.Configuring ansible-navigatorThere are several ways to configure ansible-navigator and users and projects
are free to choose the most convenient method for them. The full hierarchy of
how various configuration sources are applied can be found in the FAQ mentioned
below.Of note, projects making use of ansible-navigator can include a project-wide
configuration file with the project. If one is not found, ansible-navigator
will look for a user-specific configuration file in the user's home directory.
Details about this can be found in thesettings documentation.Frequently Asked Questions (FAQ)We maintain alist of common questionswhich provides a good
resource to check if something is tripping you up. We also encourage additions
to this document for the greater community!Licenseansible-navigator is released under the Apache License version 2. See theLICENSEfile for more details.