summaryrefslogtreecommitdiff
path: root/docs/overview/summary.rst
blob: d6d7abb681499351336b04411d0bd53f0882ae03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

.. _cmd: https://docs.python.org/3/library/cmd.html

Building a new `REPL <https://en.wikipedia.org/wiki/Read–eval–print_loop>`_ or
`Command Line Interface <https://en.wikipedia.org/wiki/Command-line_interface>`_
application?

Already built an application that uses cmd_ from the python standard library and
want to add more functionality with very little work?

``cmd2`` is a powerful python library for built command line applications. Start
here to find out if this library is a good fit for your needs.

* :ref:`overview/featuretour:Feature Highlights` - a quick tour of a few of the
  features in ``cmd2``, for both developers and users
* :ref:`examples/example:Simple Application` - a sample application showing 5 key features of ``cmd2``
* :ref:`overview/installation:Installation Instructions` - how to install
  ``cmd2`` and associated optional dependencies
* :ref:`overview/integrating:Integrate cmd2 Into Your Project` - adding ``cmd2``
  to your project
* :ref:`overview/alternatives:Alternatives` - other python packages that might
  meet your needs
* :ref:`overview/resources:Resources` - related links and other materials