Usage
Installation
Getting Started
Commands
Parameters
Default Parameter
Groups
Parameter Validators
Group Validators
Help
Version
Shell Completion
Coercion Rules
Text Editor
API
CLI Reference
Known Issues
Advanced Usage
Lazy Loading
Help Customization
User Classes
Args & Kwargs
Config Files
Sphinx Integration
MkDocs Integration
Packaging
App Calling & Return Values
Meta App
Command Chaining
AutoRegistry
Cookbook
App Upgrade
Dataclass Commands
Interactive Shell & Help
Rich Formatted Exceptions
Sharing Parameters
Unit Testing
Reading/Writing From File or Stdin/Stdout
Random Tips
Migration
Migrating From Typer
Alternative Libraries
Typer Comparison
Fire Comparison
Arguably Comparison
cyclopts
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
_
__call__() (cyclopts.App method)
(cyclopts.help.AsteriskRenderer method)
(cyclopts.help.DefaultFormatter method)
(cyclopts.help.DescriptionRenderer method)
(cyclopts.help.NameRenderer method)
(cyclopts.help.PlainFormatter method)
(cyclopts.help.protocols.ColumnSpecBuilder method)
(cyclopts.help.protocols.HelpFormatter method)
(cyclopts.Parameter method)
__contains__() (cyclopts.ArgumentCollection method)
__getitem__() (cyclopts.App method)
__iter__() (cyclopts.App method)
A
accepts_keys (cyclopts.Parameter attribute)
actual_count (cyclopts.ConsumeMultipleError attribute)
alias (cyclopts.App attribute)
(cyclopts.Parameter attribute)
all_options (cyclopts.help.HelpEntry property)
all_or_none (in module cyclopts.validators)
allow_leading_hyphen (cyclopts.Parameter attribute)
allow_repeating (cyclopts.Parameter attribute)
allow_unknown (cyclopts.config.Dict attribute)
(cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
App (class in cyclopts)
app (cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
append() (cyclopts.Argument method)
Argument (class in cyclopts)
argument (cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
argument_collection (cyclopts.UnknownOptionError attribute)
ArgumentCollection (class in cyclopts)
assemble_argument_collection() (cyclopts.App method)
AsteriskRenderer (class in cyclopts.help)
B
backend (cyclopts.App attribute)
BinPath (in module cyclopts.types)
border_style (cyclopts.help.PanelSpec attribute)
(cyclopts.help.TableSpec attribute)
box (cyclopts.help.PanelSpec attribute)
(cyclopts.help.TableSpec attribute)
build() (cyclopts.help.PanelSpec method)
(cyclopts.help.TableSpec method)
C
caption (cyclopts.help.TableSpec attribute)
children (cyclopts.Argument attribute)
children_recursive (cyclopts.Argument property)
choices (cyclopts.help.HelpEntry attribute)
CoercionError
collapse_padding (cyclopts.help.TableSpec attribute)
column_specs (cyclopts.help.DefaultFormatter attribute)
ColumnSpec (class in cyclopts.help)
ColumnSpecBuilder (class in cyclopts.help.protocols)
combine() (cyclopts.Parameter class method)
CombinedShortOptionError
command (cyclopts.config.Env attribute)
command() (cyclopts.App method)
command_chain (cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
CommandCollisionError
config (cyclopts.App attribute)
console (cyclopts.App attribute)
(cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
consume_multiple (cyclopts.Parameter attribute)
ConsumeMultipleError
convert() (cyclopts.Argument method)
convert_and_validate() (cyclopts.Argument method)
converter (cyclopts.Parameter attribute)
copy() (cyclopts.ArgumentCollection method)
(cyclopts.help.ColumnSpec method)
(cyclopts.help.HelpEntry method)
(cyclopts.help.HelpPanel method)
(cyclopts.help.PanelSpec method)
(cyclopts.help.TableSpec method)
count (cyclopts.Parameter attribute)
create_ordered() (cyclopts.Group class method)
CsvPath (in module cyclopts.types)
cyclopts.types.StdioPath (built-in class)
CycloptsError
CycloptsPanel (class in cyclopts)
D
data (cyclopts.config.Dict attribute)
default (cyclopts.help.HelpEntry attribute)
default() (cyclopts.App method)
(cyclopts.Parameter class method)
default_name_transform() (in module cyclopts)
default_parameter (cyclopts.App attribute)
(cyclopts.Group attribute)
DefaultFormatter (class in cyclopts.help)
description (cyclopts.help.HelpEntry attribute)
(cyclopts.help.HelpPanel attribute)
DescriptionRenderer (class in cyclopts.help)
Dict (class in cyclopts.config)
dir_okay (cyclopts.validators.Path attribute)
Directory (in module cyclopts.types)
E
edit() (in module cyclopts)
EditorDidNotChangeError
EditorDidNotSaveError
EditorError
EditorNotFoundError
Email (in module cyclopts.types)
end_of_options_delimiter (cyclopts.App attribute)
entries (cyclopts.help.HelpPanel attribute)
Env (class in cyclopts.config)
env_var (cyclopts.help.HelpEntry attribute)
(cyclopts.Parameter attribute)
env_var_split (cyclopts.Parameter attribute)
env_var_split() (cyclopts.Argument method)
(in module cyclopts)
error_console (cyclopts.App attribute)
error_formatter (cyclopts.App attribute)
exception_message (cyclopts.ValidationError attribute)
ExistingBinPath (in module cyclopts.types)
ExistingCsvPath (in module cyclopts.types)
ExistingDirectory (in module cyclopts.types)
ExistingFile (in module cyclopts.types)
ExistingImagePath (in module cyclopts.types)
ExistingJsonPath (in module cyclopts.types)
ExistingMp4Path (in module cyclopts.types)
ExistingPath (in module cyclopts.types)
ExistingTomlPath (in module cyclopts.types)
ExistingTxtPath (in module cyclopts.types)
ExistingYamlPath (in module cyclopts.types)
exists (cyclopts.validators.Path attribute)
exit_on_error (cyclopts.App attribute)
expand (cyclopts.help.PanelSpec attribute)
(cyclopts.help.TableSpec attribute)
ext (cyclopts.validators.Path attribute)
F
field_info (cyclopts.Argument attribute)
FieldInfo (class in cyclopts.field_info)
File (in module cyclopts.types)
file_okay (cyclopts.validators.Path attribute)
filter_by() (cyclopts.ArgumentCollection method)
footer (cyclopts.help.ColumnSpec attribute)
footer_style (cyclopts.help.ColumnSpec attribute)
(cyclopts.help.TableSpec attribute)
format (cyclopts.help.HelpPanel attribute)
G
generate_completion() (cyclopts.App method)
generate_docs() (cyclopts.App method)
get() (cyclopts.ArgumentCollection method)
get_choices() (cyclopts.Argument method)
Group (class in cyclopts)
group (cyclopts.App attribute)
(cyclopts.Parameter attribute)
(cyclopts.ValidationError attribute)
group_arguments (cyclopts.App attribute)
group_commands (cyclopts.App attribute)
group_parameters (cyclopts.App attribute)
groups (cyclopts.ArgumentCollection property)
gt (cyclopts.validators.Number attribute)
gte (cyclopts.validators.Number attribute)
H
has_tokens (cyclopts.Argument property)
header (cyclopts.help.ColumnSpec attribute)
header_style (cyclopts.help.ColumnSpec attribute)
(cyclopts.help.TableSpec attribute)
height (cyclopts.help.PanelSpec attribute)
help (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
help_epilogue (cyclopts.App attribute)
help_flags (cyclopts.App attribute)
help_format (cyclopts.App attribute)
help_formatter (cyclopts.App attribute)
(cyclopts.Group attribute)
help_on_error (cyclopts.App attribute)
help_print() (cyclopts.App method)
help_prologue (cyclopts.App attribute)
HelpEntry (class in cyclopts.help)
HelpFormatter (class in cyclopts.help.protocols)
HelpPanel (class in cyclopts.help)
HexUInt16 (in module cyclopts.types)
HexUInt32 (in module cyclopts.types)
HexUInt64 (in module cyclopts.types)
HexUInt8 (in module cyclopts.types)
highlight (cyclopts.help.ColumnSpec attribute)
(cyclopts.help.PanelSpec attribute)
hint (cyclopts.Argument attribute)
I
ImagePath (in module cyclopts.types)
implicit_value (cyclopts.Token attribute)
index (cyclopts.Argument attribute)
(cyclopts.Token attribute)
install_completion() (cyclopts.App method)
Int16 (in module cyclopts.types)
Int32 (in module cyclopts.types)
Int64 (in module cyclopts.types)
Int8 (in module cyclopts.types)
interactive_shell() (cyclopts.App method)
is_flag() (cyclopts.Argument method)
is_positional_only() (cyclopts.Argument method)
is_stdio (cyclopts.types.StdioPath attribute)
is_var_positional() (cyclopts.Argument method)
J
Json (class in cyclopts.config)
(in module cyclopts.types)
json_dict (cyclopts.Parameter attribute)
json_list (cyclopts.Parameter attribute)
JsonPath (in module cyclopts.types)
justify (cyclopts.help.ColumnSpec attribute)
K
keys (cyclopts.Argument attribute)
(cyclopts.Token attribute)
keyword (cyclopts.MissingArgumentError attribute)
(cyclopts.RequiresEqualsError attribute)
(cyclopts.Token attribute)
L
LimitedChoice (class in cyclopts.validators)
lt (cyclopts.validators.Number attribute)
lte (cyclopts.validators.Number attribute)
M
match() (cyclopts.Argument method)
(cyclopts.ArgumentCollection method)
max_allowed (cyclopts.ConsumeMultipleError attribute)
max_width (cyclopts.help.ColumnSpec attribute)
min_required (cyclopts.ConsumeMultipleError attribute)
min_width (cyclopts.help.ColumnSpec attribute)
(cyclopts.help.TableSpec attribute)
MissingArgumentError
MixedArgumentError
modulo (cyclopts.validators.Number attribute)
Mp4Path (in module cyclopts.types)
msg (cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
must_exist (cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
mutually_exclusive (in module cyclopts.validators)
MutuallyExclusive (class in cyclopts.validators)
N
n_tokens (cyclopts.Parameter attribute)
name (cyclopts.App attribute)
(cyclopts.Argument property)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
name_transform (cyclopts.App attribute)
(cyclopts.Parameter attribute)
NameRenderer (class in cyclopts.help)
names (cyclopts.Argument property)
(cyclopts.help.HelpEntry property)
negative (cyclopts.Parameter attribute)
negative_bool (cyclopts.Parameter attribute)
negative_iterable (cyclopts.Parameter attribute)
negative_names (cyclopts.help.HelpEntry attribute)
negative_none (cyclopts.Parameter attribute)
negative_shorts (cyclopts.help.HelpEntry attribute)
NegativeFloat (in module cyclopts.types)
NegativeInt (in module cyclopts.types)
negatives (cyclopts.Argument property)
no_wrap (cyclopts.help.ColumnSpec attribute)
NonExistentBinPath (in module cyclopts.types)
NonExistentCsvPath (in module cyclopts.types)
NonExistentDirectory (in module cyclopts.types)
NonExistentFile (in module cyclopts.types)
NonExistentImagePath (in module cyclopts.types)
NonExistentJsonPath (in module cyclopts.types)
NonExistentMp4Path (in module cyclopts.types)
NonExistentPath (in module cyclopts.types)
NonExistentTomlPath (in module cyclopts.types)
NonExistentTxtPath (in module cyclopts.types)
NonExistentYamlPath (in module cyclopts.types)
NonNegativeFloat (in module cyclopts.types)
NonNegativeInt (in module cyclopts.types)
NonPositiveFloat (in module cyclopts.types)
NonPositiveInt (in module cyclopts.types)
NormFloat (in module cyclopts.types)
Number (class in cyclopts.validators)
O
overflow (cyclopts.help.ColumnSpec attribute)
P
pad_edge (cyclopts.help.TableSpec attribute)
padding (cyclopts.help.PanelSpec attribute)
(cyclopts.help.TableSpec attribute)
panel_spec (cyclopts.help.DefaultFormatter attribute)
PanelSpec (class in cyclopts.help)
Parameter (class in cyclopts)
parameter (cyclopts.Argument attribute)
parse (cyclopts.Argument property)
(cyclopts.Parameter attribute)
parse_args() (cyclopts.App method)
parse_commands() (cyclopts.App method)
parse_known_args() (cyclopts.App method)
Path (class in cyclopts.validators)
path (cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
PercentInt (in module cyclopts.types)
PlainFormatter (class in cyclopts.help)
Port (in module cyclopts.types)
positive_names (cyclopts.help.HelpEntry attribute)
positive_shorts (cyclopts.help.HelpEntry attribute)
PositiveFloat (in module cyclopts.types)
PositiveInt (in module cyclopts.types)
prefix (cyclopts.config.Env attribute)
print_error (cyclopts.App attribute)
R
ratio (cyclopts.help.ColumnSpec attribute)
register_install_completion_command() (cyclopts.App method)
render_description() (cyclopts.help.DefaultFormatter method)
(cyclopts.help.PlainFormatter method)
render_usage() (cyclopts.help.DefaultFormatter method)
(cyclopts.help.PlainFormatter method)
renderer (cyclopts.help.ColumnSpec attribute)
RepeatArgumentError
required (cyclopts.Argument property)
(cyclopts.help.HelpEntry attribute)
(cyclopts.Parameter attribute)
requires_equals (cyclopts.Parameter attribute)
RequiresEqualsError
ResolvedDirectory (in module cyclopts.types)
ResolvedExistingDirectory (in module cyclopts.types)
ResolvedExistingFile (in module cyclopts.types)
ResolvedExistingPath (in module cyclopts.types)
ResolvedFile (in module cyclopts.types)
ResolvedPath (in module cyclopts.types)
result_action (cyclopts.App attribute)
root_input_tokens (cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
root_keys (cyclopts.config.Dict attribute)
(cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
run() (in module cyclopts)
run_async() (cyclopts.App method)
S
safe_box (cyclopts.help.PanelSpec attribute)
(cyclopts.help.TableSpec attribute)
search_parents (cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
shorts (cyclopts.help.HelpEntry property)
show (cyclopts.App attribute)
(cyclopts.Argument property)
(cyclopts.config.Env attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
show_choices (cyclopts.Parameter attribute)
show_default (cyclopts.Argument property)
(cyclopts.Parameter attribute)
show_edge (cyclopts.help.TableSpec attribute)
show_env_var (cyclopts.Parameter attribute)
show_footer (cyclopts.help.TableSpec attribute)
show_header (cyclopts.help.TableSpec attribute)
show_lines (cyclopts.help.TableSpec attribute)
SignedNormFloat (in module cyclopts.types)
sort_key (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.help.HelpEntry attribute)
source (cyclopts.config.Dict attribute)
(cyclopts.config.Env attribute)
(cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
(cyclopts.Token attribute)
STDIO_STRING (cyclopts.types.StdioPath attribute)
style (cyclopts.help.ColumnSpec attribute)
(cyclopts.help.PanelSpec attribute)
(cyclopts.help.TableSpec attribute)
subtitle (cyclopts.help.PanelSpec attribute)
subtitle_align (cyclopts.help.PanelSpec attribute)
suppress_keyboard_interrupt (cyclopts.App attribute)
T
table_spec (cyclopts.help.DefaultFormatter attribute)
TableSpec (class in cyclopts.help)
target (cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
target_type (cyclopts.CoercionError attribute)
title (cyclopts.help.HelpPanel attribute)
(cyclopts.help.PanelSpec attribute)
(cyclopts.help.TableSpec attribute)
title_align (cyclopts.help.PanelSpec attribute)
Token (class in cyclopts)
token (cyclopts.CoercionError attribute)
(cyclopts.RepeatArgumentError attribute)
(cyclopts.UnknownOptionError attribute)
token_count() (cyclopts.Argument method)
tokens (cyclopts.Argument attribute)
tokens_so_far (cyclopts.MissingArgumentError attribute)
Toml (class in cyclopts.config)
TomlPath (in module cyclopts.types)
TxtPath (in module cyclopts.types)
type (cyclopts.help.HelpEntry attribute)
U
UInt16 (in module cyclopts.types)
UInt32 (in module cyclopts.types)
UInt64 (in module cyclopts.types)
UInt8 (in module cyclopts.types)
UnknownCommandError
UnknownOptionError
UNSET (class in cyclopts)
unused_tokens (cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
UnusedCliTokensError
update() (cyclopts.App method)
URL (in module cyclopts.types)
usage (cyclopts.App attribute)
use_commands_as_keys (cyclopts.config.Dict attribute)
(cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
V
validate() (cyclopts.Argument method)
ValidationError
validator (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
value (cyclopts.Argument property)
(cyclopts.Token attribute)
(cyclopts.ValidationError attribute)
verbose (cyclopts.App attribute)
(cyclopts.CycloptsError attribute)
(cyclopts.UnknownCommandError attribute)
version (cyclopts.App attribute)
version_flags (cyclopts.App attribute)
version_format (cyclopts.App attribute)
version_print() (cyclopts.App method)
vertical (cyclopts.help.ColumnSpec attribute)
W
width (cyclopts.help.ColumnSpec attribute)
(cyclopts.help.PanelSpec attribute)
(cyclopts.help.TableSpec attribute)
with_newline_metadata() (cyclopts.help.DefaultFormatter class method)
Y
Yaml (class in cyclopts.config)
YamlPath (in module cyclopts.types)