External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-03-16 00:17:29 -02:30
Code Issues Packages Projects Releases Wiki Activity

promote AWX CLI installation instructions to the global INSTALL.md

Browse Source 
a few users have had trouble finding these instructions, so let's move
them into the top level installation docs
This commit is contained in:
Ryan Petrello
2020-03-30 11:44:33 -04:00
parent 4a8f1d41fa
commit 32627ce51a
2 changed files with 33 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
awxkit/awxkit/cli/docs/README.md
View File

@@ -1,29 +1,3 @@
AWX Command Line Interface
==========================
`awx` is the official command-line client for AWX. It:
* Uses naming and structure consistent with the AWX HTTP API
* Provides consistent output formats with optional machine-parsable formats
* To the extent possible, auto-detects API versions, available endpoints, and
feature support across multiple versions of AWX.
Potential uses include:
* Configuring and launching jobs/playbooks
* Checking on the status and output of job runs
* Managing objects like organizations, users, teams, etc...
Installation
------------
The preferred way to install the AWX CLI is through pip directly from GitHub:
pip install "https://github.com/ansible/awx/archive/$VERSION.tar.gz#egg=awxkit&subdirectory=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 Documentation
--------------------------
To build the docs, spin up a real AWX server, `pip install sphinx sphinxcontrib-autoprogram`, and run: