Welcome to click-shell’s documentation!

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.

click-shell is compatible with python versions 2.7, 3.5, 3.6, 3.7, and 3.8.

Features

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

Note

It should be noted that click-shell only alters functionality if no arguments are passed on the command line. Previously if no arguments were passed, the help was displayed.

• Installation
• Usage
  • Decorator
  • Factory Method
• Changelog
• Troubleshooting
  • Autocomplete