summaryrefslogtreecommitdiffstats
path: root/INSTALL.md
diff options
context:
space:
mode:
authorRyan Petrello <rpetrell@redhat.com>2020-06-23 23:38:29 +0200
committerRyan Petrello <rpetrell@redhat.com>2020-06-23 23:53:14 +0200
commitb6c210ee97d32fe0500cb3054a50dbc7716416b1 (patch)
treea012501ce56c07bdf62dd8a2c32a51a0d5c8b5d7 /INSTALL.md
parentMerge pull request #7420 from elyezer/update-credential-creation (diff)
downloadawx-b6c210ee97d32fe0500cb3054a50dbc7716416b1.tar.xz
awx-b6c210ee97d32fe0500cb3054a50dbc7716416b1.zip
update instructions and metadata for awxkit/cli installs
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md8
1 files changed, 3 insertions, 5 deletions
diff --git a/INSTALL.md b/INSTALL.md
index f790bc03ba..a6aede56c6 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -651,16 +651,14 @@ Potential uses include:
* Checking on the status and output of job runs
* Managing objects like organizations, users, teams, etc...
-The preferred way to install the AWX CLI is through pip directly from GitHub:
+The preferred way to install the AWX CLI is through pip directly from PyPI:
- pip install "https://github.com/ansible/awx/archive/$VERSION.tar.gz#egg=awxkit&subdirectory=awxkit"
+ pip3 install awxkit
awx --help
-...where ``$VERSION`` is the version of AWX you're running. To see a list of all available releases, visit: https://github.com/ansible/awx/releases
-
## Building the CLI Documentation
-To build the docs, spin up a real AWX server, `pip install sphinx sphinxcontrib-autoprogram`, and run:
+To build the docs, spin up a real AWX server, `pip3 install sphinx sphinxcontrib-autoprogram`, and run:
~ TOWER_HOST=https://awx.example.org TOWER_USERNAME=example TOWER_PASSWORD=secret make clean html
~ cd build/html/ && python -m http.server