/wharfee

A CLI with autocompletion and syntax highlighting for Docker commands.

Primary LanguagePython

Stories in Ready PyPI version

wharfee

A shell for Docker that can do autocompletion and syntax highlighting.

Why?

Docker commands have tons of options. They are hard to remember.

ps

Container names are hard to remember and type.

rm

Same goes for image names.

rmi

There are some handy shortcuts too. What was that command ro remove all dangling images? OMG, what was it? docker rmi $(docker ps --all --quiet)? Oh, there you go:

rmi-dangling

Boom! How about removing all stopped containers?

rm-stopped

Installation

Wharfee is a Python package hosted on pypi and installed with:

$ pip install wharfee

Alternatively, you can install the latest from github and get all the bugfixes that didn't make it into pypi release yet:

$ pip install git+https://github.com/j-bennet/wharfee.git

What are you using?

Can I contribute?

Yes! Pull request or issues are welcome.

How do you test it?

First, install the requirements for testing:

$ pip install -r requirements-dev.txt

There are unit tests under tests. The command to run them is:

$ py.test

Additionally, there are integration tests, that can be run with:

$ cd tests
$ behave

To see stdout/stderr, use the following command:

$ behave --no-capture