Skip to content

Commit e63eba2

Browse files
authored
AAP-37812 Added mention about setting correct env variable in cli usage (#16091)
Added mention about setting correct env variable in cli usage
1 parent 51eb109 commit e63eba2

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

awxkit/awxkit/cli/docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# -- Project information -----------------------------------------------------
1919

2020
project = 'AWX CLI'
21-
copyright = '2024, Ansible by Red Hat'
21+
copyright = '2025, Ansible by Red Hat'
2222
author = 'Ansible by Red Hat'
2323

2424

@@ -54,5 +54,5 @@
5454
.. |prog| replace:: awx
5555
.. |at| replace:: automation controller
5656
.. |At| replace:: Automation controller
57-
.. |RHAT| replace:: Red Hat Ansible Automation Platform controller
57+
.. |RHAT| replace:: Red Hat Ansible Automation Platform
5858
'''

awxkit/awxkit/cli/docs/source/usage.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Installation
1010
Synopsis
1111
--------
1212

13-
|prog| commands follow a simple format:
13+
CLI commands follow a simple format:
1414

1515
.. code:: bash
1616
@@ -25,7 +25,14 @@ The ``action`` is the thing you want to do (a verb). Resources generally have a
2525
Getting Started
2626
---------------
2727

28-
Using |prog| requires some initial configuration. Here is a simple example for interacting with an AWX or |RHAT| server:
28+
Using |prog| requires some initial configuration. To execute AWX CLI on |RHAT| 2.5 and later, you must set your environment variable to:
29+
30+
.. code::
31+
32+
AWXKIT_API_BASE_PATH=/api/controller/
33+
34+
35+
Here is a simple example for interacting with an AWX or |RHAT| server:
2936

3037
.. code:: bash
3138

0 commit comments

Comments
 (0)