Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/j-bennet/wharfee

A CLI with autocompletion and syntax highlighting for Docker commands.
https://github.com/j-bennet/wharfee

Last synced: 5 days ago
JSON representation

A CLI with autocompletion and syntax highlighting for Docker commands.

Host: GitHub
URL: https://github.com/j-bennet/wharfee
Owner: j-bennet
License: bsd-3-clause
Created: 2015-04-16T18:53:35.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2022-01-20T14:51:04.000Z (almost 3 years ago)
Last Synced: 2024-04-11T08:32:03.221Z (8 months ago)
Language: Python
Size: 3.83 MB
Stars: 653
Watchers: 31
Forks: 40
Open Issues: 23
Metadata Files:
- Readme: README.md
- Changelog: changelog.rst
- License: LICENSE.txt

Awesome Lists containing this project

awesome-docker - wharfee - Autocompletion and syntax highlighting for Docker commands. by [@j-bennet](https://github.com/j-bennet) (Container Operations / User Interface)
awesome-docker - wharfee - :skull: Autocompletion and syntax highlighting for Docker commands. by [@j-bennet](https://github.com/j-bennet) (Container Operations / User Interface)

README

        [![Stories in Ready](https://badge.waffle.io/j-bennet/wharfee.png?label=ready&title=Ready)](https://waffle.io/j-bennet/wharfee)

[![PyPI version](https://badge.fury.io/py/wharfee.svg)](http://badge.fury.io/py/wharfee)

[![Join the chat at https://gitter.im/j-bennet/wharfee](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/j-bennet/wharfee?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Is this still maintained?

I love wharfee, and I don't want it to die, that's why it's still on github. But the project didn't pick up any new contributors, and I don't currently have the time to maintain it. If you're interested in taking over and maintaining wharfee, let me know. If you want to sponsor maintaining wharfee, let me know as well.

# wharfee

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

![ps](screenshots/wharfee-demo.gif)

## Why?

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

![ps](screenshots/ps-containers.png)

Container names are hard to remember and type.

![rm](screenshots/rm-containers.png)

Same goes for image names.

![rmi](screenshots/rmi-images.png)

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](screenshots/rmi-all-dangling.png)

Boom! How about removing all stopped containers?

![rm-stopped](screenshots/rm-all-stopped.png)

## 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?

* To talk to Docker: [docker-py](https://github.com/docker/docker-py).

* To power the CLI: [Python Prompt Toolkit](http://github.com/jonathanslenders/python-prompt-toolkit).

* To format the output: [tabulate](https://pypi.python.org/pypi/tabulate).

* To print out the output: [Click](http://click.pocoo.org/3/).

## Can I contribute?

Yes! Pull request or [issues](https://github.com/j-bennet/wharfee/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](screenshots/icon_PyCharm.png)](https://www.jetbrains.com/pycharm/)