Skip to content

Commit 3daf805

Browse files
authored
Updated usage.rst (ansible#7094)
Added mention about setting correct env variable in cli usage. Backported from ansible#16091.
1 parent 481bca1 commit 3daf805

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

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

Lines changed: 8 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,13 @@ 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+
Here is a simple example for interacting with an AWX or |RHAT| server:
2935

3036
.. code:: bash
3137

0 commit comments

Comments
 (0)