From e63eba247fcd7df1600cfab2f178dfef80cf1f0c Mon Sep 17 00:00:00 2001 From: TVo Date: Tue, 9 Sep 2025 15:22:08 -0600 Subject: [PATCH] AAP-37812 Added mention about setting correct env variable in cli usage (#16091) Added mention about setting correct env variable in cli usage --- awxkit/awxkit/cli/docs/source/conf.py | 4 ++-- awxkit/awxkit/cli/docs/source/usage.rst | 11 +++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/awxkit/awxkit/cli/docs/source/conf.py b/awxkit/awxkit/cli/docs/source/conf.py index 490ddb404b..4a1123eefc 100644 --- a/awxkit/awxkit/cli/docs/source/conf.py +++ b/awxkit/awxkit/cli/docs/source/conf.py @@ -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 ''' diff --git a/awxkit/awxkit/cli/docs/source/usage.rst b/awxkit/awxkit/cli/docs/source/usage.rst index 13d36d0c1d..68741cb0a5 100644 --- a/awxkit/awxkit/cli/docs/source/usage.rst +++ b/awxkit/awxkit/cli/docs/source/usage.rst @@ -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