{"id":20925,"library":"ansible-navigator","title":"Ansible Navigator","description":"A text-based user interface (TUI) for the Red Hat Ansible Automation Platform. Provides an interactive curses-based interface for running, reviewing, and debugging Ansible playbooks, inventories, and collections. Current version: 26.4.0, requires Python >=3.10. Release cadence follows Ansible Automation Platform releases.","status":"active","version":"26.4.0","language":"python","source_language":"en","source_url":"https://github.com/ansible/ansible-navigator","tags":["ansible","tui","automation","cli","curses","red-hat"],"install":[{"cmd":"pip install ansible-navigator","lang":"bash","label":"Install from PyPI"},{"cmd":"pip install ansible-navigator[community]","lang":"bash","label":"Install with community extras"}],"dependencies":[{"reason":"Runtime dependency for executing playbooks","package":"ansible-core","optional":false},{"reason":"TUI interface; may need manual install on some platforms","package":"curses","optional":true}],"imports":[{"note":"Incorrect top-level import; AnsibleNavigator class is under app module.","wrong":"from ansible_navigator import AnsibleNavigator","symbol":"AnsibleNavigator","correct":"from ansible_navigator.app import AnsibleNavigator"},{"note":"","wrong":"","symbol":"NavigatorConfiguration","correct":"from ansible_navigator.configuration_subsystem import NavigatorConfiguration"}],"quickstart":{"code":"from ansible_navigator.app import AnsibleNavigator\nimport os\n\nos.environ['ANSIBLE_NAVIGATOR_CONFIG'] = ''  # optional, set to empty string for default\nnavigator = AnsibleNavigator()\nnavigator.run()","lang":"python","description":"Launch the navigator TUI. The environment variable ANSIBLE_NAVIGATOR_CONFIG can point to a settings file."},"warnings":[{"fix":"Update to 2.x or later and refer to current documentation for CLI syntax.","message":"Version 2.x (ansible-navigator) changed CLI options significantly from 1.x (ansible-tui). Many flags were renamed or removed.","severity":"breaking","affected_versions":"<=1.x"},{"fix":"Use '--artifact-format' and '--artifact-dir' instead.","message":"The '--playbook-artifact' option has been deprecated in favor of '--artifact-format' and '--artifact-dir'.","severity":"deprecated","affected_versions":">=24.0.0"},{"fix":"Set ANSIBLE_NAVIGATOR_MODE=stdout or pass --mode stdout to run without TUI.","message":"If running in a headless environment without a proper terminal (e.g., CI/CD), the TUI will fail. Use '--mode stdout' or set the environment variable ANSIBLE_NAVIGATOR_MODE=stdout.","severity":"gotcha","affected_versions":"all"},{"fix":"Use correct imports like 'from ansible_navigator.app import AnsibleNavigator'.","message":"The import path changed from 'ansible_navigator' to nested modules. Common top-level imports fail silently.","severity":"gotcha","affected_versions":">=2.0.0"},{"fix":"Upgrade to Python 3.10 or later.","message":"Python 3.10+ is required. Installations on older Python versions will fail.","severity":"gotcha","affected_versions":">=26.0.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Run 'pip install ansible-navigator' in the correct Python environment.","cause":"Package not installed or installed in wrong environment.","error":"ModuleNotFoundError: No module named 'ansible_navigator'"},{"fix":"Use 'from ansible_navigator.app import AnsibleNavigator'.","cause":"Incorrect import path; the class is nested under app submodule.","error":"ImportError: cannot import name 'AnsibleNavigator' from 'ansible_navigator'"},{"fix":"Set environment variable TERM=xterm or run with '--mode stdout'.","cause":"Running in an environment without a proper terminal (e.g., headless).","error":"curses.error: setupterm: could not find terminal"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}