Skip to main content

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: https://cmd2.readthedocs.io/

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 commands

  • Special-character command shortcuts (beyond cmd’s ? and !)

  • Settable environment parameters

  • Parsing commands with arguments using argparse, including support for sub-commands

  • Unicode character support (Python 3 only)

  • Good tab-completion of commands, sub-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)

  • Transcripts for use with built-in regression can be automatically generated from history -t

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

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

cmd2-0.8.5.tar.gz (108.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cmd2-0.8.5-py2.py3-none-any.whl (51.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file cmd2-0.8.5.tar.gz.

File metadata

  • Download URL: cmd2-0.8.5.tar.gz
  • Upload date:
  • Size: 108.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cmd2-0.8.5.tar.gz
Algorithm Hash digest
SHA256 2ae9c397bcb8c4ca2a068002407238e56acfce3ed55e67bde35988a100adcdee
MD5 976b3e34d3aa084e27abd39e94416010
BLAKE2b-256 5cec63ac612859b7b243432891e2fc5f60016fd95e41af30ba8747978eb68f10

See more details on using hashes here.

File details

Details for the file cmd2-0.8.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for cmd2-0.8.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d8ddf10d6d0bb9b389401f61aabb36d166ba6050630afa3d88f8448a634f1399
MD5 308d9a95bb5b9a2172d435f7c7e4c22e
BLAKE2b-256 ee02faa35704449a68f18db39ee9a047e32c8b569e672daadfef3501259fe6bb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page