Skip to main content

Let you convert any module into a multi-command CLI program without any configuration.

Project description

The full version of this documentaion is at


Clime lets you convert any module into a multi-command CLI program without any configuration.

The main features:

  1. It works well with zero configuration. Free you from the configuration hell.
  2. Docstring is just config. When you finish the docstring, the config of the aliases and metavars are also finished.
  3. It generates the usage of each command from the functions automatically.

It is a better choice than the heavy optparse or argparse for most of the CLI tasks.

CLI-ize ME!

Let me show you Clime with an example.

Here we have a simple script with a docstring here:

# file:

def repeat(message, times=2, count=False):
    '''It repeats the message.

        -m=<str>, --message=<str>  The description of this option.
        -t=<int>, --times=<int>
        -c, --count

    s = message * times
    return len(s) if count else s

After adding this line,


… your CLI program is ready!

$ python twice

$ python --times=3 thrice

And it generates the usage manual:

$ python --help
usage: [-t<int> | --times=<int>] [-c | --count] <message>
   or: repeat [-t<int> | --times=<int>] [-c | --count] <message>

If you have a docstring in your function, it also show up in usage manual with --help.

$ python repeat --help
usage: [-t<int> | --times=<int>] [-c | --count] <message>
   or: repeat [-t<int> | --times=<int>] [-c | --count] <message>

It repeat the message.

    -m=<str>, --message=<str>  The message.
    -t=<int>, --times=<int>
    -c, --count

You can find more examples in the clime/examples.

This page, Command.parse, describes how Clime parses the arguments.

If you are interesting in the aliases or the metavariables which Clime provides, read Command for more infomation.


Clime is hosted on two different platforms, PyPI and GitHub.

  1. Install from PyPI

    Install Clime from PyPI for a stable version

    $ sudo pip install clime

    If you don’t have pip, execute

    $ sudo apt-get install python-pip

    to install pip on Debian-base Linux distribution.

  2. Get Clime from GitHub

    If you want to follow the latest version of Clime, use

    $ git clone git://

    to clone a Clime repository, or download manually from GitHub.


You have two different ways to use Clime.

  1. Insert A Line into Your Source Code

    Just add this line into your source code:


    It is recommended to put the line in the if __name__ == '__main__': block.

  2. Use Clime as A Command

    clime is also an executable module. You can use it to convert a module or a stand-alone program temporarily.

    $ python -m clime TARGET

If you want to know how to customize the program, read Program for more infomation.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for clime, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size clime-0.2.1.tar.gz (17.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page