Skip to main content

Framework for building command-line tools

Project description

Build Status


yaclifw is a framework for building CLI tools.


Direct dependencies of yaclifw are:


To install yaclifw, run:

$ python install

or using pip, run:

$ pip install yaclifw

To upgrade your pip installation, run:

$ pip install -U yaclifw


The list of available commands can be listed with:

$ yaclifw -h

For each subcommand, additional help can be queried, e.g.:

$ yaclifw example -h

Extending yaclifw

The easiest way to make use of yaclifw is by cloning the repository and modifying the method to include your own commands.


yaclifw follows PEP 8, the Style Guide for Python Code. Please check your code with pep8 or flake8, the Python style guide checkers, by running flake8 -v . or pep8 -v ..

Running tests

The tests are located under the test directory. To run all the tests, use the test target of

python test

Unit tests

Unit tests are stored under the test/unit folder and can be run by calling:

python test -s test/unit

Unit tests are also run by the Travis build on every Pull Request opened against the main repository.


yaclifw is released under the GPL.

Project details

Download files

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

Source Distribution

yaclifw-0.1.2.tar.gz (13.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page