recline
Contents:
Before getting started
Quickstart
Input and Output
Command Help and Man Pages
Tab Completion
Shell Behavior
Async Commands
Things To Do
API Reference
recline
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
action (recline.arg_types.flag.Flag attribute)
(recline.arg_types.recline_type.ReclineType attribute)
arg_name (recline.vendor.docstring_parser.parser.common.DocstringParam property)
ArgcompleteException
AsyncCommand (class in recline.commands.async_command)
auto (recline.vendor.docstring_parser.parser.Style attribute)
B
background() (recline.commands.async_command.AsyncCommand method)
BaseCompleter (class in recline.vendor.argcomplete.completers)
C
Choices (class in recline.arg_types.choices)
choices() (recline.arg_types.recline_type.ReclineType method)
ChoicesCompleter (class in recline.vendor.argcomplete.completers)
CLICommand (class in recline.commands.cli_command)
collect_completions() (recline.vendor.argcomplete.finders.CompletionFinder method)
command() (in module recline)
(in module recline.commands.cli_command)
command_help() (in module recline.commands.builtin_commands)
CommandBackgrounded
CommandCancelled
CommandCompleter (class in recline.repl.completer)
completer() (recline.arg_types.recline_type.ReclineType method)
(recline.repl.completer.CommandCompleter method)
CompletionFinder (class in recline.vendor.argcomplete.finders)
D
debug() (in module recline.commands.builtin_commands)
(in module recline.vendor.argcomplete.io)
DebugInterrupt
default_validator() (in module recline.vendor.argcomplete.finders)
define() (recline.arg_types.choices.Choices static method)
(recline.arg_types.positional.Positional static method)
(recline.arg_types.ranged_int.RangedInt static method)
(recline.arg_types.remainder.Remainder static method)
DirectoriesCompleter (class in recline.vendor.argcomplete.completers)
Docstring (class in recline.vendor.docstring_parser.parser.common)
DocstringExamples (class in recline.vendor.docstring_parser.parser.common)
DocstringMeta (class in recline.vendor.docstring_parser.parser.common)
DocstringParam (class in recline.vendor.docstring_parser.parser.common)
DocstringRaises (class in recline.vendor.docstring_parser.parser.common)
DocstringReturns (class in recline.vendor.docstring_parser.parser.common)
DocstringTypeMeta (class in recline.vendor.docstring_parser.parser.common)
E
examples (recline.vendor.docstring_parser.parser.common.Docstring property)
ExclusiveCompletionFinder (class in recline.vendor.argcomplete.finders)
execute() (in module recline.repl.shell)
exit_command() (in module recline.commands.builtin_commands)
F
fg() (in module recline.commands.builtin_commands)
FilesCompleter (class in recline.vendor.argcomplete.completers)
filter_completions() (recline.vendor.argcomplete.finders.CompletionFinder method)
Flag (class in recline.arg_types.flag)
foreground() (recline.commands.async_command.AsyncCommand method)
format_output() (recline.formatters.output_formatter.OutputFormatter method)
(recline.formatters.table_formatter.TableFormat method)
from_meta() (recline.vendor.docstring_parser.parser.common.DocstringMeta class method)
G
generate_help_text() (in module recline.commands.man_utils)
get_annotation_type() (in module recline.commands.cli_command)
get_arg_action() (recline.commands.cli_command.CLICommand method)
get_arg_description() (recline.commands.cli_command.CLICommand method)
get_arg_help() (recline.commands.cli_command.CLICommand method)
get_arg_metavar() (recline.commands.cli_command.CLICommand method)
get_command_help() (recline.commands.cli_command.CLICommand method)
get_command_name() (recline.repl.completer.CommandCompleter static method)
get_command_usage() (recline.commands.cli_command.CLICommand method)
get_display_completions() (recline.vendor.argcomplete.finders.CompletionFinder method)
google (recline.vendor.docstring_parser.parser.Style attribute)
H
hidden (recline.commands.cli_command.CLICommand property)
M
man() (in module recline.commands.builtin_commands)
man_commands() (in module recline.commands.builtin_commands)
match_command_hook() (in module recline.repl.completer)
metavar (recline.arg_types.recline_type.ReclineType attribute)
module
recline
recline.arg_types
recline.arg_types.choices
recline.arg_types.flag
recline.arg_types.positional
recline.arg_types.ranged_int
recline.arg_types.recline_type
recline.arg_types.recline_type_error
recline.arg_types.remainder
recline.commands
recline.commands.async_command
recline.commands.builtin_commands
recline.commands.cli_command
recline.commands.man_utils
recline.formatters
recline.formatters.output_formatter
recline.formatters.table_formatter
recline.repl
recline.repl.completer
recline.repl.shell
recline.vendor
recline.vendor.argcomplete
recline.vendor.argcomplete.completers
recline.vendor.argcomplete.exceptions
recline.vendor.argcomplete.finders
recline.vendor.argcomplete.io
recline.vendor.argcomplete.lexers
recline.vendor.argcomplete.packages
recline.vendor.argcomplete.shell_integration
recline.vendor.docstring_parser
recline.vendor.docstring_parser.parser
recline.vendor.docstring_parser.parser.common
recline.vendor.docstring_parser.parser.google
recline.vendor.docstring_parser.parser.rest
mute_stderr() (in module recline.vendor.argcomplete.io)
mute_stdout() (in module recline.vendor.argcomplete.io)
N
name (recline.vendor.docstring_parser.parser.common.DocstringExamples property)
nargs() (recline.arg_types.recline_type.ReclineType method)
(recline.arg_types.remainder.Remainder method)
O
OutputFormatter (class in recline.formatters.output_formatter)
P
params (recline.vendor.docstring_parser.parser.common.Docstring property)
parse() (in module recline.vendor.docstring_parser.parser)
(in module recline.vendor.docstring_parser.parser.google)
(in module recline.vendor.docstring_parser.parser.rest)
ParseError
Positional (class in recline.arg_types.positional)
print_columns() (in module recline.repl.completer)
print_help() (recline.commands.cli_command.CLICommand method)
Q
quote_completions() (recline.vendor.argcomplete.finders.CompletionFinder method)
R
raises (recline.vendor.docstring_parser.parser.common.Docstring property)
RangedInt (class in recline.arg_types.ranged_int)
recline
module
recline.arg_types
module
recline.arg_types.choices
module
recline.arg_types.flag
module
recline.arg_types.positional
module
recline.arg_types.ranged_int
module
recline.arg_types.recline_type
module
recline.arg_types.recline_type_error
module
recline.arg_types.remainder
module
recline.commands
module
recline.commands.async_command
module
recline.commands.builtin_commands
module
recline.commands.cli_command
module
recline.commands.man_utils
module
recline.formatters
module
recline.formatters.output_formatter
module
recline.formatters.table_formatter
module
recline.repl
module
recline.repl.completer
module
recline.repl.shell
module
recline.vendor
module
recline.vendor.argcomplete
module
recline.vendor.argcomplete.completers
module
recline.vendor.argcomplete.exceptions
module
recline.vendor.argcomplete.finders
module
recline.vendor.argcomplete.io
module
recline.vendor.argcomplete.lexers
module
recline.vendor.argcomplete.packages
module
recline.vendor.argcomplete.shell_integration
module
recline.vendor.docstring_parser
module
recline.vendor.docstring_parser.parser
module
recline.vendor.docstring_parser.parser.common
module
recline.vendor.docstring_parser.parser.google
module
recline.vendor.docstring_parser.parser.rest
module
ReclineCommandError
ReclineType (class in recline.arg_types.recline_type)
ReclineTypeError
relax() (in module recline)
(in module recline.repl.shell)
Remainder (class in recline.arg_types.remainder)
rest (recline.vendor.docstring_parser.parser.Style attribute)
returns (recline.vendor.docstring_parser.parser.common.Docstring property)
rl_complete() (recline.vendor.argcomplete.finders.CompletionFinder method)
run() (recline.commands.async_command.AsyncCommand method)
run_one_command() (in module recline.repl.shell)
S
set_terminal_echo() (in module recline.commands.async_command)
setup_tab_complete() (in module recline.repl.shell)
shellcode() (in module recline.vendor.argcomplete.shell_integration)
split_line() (in module recline.vendor.argcomplete.lexers)
stop() (recline.commands.async_command.AsyncCommand method)
Style (class in recline.vendor.docstring_parser.parser)
suppress() (recline.vendor.argcomplete.completers.SuppressCompleter method)
SuppressCompleter (class in recline.vendor.argcomplete.completers)
T
TableFormat (class in recline.formatters.table_formatter)
track_command_history() (in module recline.repl.shell)
type_name (recline.vendor.docstring_parser.parser.common.DocstringParam property)
(recline.vendor.docstring_parser.parser.common.DocstringTypeMeta property)
U
UniqueParam (class in recline.arg_types.recline_type)
V
validate() (recline.arg_types.recline_type.ReclineType method)
W
warn() (in module recline.vendor.argcomplete.io)
wrapped_string() (in module recline.commands.man_utils)