blob: df9a1513edfa7825d465ffd0ba0b3c259dacfe91 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
cmd2
====
.. default-domain:: py
.. _cmd: https://docs.python.org/3/library/cmd.html
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
2. Instantiate ``App`` and start the command loop::
app = App()
app.cmdloop()
Overview
--------
[create links with short descriptions to the various overview pages here]
.. toctree::
:maxdepth: 2
:hidden:
:caption: Overview
overview/featuretour
overview/installation
overview/alternatives
overview/resources
examples/quickstart
Migrating from cmd
------------------
[create links with short descriptions to the various migrating pages here]
.. toctree::
:maxdepth: 2
:hidden:
:caption: Migrating from cmd
migrating/why
migrating/incompatibilities
migrating/minimum
migrating/free_features
migrating/nextsteps
Features
--------
[create links with short descriptions to the various feature pages here]
.. toctree::
:maxdepth: 2
:hidden:
:caption: Features
features/generating_output
features/argument_processing
features/prompt
features/help
features/history
features/startup_commands
features/shortcuts_aliases_macros
features/settings
features/completion
features/os
features/multiline
features/disable_commands
features/clipboard
features/transcript
features/hooks
features/plugins
features/scripting
features/embedded_python_shells
Examples
--------------------
[create links with short descriptions to the various examples pages here]
.. toctree::
:maxdepth: 2
:hidden:
:caption: Examples
examples/quickstart
API Reference
-------------
.. toctree::
:maxdepth: 2
:hidden:
:caption: API Reference
api/cmd
api/decorators
api/exceptions
api/utility_functions
api/utility_classes
Meta
----
.. toctree::
:maxdepth: 2
:hidden:
:caption: Meta
doc_conventions
To Be Integrated
----------------
Files from old documentation to be integrated into new structure
.. toctree::
:maxdepth: 2
:hidden:
:caption: To Be Integrated
freefeatures
integrating
settingchanges
unfreefeatures
|
