cmd2

A python package for building powerful command-line interpreter (CLI) programs. Extends the Python Standard Library's cmd package.

The basic use of cmd2 is identical to that of cmd.

1. Create a subclass of cmd2.Cmd. Define attributes and do_* methods to control its behavior. Throughout this documentation, we will assume that you are naming your subclass App:

from cmd2 import Cmd
class App(Cmd):
   # customized attributes and methods here

1. Instantiate App and start the command loop:

from cmd2 import Cmd
class App(Cmd):
   # customized attributes and methods here

app = App()
app.cmdloop()

Getting Started

{% include-markdown "./overview/index.md" %}

Migrating from cmd

{% include-markdown "./migrating/index.md" %}

Features

{% include-markdown "./features/index.md" start="" end="" %}

Examples

{% include-markdown "./examples/index.md" start="" end="" %}

Plugins

{% include-markdown "./plugins/index.md" start="" end="" %}

Testing

API Reference

Meta

Documentation Conventions