diff options
| author | Ryan Petrello <rpetrell@redhat.com> | 2019-09-11 22:22:47 +0200 |
|---|---|---|
| committer | Ryan Petrello <rpetrell@redhat.com> | 2019-09-11 22:24:13 +0200 |
| commit | 83ee4fb28943bca2eee7142bdd48cff2489db917 (patch) | |
| tree | 9cf3fdca1ae0fe616f0ce50331ed8dcaf60ab789 /awxkit | |
| parent | Merge pull request #4677 from marshmalien/4430-host-details-modal (diff) | |
| download | awx-83ee4fb28943bca2eee7142bdd48cff2489db917.tar.xz awx-83ee4fb28943bca2eee7142bdd48cff2489db917.zip | |
add a bit more detail to the awx CLI README
Diffstat (limited to 'awxkit')
| -rw-r--r-- | awxkit/awxkit/cli/docs/README | 5 | ||||
| -rw-r--r-- | awxkit/awxkit/cli/docs/README.md | 32 |
2 files changed, 32 insertions, 5 deletions
diff --git a/awxkit/awxkit/cli/docs/README b/awxkit/awxkit/cli/docs/README deleted file mode 100644 index 7177b95f6a..0000000000 --- a/awxkit/awxkit/cli/docs/README +++ /dev/null @@ -1,5 +0,0 @@ -To build the docs, spin up a real AWX/Tower server, `pip 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 -Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) .. diff --git a/awxkit/awxkit/cli/docs/README.md b/awxkit/awxkit/cli/docs/README.md new file mode 100644 index 0000000000..5c347bb0d3 --- /dev/null +++ b/awxkit/awxkit/cli/docs/README.md @@ -0,0 +1,32 @@ +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" + +...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: + + ~ TOWER_HOST=https://awx.example.org TOWER_USERNAME=example TOWER_PASSWORD=secret make clean html + ~ cd build/html/ && python -m http.server + Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) .. |