xcmd
========

.. image:: https://travis-ci.org/rgs1/xcmd.svg?branch=master
    :target: https://travis-ci.org/rgs1/xcmd
    :alt: Build Status

.. image:: https://coveralls.io/repos/github/rgs1/xcmd/badge.svg?branch=master
    :target: https://coveralls.io/github/rgs1/xcmd?branch=master
    :alt: Coverage Status

.. image:: https://badge.fury.io/py/xcmd.svg
    :target: http://badge.fury.io/py/xcmd
    :alt: PyPI version

.. image:: https://requires.io/github/rgs1/xcmd/requirements.svg?branch=master
    :target: https://requires.io/github/rgs1/xcmd/requirements/?branch=master
    :alt: Requirements Status

.. image:: https://img.shields.io/pypi/pyversions/xcmd.svg
    :target: https://pypi.python.org/pypi/xcmd
    :alt: Python Versions

.. image:: https://codeclimate.com/github/rgs1/xcmd.png
    :target: https://codeclimate.com/github/rgs1/xcmd
    :alt: Code Climate

**Table of Contents**

-  `tl;dr <#tldr>`__
-  `Installing <#installing>`__
-  `Usage <#usage>`__
-  `Dependencies <#dependencies>`__

tl;dr
~~~~~

XCmd provides convenient parameters parsing on top of cmd.Cmd

Installing
~~~~~~~~~~

From PyPI:

::

    $ pip install xcmd

Or running from the source:

::

    $ cd xcmd
    $ export FROM_SOURCE=1; bin/xcmd-shell


Usage
~~~~~

::

    (more to come: porting zk-shell over to xcmd)

Dependencies
~~~~~~~~~~~~

-  Python 2.7, 3.3, 3.4, 3.5 or 3.6
-

Testing and Development
~~~~~~~~~~~~~~~~~~~~~~~

Please see `CONTRIBUTING.rst <CONTRIBUTING.rst>`__.


