Skip to main content

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

Project description

Build status Documentation Status

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

Project details

Download files

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

Files for click-shell, version 1.0
Filename, size & hash File type Python version Upload date
click_shell-1.0-py2.py3-none-any.whl (10.4 kB) View hashes Wheel py2.py3
click-shell-1.0.tar.gz (7.2 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page