mirror of
https://opendev.org/openstack/openstackclient.git
synced 2026-01-16 23:10:22 +00:00
Unified CLI with all python-openstackclient plugins
43e424a831
As part of the migration of this project to the independent release model, we failed to notice that the job template was still tied to a specific release. We've now introduced a new unversioned job template, 'openstack-python3-jobs' [1], which was can and should use. Do this. [1] https://review.opendev.org/c/openstack/openstack-zuul-jobs/+/833286/ Depends-On: https://review.opendev.org/c/openstack/openstack-zuul-jobs/+/833286/ Signed-off-by: Stephen Finucane <stephenfin@redhat.com> Change-Id: Ie872c1a718451097634e23c6dbdd0ddb70af7f35 |
||
|---|---|---|
| doc | ||
| playbooks | ||
| tests | ||
| .gitignore | ||
| .gitreview | ||
| .stestr.conf | ||
| .zuul.yaml | ||
| CONTRIBUTING.rst | ||
| LICENSE | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
===============
OpenStackClient
===============
.. image:: https://img.shields.io/pypi/v/openstackclient.svg
:target: https://pypi.org/project/openstackclient/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/dm/openstackclient.svg
:target: https://pypi.org/project/openstackclient/
:alt: Downloads
OpenStackClient (aka OSC) is a command-line client for OpenStack that brings
the command set for Compute, Identity, Image, Network, Object Store and Block
Storage APIs together in a single shell with a uniform command structure.
The ``openstackclient`` package is a metapackage that installs
``python-openstackclient`` and a number of optional plugins all at the same
time to simplify the installation of OSC. The major version of
``openstackclient`` will always correspond to the major version of
``python-openstackclient`` that will be installed.
* `PyPi`_ - package installation
* `Online Documentation`_
* `Launchpad project`_ - release management
* `Blueprints`_ - feature specifications
* `Bugs`_ - issue tracking
* `Source`_
* `Developer` - getting started as a developer
* `Contributing` - contributing code
* `Testing` - testing code
* IRC: #openstack-sdks on OFTC (irc.oftc.net)
* License: Apache 2.0
.. _PyPi: https://pypi.org/project/openstackclient
.. _Online Documentation: http://docs.openstack.org/developer/python-openstackclient/
.. _Launchpad project: https://launchpad.net/python-openstackclient
.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient
.. _Bugs: https://storyboard.openstack.org/#!/project/975
.. _Source: https://opendev.org/openstack/openstackclient
.. _Developer: http://docs.openstack.org/project-team-guide/project-setup/python.html
.. _Contributing: http://docs.openstack.org/infra/manual/developers.html
.. _Testing: http://docs.openstack.org/developer/python-openstackclient/developing.html#testing
Getting Started
===============
OpenStack Client can be installed from PyPI using pip::
pip install openstackclient
There are a few variants on getting help. A list of global options and supported
commands is shown with ``--help``::
openstack --help
There is also a ``help`` command that can be used to get help text for a specific
command::
openstack --help
openstack server create --help