cmd2
stable
Getting Started
Migrating From cmd
Features
Examples
Plugins
Testing
API Reference
Meta
Documentation Conventions
cmd2
Docs
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (cmd2.Cmd method)
(cmd2.parsing.StatementParser method)
(cmd2.table_creator.AlternatingTable method)
(cmd2.table_creator.BorderedTable method)
(cmd2.table_creator.Column method)
(cmd2.table_creator.SimpleTable method)
(cmd2.table_creator.TableCreator method)
(cmd2.utils.CustomCompletionSettings method)
(cmd2.utils.Settable method)
_action_get_choices_callable() (in module cmd2.argparse_custom)
_action_get_descriptive_header() (in module cmd2.argparse_custom)
_action_get_nargs_range() (in module cmd2.argparse_custom)
_action_get_suppress_tab_hint() (in module cmd2.argparse_custom)
_action_set_choices_provider() (in module cmd2.argparse_custom)
_action_set_completer() (in module cmd2.argparse_custom)
_action_set_descriptive_header() (in module cmd2.argparse_custom)
_action_set_nargs_range() (in module cmd2.argparse_custom)
_action_set_suppress_tab_hint() (in module cmd2.argparse_custom)
_ArgumentParser_get_ap_completer_type() (in module cmd2.argparse_custom)
_ArgumentParser_set_ap_completer_type() (in module cmd2.argparse_custom)
_SubParsersAction_remove_parser() (in module cmd2.argparse_custom)
A
add_settable() (cmd2.Cmd method)
(cmd2.command_definition.CommandSet method)
add_subparsers() (cmd2.argparse_custom.Cmd2ArgumentParser method)
aliases (cmd2.Cmd attribute)
align_center() (in module cmd2.utils)
align_left() (in module cmd2.utils)
align_right() (in module cmd2.utils)
align_text() (in module cmd2.utils)
allow_style (cmd2.Cmd attribute)
(in module cmd2.ansi)
AllowStyle (class in cmd2.ansi)
alphabetical_sort() (in module cmd2.utils)
ALPHABETICAL_SORT_KEY() (cmd2.Cmd method)
AlternatingTable (class in cmd2.table_creator)
always_prefix_settables (cmd2.Cmd attribute)
AnsiSequence (class in cmd2.ansi)
append() (cmd2.history.History method)
apply_border_color() (cmd2.table_creator.BorderedTable method)
apply_data_bg() (cmd2.table_creator.AlternatingTable method)
(cmd2.table_creator.BorderedTable method)
(cmd2.table_creator.SimpleTable method)
apply_header_bg() (cmd2.table_creator.BorderedTable method)
(cmd2.table_creator.SimpleTable method)
arg_list (cmd2.Statement attribute)
ArgListCommandFunc (in module cmd2.decorators)
ArgListCommandFuncBoolReturn (in module cmd2.decorators)
ArgListCommandFuncNoneReturn (in module cmd2.decorators)
ArgListCommandFuncOptionalBoolReturn (in module cmd2.decorators)
ArgparseCommandFunc (in module cmd2.decorators)
ArgparseCommandFuncBoolReturn (in module cmd2.decorators)
ArgparseCommandFuncNoneReturn (in module cmd2.decorators)
ArgparseCommandFuncOptionalBoolReturn (in module cmd2.decorators)
ArgparseCompleter (class in cmd2.argparse_completer)
args (cmd2.Statement attribute)
argv (cmd2.Statement attribute)
as_subcommand_to() (in module cmd2.decorators)
async_alert() (cmd2.Cmd method)
async_alert_str() (in module cmd2.ansi)
async_update_prompt() (cmd2.Cmd method)
B
BACK() (cmd2.ansi.Cursor static method)
base_width() (cmd2.table_creator.BorderedTable class method)
(cmd2.table_creator.SimpleTable class method)
basic_complete() (cmd2.Cmd method)
Bg (class in cmd2.ansi)
BgColor (class in cmd2.ansi)
BorderedTable (class in cmd2.table_creator)
BOTTOM (cmd2.table_creator.VerticalAlignment attribute)
build_settables() (cmd2.Cmd method)
ByteBuf (class in cmd2.utils)
C
categorize() (in module cmd2.utils)
CENTER (cmd2.table_creator.HorizontalAlignment attribute)
(cmd2.utils.TextAlignment attribute)
ChoicesCallable (class in cmd2.argparse_custom)
ChoicesProviderFuncBase (class in cmd2.argparse_custom)
ChoicesProviderFuncWithTokens (class in cmd2.argparse_custom)
clear() (cmd2.history.History method)
(cmd2.utils.StdSim method)
clear_line() (in module cmd2.ansi)
clear_screen() (in module cmd2.ansi)
Cmd (class in cmd2)
cmd2.ansi (module)
cmd2.argparse_completer (module)
cmd2.argparse_custom (module)
cmd2.clipboard (module)
cmd2.command_definition (module)
cmd2.constants (module)
cmd2.decorators (module)
cmd2.py_bridge (module)
Cmd2ArgparseError (class in cmd2.exceptions)
Cmd2ArgumentParser (class in cmd2.argparse_custom)
Cmd2AttributeWrapper (class in cmd2.argparse_custom)
Cmd2HelpFormatter (class in cmd2.argparse_custom)
cmd_func() (cmd2.Cmd method)
cmdloop() (cmd2.Cmd method)
Column (class in cmd2.table_creator)
columnize() (cmd2.Cmd method)
command (cmd2.Statement attribute)
command_and_args (cmd2.Statement attribute)
COMMAND_NAME (in module cmd2.constants)
CommandFinalizationData (class in cmd2.plugin)
CommandFunc (in module cmd2.command_definition)
CommandResult (class in cmd2.py_bridge)
COMMANDS (cmd2.utils.CompletionMode attribute)
CommandSet (class in cmd2.command_definition)
CommandSetRegistrationError (class in cmd2.exceptions)
complete() (cmd2.argparse_completer.ArgparseCompleter method)
(cmd2.Cmd method)
complete_help_command() (cmd2.Cmd method)
complete_help_subcommands() (cmd2.Cmd method)
complete_set_value() (cmd2.Cmd method)
complete_subcommand_help() (cmd2.argparse_completer.ArgparseCompleter method)
CompleterFuncBase (class in cmd2.argparse_custom)
CompleterFuncWithTokens (class in cmd2.argparse_custom)
CompletionError (class in cmd2.exceptions)
CompletionItem (class in cmd2.argparse_custom)
CompletionMode (class in cmd2.utils)
continuation_prompt (cmd2.Cmd attribute)
Cursor (class in cmd2.ansi)
CUSTOM (cmd2.utils.CompletionMode attribute)
CustomCompletionSettings (class in cmd2.utils)
D
data (cmd2.py_bridge.CommandResult attribute)
default() (cmd2.Cmd method)
DEFAULT_AP_COMPLETER (in module cmd2.argparse_completer)
DEFAULT_ARGUMENT_PARSER (in module cmd2.argparse_custom)
default_error (cmd2.Cmd attribute)
DEFAULT_SHORTCUTS (in module cmd2.constants)
delimiter_complete() (cmd2.Cmd method)
disable_category() (cmd2.Cmd method)
disable_command() (cmd2.Cmd method)
do__relative_run_script() (cmd2.Cmd method)
do_alias() (cmd2.Cmd method)
do_edit() (cmd2.Cmd method)
do_eof() (cmd2.Cmd method)
do_help() (cmd2.Cmd method)
do_history() (cmd2.Cmd method)
do_ipy() (cmd2.Cmd method)
do_macro() (cmd2.Cmd method)
do_py() (cmd2.Cmd method)
do_quit() (cmd2.Cmd method)
do_run_pyscript() (cmd2.Cmd method)
do_run_script() (cmd2.Cmd method)
do_set() (cmd2.Cmd method)
do_shell() (cmd2.Cmd method)
do_shortcuts() (cmd2.Cmd method)
DOWN() (cmd2.ansi.Cursor static method)
E
echo (cmd2.Cmd attribute)
EightBitBg (class in cmd2.ansi)
EightBitFg (class in cmd2.ansi)
enable_category() (cmd2.Cmd method)
enable_command() (cmd2.Cmd method)
error() (cmd2.argparse_custom.Cmd2ArgumentParser method)
expanded (cmd2.history.HistoryItem attribute)
expanded_command_line (cmd2.Statement attribute)
F
Fg (class in cmd2.ansi)
FgColor (class in cmd2.ansi)
find_commandset_for_command() (cmd2.Cmd method)
find_commandsets() (cmd2.Cmd method)
flag_based_complete() (cmd2.Cmd method)
format_help() (cmd2.argparse_completer.ArgparseCompleter method)
(cmd2.argparse_custom.Cmd2ArgumentParser method)
FORWARD() (cmd2.ansi.Cursor static method)
from_dict() (cmd2.history.HistoryItem static method)
(cmd2.Statement static method)
from_json() (cmd2.history.History static method)
G
generate_data_row() (cmd2.table_creator.AlternatingTable method)
(cmd2.table_creator.BorderedTable method)
(cmd2.table_creator.SimpleTable method)
generate_divider() (cmd2.table_creator.SimpleTable method)
generate_header() (cmd2.table_creator.BorderedTable method)
(cmd2.table_creator.SimpleTable method)
generate_header_bottom_border() (cmd2.table_creator.BorderedTable method)
generate_range_error() (in module cmd2.argparse_custom)
generate_row() (cmd2.table_creator.TableCreator method)
generate_row_bottom_border() (cmd2.table_creator.BorderedTable method)
generate_table() (cmd2.table_creator.AlternatingTable method)
(cmd2.table_creator.BorderedTable method)
(cmd2.table_creator.SimpleTable method)
generate_table_bottom_border() (cmd2.table_creator.BorderedTable method)
generate_table_top_border() (cmd2.table_creator.BorderedTable method)
get() (cmd2.argparse_custom.Cmd2AttributeWrapper method)
(cmd2.history.History method)
get_all_commands() (cmd2.Cmd method)
get_command_arg_list() (cmd2.parsing.StatementParser method)
get_help_topics() (cmd2.Cmd method)
get_names() (cmd2.Cmd method)
get_paste_buffer() (in module cmd2.clipboard)
get_value() (cmd2.utils.Settable method)
get_visible_commands() (cmd2.Cmd method)
getbytes() (cmd2.utils.StdSim method)
getvalue() (cmd2.utils.StdSim method)
H
help_error (cmd2.Cmd attribute)
History (class in cmd2.history)
history (cmd2.Cmd attribute)
HistoryItem (class in cmd2.history)
HorizontalAlignment (class in cmd2.table_creator)
I
idx (cmd2.history.HistoryItem attribute)
in_pyscript() (cmd2.Cmd method)
in_script() (cmd2.Cmd method)
index_based_complete() (cmd2.Cmd method)
intro (cmd2.Cmd attribute)
is_quoted() (in module cmd2.utils)
is_valid_command() (cmd2.parsing.StatementParser method)
isatty() (cmd2.utils.StdSim method)
L
LEFT (cmd2.table_creator.HorizontalAlignment attribute)
(cmd2.utils.TextAlignment attribute)
line_buffering (cmd2.utils.StdSim attribute)
M
MIDDLE (cmd2.table_creator.VerticalAlignment attribute)
multiline_command (cmd2.Statement attribute)
N
natural_sort() (in module cmd2.utils)
NATURAL_SORT_KEY() (cmd2.Cmd method)
NONE (cmd2.utils.CompletionMode attribute)
O
on_register() (cmd2.command_definition.CommandSet method)
on_registered() (cmd2.command_definition.CommandSet method)
on_unregister() (cmd2.command_definition.CommandSet method)
on_unregistered() (cmd2.command_definition.CommandSet method)
onecmd() (cmd2.Cmd method)
onecmd_plus_hooks() (cmd2.Cmd method)
orig_value (cmd2.argparse_custom.CompletionItem attribute)
output (cmd2.Statement attribute)
output_to (cmd2.Statement attribute)
P
parse() (cmd2.parsing.StatementParser method)
parse_command_only() (cmd2.parsing.StatementParser method)
parseline() (cmd2.Cmd method)
PassThroughException (class in cmd2.exceptions)
path_complete() (cmd2.Cmd method)
perror() (cmd2.Cmd method)
pexcept() (cmd2.Cmd method)
pfeedback() (cmd2.Cmd method)
pipe_to (cmd2.Statement attribute)
post_command (cmd2.Statement attribute)
postcmd() (cmd2.Cmd method)
PostcommandData (class in cmd2.plugin)
postloop() (cmd2.Cmd method)
PostparsingData (class in cmd2.plugin)
poutput() (cmd2.Cmd method)
ppaged() (cmd2.Cmd method)
pr() (cmd2.history.HistoryItem method)
precmd() (cmd2.Cmd method)
PrecommandData (class in cmd2.plugin)
preloop() (cmd2.Cmd method)
print_topics() (cmd2.Cmd method)
ProcReader (class in cmd2.utils)
prompt (cmd2.Cmd attribute)
pwarning() (cmd2.Cmd method)
py_bridge_name (cmd2.Cmd attribute)
PyBridge (class in cmd2.py_bridge)
Q
quote_specific_tokens() (in module cmd2.utils)
quote_string() (in module cmd2.utils)
quote_string_if_needed() (in module cmd2.utils)
R
raw (cmd2.history.HistoryItem attribute)
(cmd2.Statement attribute)
read() (cmd2.utils.StdSim method)
read_input() (cmd2.Cmd method)
readbytes() (cmd2.utils.StdSim method)
regex_search() (cmd2.history.History method)
register_argparse_argument_parameter() (in module cmd2.argparse_custom)
register_cmdfinalization_hook() (cmd2.Cmd method)
register_command_set() (cmd2.Cmd method)
register_postcmd_hook() (cmd2.Cmd method)
register_postloop_hook() (cmd2.Cmd method)
register_postparsing_hook() (cmd2.Cmd method)
register_precmd_hook() (cmd2.Cmd method)
register_preloop_hook() (cmd2.Cmd method)
remove_duplicates() (in module cmd2.utils)
remove_settable() (cmd2.Cmd method)
(cmd2.command_definition.CommandSet method)
RgbBg (class in cmd2.ansi)
RgbFg (class in cmd2.ansi)
RIGHT (cmd2.table_creator.HorizontalAlignment attribute)
(cmd2.utils.TextAlignment attribute)
run_editor() (cmd2.Cmd method)
runcmds_plus_hooks() (cmd2.Cmd method)
S
select() (cmd2.Cmd method)
send_sigint() (cmd2.utils.ProcReader method)
set() (cmd2.argparse_custom.Cmd2AttributeWrapper method)
set_default_ap_completer_type() (in module cmd2.argparse_completer)
set_default_argument_parser_type() (in module cmd2.argparse_custom)
SET_POS() (cmd2.ansi.Cursor static method)
set_title() (in module cmd2.ansi)
set_value() (cmd2.utils.Settable method)
set_window_title() (cmd2.Cmd static method)
Settable (class in cmd2.utils)
settable (cmd2.Cmd attribute)
settables (cmd2.Cmd attribute)
shell_cmd_complete() (cmd2.Cmd method)
sigint_handler() (cmd2.Cmd method)
SimpleTable (class in cmd2.table_creator)
SkipPostcommandHooks (class in cmd2.exceptions)
span() (cmd2.history.History method)
split_on_punctuation() (cmd2.parsing.StatementParser method)
start_session() (cmd2.history.History method)
Statement (class in cmd2)
statement (cmd2.history.HistoryItem attribute)
(cmd2.plugin.CommandFinalizationData attribute)
(cmd2.plugin.PostcommandData attribute)
(cmd2.plugin.PostparsingData attribute)
(cmd2.plugin.PrecommandData attribute)
statement_parser (cmd2.Cmd attribute)
StatementParser (class in cmd2.parsing)
stderr (cmd2.py_bridge.CommandResult attribute)
stdout (cmd2.py_bridge.CommandResult attribute)
StdSim (class in cmd2.utils)
stop (cmd2.plugin.CommandFinalizationData attribute)
(cmd2.plugin.PostcommandData attribute)
(cmd2.plugin.PostparsingData attribute)
(cmd2.py_bridge.CommandResult attribute)
str_search() (cmd2.history.History method)
strip_quotes() (in module cmd2.utils)
strip_style() (in module cmd2.ansi)
style() (in module cmd2.ansi)
style_aware_wcswidth() (in module cmd2.ansi)
style_aware_write() (in module cmd2.ansi)
style_error() (in module cmd2.ansi)
style_success() (in module cmd2.ansi)
style_warning() (in module cmd2.ansi)
suffix (cmd2.Statement attribute)
T
TableCreator (class in cmd2.table_creator)
terminate() (cmd2.utils.ProcReader method)
terminator (cmd2.Statement attribute)
TextAlignment (class in cmd2.utils)
TextStyle (class in cmd2.ansi)
to_bool() (in module cmd2.utils)
to_dict() (cmd2.history.HistoryItem method)
(cmd2.Statement method)
to_json() (cmd2.history.History method)
tokenize() (cmd2.parsing.StatementParser method)
tokens_for_completion() (cmd2.Cmd method)
TOP (cmd2.table_creator.VerticalAlignment attribute)
total_width() (cmd2.table_creator.BorderedTable method)
(cmd2.table_creator.SimpleTable method)
truncate() (cmd2.history.History method)
truncate_line() (in module cmd2.utils)
U
unquote_specific_tokens() (in module cmd2.utils)
unregister_command_set() (cmd2.Cmd method)
UP() (cmd2.ansi.Cursor static method)
V
VerticalAlignment (class in cmd2.table_creator)
visible_prompt (cmd2.Cmd attribute)
W
wait() (cmd2.utils.ProcReader method)
widest_line() (in module cmd2.ansi)
with_argparser() (in module cmd2.decorators)
with_argument_list() (in module cmd2.decorators)
with_category() (in module cmd2.decorators)
with_default_category() (in module cmd2.command_definition)
write() (cmd2.utils.ByteBuf method)
(cmd2.utils.StdSim method)
write_to_paste_buffer() (in module cmd2.clipboard)
Read the Docs
v: stable
Versions
latest
stable
2.4.3
2.4.2
2.4.1
2.4.0
2.3.3
2.3.2
2.3.1
2.3.0
2.2.0
2.1.2
2.1.1
2.1.0
2.0.1
2.0.0
1.5.0
1.4.0
1.3.11
1.3.10
1.3.9
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.0
1.0.2
1.0.1
1.0.0
0.10.1
0.10.0
0.9.25
0.9.24
0.9.23
0.9.22
0.9.21
0.9.20
0.9.19
0.9.18
0.9.17
0.9.16
0.9.15
0.9.14
0.9.13
0.9.12
0.9.11
0.9.10
0.9.9
0.9.8
0.9.7
0.9.6
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0.1
0.9.0
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.9
0.7.8
0.7.7
0.7.6
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.9
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.