Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

An extension to click that easily turns your click app into a shell utility

Project Description

click-shell is an extension to click that easily turns your click app into a shell utility. It is built on top of the built in python cmd module, with modifications to make it work with click.


  • Adds a “shell” mode with command completion to any click app
  • Just a one line change for most click apps


Simply replace with on the root level command:

from click_shell import shell

#  # no longer
@shell(prompt='my-app > ', intro='Starting my app...')
def my_app():

def the_command():
    print 'the_command is running'


When run, you should expect an output like so:

$ python
Starting my app...
my-app >


It should be noted that this decorator only alters functionality if no arguments are passed on the command line. If you try to run a command directly (like python the_command in the above example), your app will function identically to how it did before.

For more advanced usage, check out our docs at

Release History

Release History

This version
History Node


History Node


History Node


History Node


History Node


Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
click_shell-1.0-py2.py3-none-any.whl (10.4 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Nov 29, 2016
click-shell-1.0.tar.gz (7.2 kB) Copy SHA256 Checksum SHA256 Source Nov 29, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting