Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Stories in Ready PyPI version Join the chat at https://gitter.im/j-bennet/wharfee

wharfee

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

ps

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 to 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

Running

Wharfee is a console application. You run it from terminal by typing the program name into the command line:

$ wharfee

If you're on Windows, you may be not so familiar with using the terminal. But if you installed Docker (Docker Toolbox), you'll have Docker Quickstart Terminal as part of you installation. So, just as above, you'll run Docker Quickstart Terminal and type wharfee into your command prompt. After you hit Enter, you'll see wharfee prompt:

wharfee>

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

To enter debugger on error, use the following command:

$ behave -D DEBUG_ON_ERROR

Thanks

I develop with PyCharm

About

A CLI with autocompletion and syntax highlighting for Docker commands.

Resources

License

You can’t perform that action at this time.