Eager to get started? This page gives a good introduction in how to get started with Terminal. This assumes you already have Terminal installed. If you do not, head over to the Installation section.

First, make sure that:

Let’s get started with some simple examples.

Play with colors

Terminal would be better if it is colorful.

Begin by importing the Terminal module:

>>> import terminal

Now, let’s play with the colors:

>>> print(terminal.red('red color'))
>>> print(terminal.green_bg('green background'))

Available colors:

black, red, green, yellow, blue, magenta, cyan, white

Available styles:

bold, faint, italic, underline, blink, overline, inverse
conceal, strike


But don’t count on these styles, your terminal may be not able to show all of them.

Verbose logging

Terminal programs need a simple and beautiful logging system. If it has a verbose feature, it could help a lot:

>>> from terminal import log

Now, let’s play with the verbose log:

>>> log.info('play with the log')
>>> log.verbose.info('a verbose log will not show')
>>> log.config(verbose=True)
>>> log.verbose.info('a verbose log will show')

We can also control the logging level:

>>> log.config(quiet=True)
>>> log.info('info log will not show')
>>> log.warn('but warn and error messages will show')

Prompt communication

Many terminal programs will communicate with the users, this could be easy with prompt().

Let’s create a prompt to ask the user’s name:

import terminal

username = terminal.prompt('what is your name')

We could set a default name for the user:

username = terminal.prompt('what is your name', 'Kate')

It is not a good idea to get a password with prompt(), instead, terminal provided a password() for you:

password = terminal.password('what is your password')

Want more on prompt?

We have terminal.confirm() and terminal.choose().

Command line

This is a replacement for argparse (or optparse).

Create a simple command parser with Command:

program = Command('foo', 'a description')

Add some options:

program.option('-f, --force', 'force to process')
program.option('-o, --output [output]', 'the output directory')

Let’s make it work:


if program.output:
   print program.output

Save the code in a file (for example foo.py), play in the terminal:

$ python foo.py -h
$ python foo.py -o src
$ python foo.py --output=src
$ python foo.py --output src

However, when creating a terminal tool, a subcommand is usually needed, we can add subcommands via Command.action():

program = Command('foo', 'a description')
program.option('-v, --verbose', 'show more logs')

subcommand = Command('build', 'build the site')
subcommand.option('-o, --output [output]', 'the output directory')



if program.verbose:

Let’s play with the more complex one:

$ python foo.py -h
$ python foo.py build -h

Ready for more? Check out the Advanced Usage section.