| Name | ansible-navigator JSON |
| Version |
24.12.0
JSON |
| download |
| home_page | None |
| Summary | A text-based user interface (TUI) for the Red Hat Ansible Automation Platform |
| upload_time | 2024-12-12 05:55:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Apache |
| keywords |
ansible
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ansible-navigator
[//]: # (DO-NOT-REMOVE-docs-intro-START)
A text-based user interface (TUI) for Ansible.
A demo of the interface can be found [on YouTube][YT demo].
[YT demo]: https://www.youtube.com/watch?v=J9PBKi8ydi4
[//]: # (DO-NOT-REMOVE-docs-intro-END)
## Communication
Refer to the
[Talk to us](https://ansible.readthedocs.io/projects/navigator/contributing/community/#talk-to-us)
section of the Contributing guide to find out how to get in touch with us.
You can also find more information in the
[Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
## Contributing
Any kind of contribution to this project is very welcome and appreciated,
whether it is a documentation improvement, [bug report][issue],
[pull request][pull request] review, or a patch.
See the [Contributing guidelines][contributing guidelines] for details.
[issue]:https://github.com/ansible/ansible-navigator/issues
[pull request]:https://github.com/ansible/ansible-navigator/pulls
[contributing guidelines]:
https://ansible.readthedocs.io/projects/navigator/contributing/guidelines/
## Code of Conduct
Please see the official
[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
## Quick start
### Installing
Getting 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 relevant
[Python documentation][Python venv doc] useful.)
By default, ansible-navigator uses a container runtime (`podman` or `docker`,
whichever it finds first) and runs Ansible within an execution environment
(a pre-built container image which includes [ansible-core] along 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.
[ansible-core]: https://docs.ansible.com/ansible-core/devel
[Python venv doc]: https://docs.python.org/3/library/venv.html
Additional `Linux`, `macOS` and `Windows with WSL2` installation
instructions are available in the [Installation guide].
[Installation guide]:
https://ansible-navigator.readthedocs.io/installation/
## Welcome
When running `ansible-navigator` with no arguments, you will be presented with
the *welcome 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 modes
There are two modes in which ansible-navigator can be run:
* The **interactive** mode, 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; and
* The **stdout** mode, which does *not* use curses, and simply returns the
output to the terminal's standard output stream, as Ansible's commands
would.
The **interactive** mode is the default and this default can be overwritten by
passing `--mode stdout` (`-m stdout`) or setting `mode` in
[configuration][settings documentation].
[settings documentation]: https://ansible-navigator.readthedocs.io/settings/
## Example commands
All of ansible-navigator's features can be accessed from the *welcome page*
described above, but as a shortcut, commands can also be provided directly as
command-line arguments.
Some examples:
* Review and explore available collections: `ansible-navigator collections`
* Review and explore current Ansible configuration: `ansible-navigator config`
* Review and explore Ansible documentation:
`ansible-navigator doc ansible.netcommon.cli_command`
* Review execution environment images available locally:
`ansible-navigator images`
* Review and explore an inventory:
`ansible-navigator inventory -i inventory.yaml`
* Run and explore a playbook:
`ansible-navigator run site.yaml -i inventory.yaml`
Or using the **stdout** mode described above:
* Show the current Ansible configuration:
`ansible-navigator config dump -m stdout`
* Show 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 the [subcommand documentation].
[subcommand documentation]:
https://ansible-navigator.readthedocs.io/subcommands/
## Configuring ansible-navigator
There 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 the [settings documentation].
## Frequently Asked Questions (FAQ)
We maintain a [list of common questions][FAQ] which provides a good
resource to check if something is tripping you up. We also encourage additions
to this document for the greater community!
[FAQ]: https://ansible-navigator.readthedocs.io/faq/
## License
ansible-navigator is released under the Apache License version 2. See the
[LICENSE] file for more details.
[LICENSE]: https://github.com/ansible/ansible-navigator/blob/main/LICENSE
Raw data
{
"_id": null,
"home_page": null,
"name": "ansible-navigator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Ansible by Red Hat <info@ansible.com>",
"keywords": "ansible",
"author": null,
"author_email": "\"Bradley A. Thornton\" <bthornto@redhat.com>",
"download_url": "https://files.pythonhosted.org/packages/d1/15/40aae823192f93c8424c8121b71a871b875a2f71066f4070d76e2fff7b95/ansible_navigator-24.12.0.tar.gz",
"platform": null,
"description": "# ansible-navigator\n\n[//]: # (DO-NOT-REMOVE-docs-intro-START)\n\nA text-based user interface (TUI) for Ansible.\n\nA demo of the interface can be found [on YouTube][YT demo].\n\n[YT demo]: https://www.youtube.com/watch?v=J9PBKi8ydi4\n\n[//]: # (DO-NOT-REMOVE-docs-intro-END)\n\n## Communication\n\nRefer to the\n[Talk to us](https://ansible.readthedocs.io/projects/navigator/contributing/community/#talk-to-us)\nsection of the Contributing guide to find out how to get in touch with us.\n\nYou can also find more information in the\n[Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).\n\n## Contributing\n\nAny kind of contribution to this project is very welcome and appreciated,\nwhether it is a documentation improvement, [bug report][issue],\n[pull request][pull request] review, or a patch.\n\nSee the [Contributing guidelines][contributing guidelines] for details.\n\n[issue]:https://github.com/ansible/ansible-navigator/issues\n[pull request]:https://github.com/ansible/ansible-navigator/pulls\n[contributing guidelines]:\nhttps://ansible.readthedocs.io/projects/navigator/contributing/guidelines/\n\n## Code of Conduct\n\nPlease see the official\n[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).\n\n## Quick start\n\n### Installing\n\nGetting started with ansible-navigator is as simple as:\n\n```\npip3 install 'ansible-navigator[ansible-core]'\nansible-navigator --help\n```\n\n(Users wishing to install within a virtual environment might find the relevant\n[Python documentation][Python venv doc] useful.)\n\nBy default, ansible-navigator uses a container runtime (`podman` or `docker`,\nwhichever it finds first) and runs Ansible within an execution environment\n(a pre-built container image which includes [ansible-core] along with a set\nof Ansible collections.)\n\nThis default behavior can be disabled by starting ansible-navigator with\n`--execution-environment false`. In this case, Ansible and any collections\nneeded must be installed manually on the system.\n\n[ansible-core]: https://docs.ansible.com/ansible-core/devel\n[Python venv doc]: https://docs.python.org/3/library/venv.html\n\nAdditional `Linux`, `macOS` and `Windows with WSL2` installation\ninstructions are available in the [Installation guide].\n\n[Installation guide]:\nhttps://ansible-navigator.readthedocs.io/installation/\n\n## Welcome\n\nWhen running `ansible-navigator` with no arguments, you will be presented with\nthe *welcome page*. From this page, you can run playbooks, browse collections,\nexplore inventories, read Ansible documentation, and more.\n\nA full list of key bindings can be viewed by typing `:help`.\n\n## Output modes\n\nThere are two modes in which ansible-navigator can be run:\n\n* The **interactive** mode, which provides a curses-based user interface and\n allows you to \"zoom in\" on data in real time, filter it, and navigate between\n various Ansible components; and\n* The **stdout** mode, which does *not* use curses, and simply returns the\n output to the terminal's standard output stream, as Ansible's commands\n would.\n\nThe **interactive** mode is the default and this default can be overwritten by\npassing `--mode stdout` (`-m stdout`) or setting `mode` in\n[configuration][settings documentation].\n\n[settings documentation]: https://ansible-navigator.readthedocs.io/settings/\n\n## Example commands\n\nAll of ansible-navigator's features can be accessed from the *welcome page*\ndescribed above, but as a shortcut, commands can also be provided directly as\ncommand-line arguments.\n\nSome examples:\n\n* Review and explore available collections: `ansible-navigator collections`\n* Review and explore current Ansible configuration: `ansible-navigator config`\n* Review and explore Ansible documentation:\n `ansible-navigator doc ansible.netcommon.cli_command`\n* Review execution environment images available locally:\n `ansible-navigator images`\n* Review and explore an inventory:\n `ansible-navigator inventory -i inventory.yaml`\n* Run and explore a playbook:\n `ansible-navigator run site.yaml -i inventory.yaml`\n\nOr using the **stdout** mode described above:\n\n* Show the current Ansible configuration:\n `ansible-navigator config dump -m stdout`\n* Show documentation: `ansible-navigator doc sudo -t become -m stdout`\n\n... and so on. A full list of subcommands and their relation to Ansible\ncommands can be found in the [subcommand documentation].\n\n[subcommand documentation]:\nhttps://ansible-navigator.readthedocs.io/subcommands/\n\n## Configuring ansible-navigator\n\nThere are several ways to configure ansible-navigator and users and projects\nare free to choose the most convenient method for them. The full hierarchy of\nhow various configuration sources are applied can be found in the FAQ mentioned\nbelow.\n\nOf note, projects making use of ansible-navigator can include a project-wide\nconfiguration file with the project. If one is not found, ansible-navigator\nwill look for a user-specific configuration file in the user's home directory.\nDetails about this can be found in the [settings documentation].\n\n## Frequently Asked Questions (FAQ)\n\nWe maintain a [list of common questions][FAQ] which provides a good\nresource to check if something is tripping you up. We also encourage additions\nto this document for the greater community!\n\n[FAQ]: https://ansible-navigator.readthedocs.io/faq/\n\n## License\n\nansible-navigator is released under the Apache License version 2. See the\n[LICENSE] file for more details.\n\n[LICENSE]: https://github.com/ansible/ansible-navigator/blob/main/LICENSE\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "A text-based user interface (TUI) for the Red Hat Ansible Automation Platform",
"version": "24.12.0",
"project_urls": {
"changelog": "https://github.com/ansible/ansible-navigator/releases",
"documentation": "https://ansible-navigator.readthedocs.io/en/latest/",
"homepage": "https://github.com/ansible/ansible-navigator",
"repository": "https://github.com/ansible/ansible-navigator"
},
"split_keywords": [
"ansible"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20271bab494d0969a7db815c28f824c23c7b2ea5aa5bf7c271f9227ce2d9efd7",
"md5": "055997655f290b26d7fe0a606230ec97",
"sha256": "a39e3b79c69d7612b818d929be5dbe6d525ebddfb1c1a2713d83893547c37b8c"
},
"downloads": -1,
"filename": "ansible_navigator-24.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "055997655f290b26d7fe0a606230ec97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 302293,
"upload_time": "2024-12-12T05:55:13",
"upload_time_iso_8601": "2024-12-12T05:55:13.318345Z",
"url": "https://files.pythonhosted.org/packages/20/27/1bab494d0969a7db815c28f824c23c7b2ea5aa5bf7c271f9227ce2d9efd7/ansible_navigator-24.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d11540aae823192f93c8424c8121b71a871b875a2f71066f4070d76e2fff7b95",
"md5": "9568954fe136474315cf7a68e8012944",
"sha256": "f832574b0c132231746ff8b93470ab9d1f4dfa733297ca1ffb3c849a64f36e84"
},
"downloads": -1,
"filename": "ansible_navigator-24.12.0.tar.gz",
"has_sig": false,
"md5_digest": "9568954fe136474315cf7a68e8012944",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 390685,
"upload_time": "2024-12-12T05:55:16",
"upload_time_iso_8601": "2024-12-12T05:55:16.307536Z",
"url": "https://files.pythonhosted.org/packages/d1/15/40aae823192f93c8424c8121b71a871b875a2f71066f4070d76e2fff7b95/ansible_navigator-24.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 05:55:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansible",
"github_project": "ansible-navigator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ansible-navigator"
}
