Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tvo318 merged 1 commit into from
Sep 9, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions awxkit/awxkit/cli/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'


Expand Down Expand Up @@ -54,5 +54,5 @@
.. |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
'''
11 changes: 9 additions & 2 deletions awxkit/awxkit/cli/docs/source/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Installation
Synopsis
--------

|prog| commands follow a simple format:
CLI commands follow a simple format:

.. code:: bash

Expand All @@ -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

Expand Down
Loading