Dean Troyer 625a8ae42d Add documentation of interactive mode
This is a light description with some examples.

Change-Id: Iff9ad904a150f2bb7673bd4106cf26bcefec08b9
2014-12-04 15:16:05 -05:00

49 lines
1.2 KiB
ReStructuredText

===============
OpenStackClient
===============
OpenStackClient (aka OSC) is a command-line client for OpenStack that
brings the command set for Compute, Identity, Image, Object Store and Volume
APIs together in a single shell with a uniform command structure.
Contents:
.. toctree::
:maxdepth: 1
releases
command-list
commands
plugins
authentication
interactive
man/openstack
Getting Started
---------------
* Check out `the wiki`_
* Try `some commands`_
* Read the source `on OpenStack's Git server`_
.. _the wiki: https://wiki.openstack.org/OpenStackClient
.. _some commands: https://wiki.openstack.org/OpenStackClient/Commands
Contributing
============
Code is hosted `on OpenStack's Git server`_. Submit bugs to the
python-openstackclient project on `Launchpad`_. Submit code to
the openstack/python-openstackclient project using `Gerrit`_.
.. _on OpenStack's Git server: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
.. _Launchpad: https://launchpad.net/python-openstackclient
.. _Gerrit: http://wiki.openstack.org/GerritWorkflow
Indices and Tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`