Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

cmd2 - a tool for building interactive command line applications in Python

Project description

cmd2 is a tool for building interactive command line applications in Python. Its goal is to make it quick and easy for developers to build feature-rich and user-friendly interactive command line applications. It provides a simple API which is an extension of Python’s built-in cmd module. cmd2 provides a wealth of features on top of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary when using cmd.

The latest documentation for cmd2 can be read online here:

Main features:

  • Searchable command history (history command and <Ctrl>+r)
  • Text file scripting of your application with load (@) and _relative_load (@@)
  • Python scripting of your application with pyscript
  • Run shell commands with !
  • Pipe command output to shell commands with |
  • Redirect command output to file with >, >>; input from file with <
  • Bare >, >> with no filename send output to paste buffer (clipboard)
  • py enters interactive Python console (opt-in ipy for IPython console)
  • Multi-line, case-insensitive, and abbreviated commands
  • Special-character command shortcuts (beyond cmd’s @ and !)
  • Settable environment parameters
  • Parsing commands with flags
  • Unicode character support (Python 3 only)
  • Good tab-completion of commands, file system paths, and shell commands
  • Python 2.7 and 3.4+ support
  • Linux, macOS and Windows support
  • Trivial to provide built-in help for all commands
  • Built-in regression testing framework for your applications (transcript-based testing)

Usable without modification anywhere cmd is used; simply import cmd2.Cmd in place of cmd.Cmd.

Release history Release notifications

This version
History Node


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
cmd2-0.8.0.tar.gz (75.0 kB) Copy SHA256 hash SHA256 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