AAP-37812 Added mention about setting correct env variable in cli usage (#16091)

Added mention about setting correct env variable in cli usage
This commit is contained in:
TVo 2025-09-09 15:22:08 -06:00 committed by GitHub
parent 51eb109dbe
commit e63eba247f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 4 deletions

View File

@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------
project = 'AWX CLI'
copyright = '2024, Ansible by Red Hat'
copyright = '2025, Ansible by Red Hat'
author = 'Ansible by Red Hat'
@ -54,5 +54,5 @@ rst_epilog = '''
.. |prog| replace:: awx
.. |at| replace:: automation controller
.. |At| replace:: Automation controller
.. |RHAT| replace:: Red Hat Ansible Automation Platform controller
.. |RHAT| replace:: Red Hat Ansible Automation Platform
'''

View File

@ -10,7 +10,7 @@ Installation
Synopsis
--------
|prog| commands follow a simple format:
CLI commands follow a simple format:
.. code:: bash
@ -25,7 +25,14 @@ The ``action`` is the thing you want to do (a verb). Resources generally have a
Getting Started
---------------
Using |prog| requires some initial configuration. Here is a simple example for interacting with an AWX or |RHAT| server:
Using |prog| requires some initial configuration. To execute AWX CLI on |RHAT| 2.5 and later, you must set your environment variable to:
.. code::
AWXKIT_API_BASE_PATH=/api/controller/
Here is a simple example for interacting with an AWX or |RHAT| server:
.. code:: bash