===========
Nirvana CLI
===========

.. warning:: This project is still in the early planning/development
    phase. There's a good chance that nothing you see here actually
    exists. If it does, it probably doesn't work.

About
=====

Nirvana CLI is a command line interface for the web-based task management
software from `NirvanaHQ <http://nirvanahq.com>`_, which is based on David
Allen's popular `Getting Things Done (GTD)
<http://www.davidco.com/about-gtd>`_  methodology.

Installation
============

The recommended method of installing the latest official release of
the Nirvana CLI is from the Python Package Index (PyPI). For the more
adventurous, the most recent development version can be installed from the
source code.

Python Package Index (PyPI)
---------------------------

The latest official release of the Nirvana CLI is available on the
`Python Package Index <http://pypi.python.org/>`_ and can be installed
with `pip <http://www.pip-installer.org/>`_::

    $ pip install nirvana-cli

Source Code
-----------

The `source code <https://github.com/njwilson/nirvana-cli>`_ is hosted
on GitHub. Once the source code is obtained, the Nirvana CLI can be
installed by running the following command from the nirvana-cli
directory::

    $ python setup.py install