openstack/python-openstackclient
Code Issues Proposed changes
f552302b61
python-openstackclient/doc/source/index.rst
Steve Martinelli 727792da17 autodocument commands from plugins using stevedore.sphinxext 
conflicting command names are a painpoint, so is manually updating
a list. let's autodocument the commands that are being use by
existing osc supporters.

Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-12-01 01:23:56 -05:00

2.5 KiB
Raw Blame History

OpenStackClient

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Storage and Volume APIs together in a single shell with a uniform command structure.

User Documentation

command-list commands configuration plugins plugin-commands authentication interactive humaninterfaceguide backwards-incompatible man/openstack

Getting Started

Release Notes

releases history

Developer Documentation

developing command-options command-wrappers

Project Goals

  • Use the OpenStack Python API libraries, extending or replacing them as required
  • Use a consistent naming and structure for commands and arguments
  • Provide consistent output formats with optional machine parseable formats
  • Use a single-binary approach that also contains an embedded shell that can execute multiple commands on a single authentication (see libvirt's virsh for an example)
  • Independence from the OpenStack project names; only API names are referenced (to the extent possible)

Contributing

OpenStackClient utilizes all of the usual OpenStack processes and requirements for contributions. The code is hosted on OpenStack's Git server. Bug reports and blueprints may be submitted to the python-openstackclient project on Launchpad. Code may be submitted to the openstack/python-openstackclient project using Gerrit. Developers may also be found in the IRC channel #openstack-sdks.

Indices and Tables

  • genindex
  • modindex
  • search