Skip to content

README.md

Latest commit

 

History

History
85 lines (57 loc) · 1.72 KB

README.md

File metadata and controls

85 lines (57 loc) · 1.72 KB

Rackspace CLI

Command line client for interacting with various Rackspace Cloud APIs.

Installation

Command line client is available on PyPi and can be installed using pip:

pip install raxcli

Settings Credentials

Credentials can be set (in order of precedence) as environment variables in a configuration file or you can pass them manually to each command.

Default configuration file path is ~/.raxrc but you can overrride it by setting the RAXCLI_RAXRC environment variable. For example:

RAXCLI_RAXRC=~/.raxrc.uk raxcli registry services list

Example configuration files can be found in the examples/ directory.

Usage

raxcli <service> <resource> <action> [options]

For example:

raxcli registry services list

Custom Output Formatter

To specify a custom formatter, use -f option. For example:

raxcli registry services list -f json

Available Formatters

  • table
  • csv
  • json
  • yaml
  • html

Development

Testing and Lint

Running tests

python setup.py test

Running lint

python setup.py flake8

Goals / Brain dump

  • Common command line client for all the Rackspace Cloud APIs
  • Supports user and machine friendly input and output formats
  • Default to user friendly output format
  • Multiple output formats (table, json, csv)
  • Command structure which makes sense - raxcli
  • Supported Python version - 2.6, 2.7, PyPy
  • Autocomplete
  • REPL for every api
  • Friendly debug output when using --debug
  • Print CURL request actions when using --debug
  • Single, unified configuration file (~/.raxrc)

License

Library is distributed under the Apache 2.0 license.