Usage
Installation
Getting Started
Commands
Parameters
Default Parameter
Groups
Parameter Validators
Group Validators
Help
Version
Coercion Rules
Text Editor
API
Advanced Usage
User Classes
Args & Kwargs
Config Files
Packaging
App Calling & Return Values
Meta App
Command Chaining
AutoRegistry
Cookbook
App Upgrade
Interactive Shell & Help
Rich Formatted Exceptions
Sharing Parameters
Unit Testing
Reading/Writing From File or Stdin/Stdout
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
|
P
|
R
|
S
|
T
|
U
|
V
|
Y
_
__call__() (cyclopts.App method)
(cyclopts.Parameter method)
__getitem__() (cyclopts.App method)
__iter__() (cyclopts.App method)
A
accepts_keys (cyclopts.Parameter attribute)
allow_leading_hyphen (cyclopts.Parameter attribute)
allow_unknown (cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
App (class in cyclopts)
app (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
append() (cyclopts.Argument method)
Argument (class in cyclopts)
argument (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
argument_collection (cyclopts.UnknownOptionError attribute)
ArgumentCollection (class in cyclopts)
assemble_argument_collection() (cyclopts.App method)
B
BinPath (in module cyclopts.types)
C
children (cyclopts.Argument attribute)
children_recursive (cyclopts.Argument property)
CoercionError
combine() (cyclopts.Parameter class method)
command (cyclopts.config.Env attribute)
command() (cyclopts.App method)
command_chain (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
CommandCollisionError
config (cyclopts.App attribute)
console (cyclopts.App attribute)
(cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
consume_multiple (cyclopts.Parameter attribute)
convert() (cyclopts.Argument method)
convert_and_validate() (cyclopts.Argument method)
converter (cyclopts.Parameter attribute)
copy() (cyclopts.ArgumentCollection method)
create_ordered() (cyclopts.Group class method)
CsvPath (in module cyclopts.types)
CycloptsError
D
default() (cyclopts.App method)
(cyclopts.Parameter class method)
default_name_transform() (in module cyclopts)
default_parameter (cyclopts.App attribute)
(cyclopts.Group attribute)
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)
Env (class in cyclopts.config)
env_var (cyclopts.Parameter attribute)
env_var_split (cyclopts.Parameter attribute)
env_var_split() (cyclopts.Argument method)
(in module cyclopts)
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)
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)
G
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)
help (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
help_flags (cyclopts.App attribute)
help_format (cyclopts.App attribute)
help_on_error (cyclopts.App attribute)
help_print() (cyclopts.App method)
hint (cyclopts.Argument attribute)
I
ImagePath (in module cyclopts.types)
implicit_value (cyclopts.Token attribute)
index (cyclopts.Argument attribute)
(cyclopts.Token attribute)
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)
InvalidCommandError
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)
K
keys (cyclopts.Argument attribute)
(cyclopts.Token attribute)
keyword (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)
MissingArgumentError
MixedArgumentError
modulo (cyclopts.validators.Number attribute)
Mp4Path (in module cyclopts.types)
msg (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
must_exist (cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
MutuallyExclusive (class in cyclopts.validators)
N
name (cyclopts.App attribute)
(cyclopts.Argument property)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
name_transform (cyclopts.App attribute)
(cyclopts.Parameter attribute)
names (cyclopts.Argument property)
negative (cyclopts.Parameter attribute)
negative_bool (cyclopts.Parameter attribute)
negative_iterable (cyclopts.Parameter attribute)
NegativeFloat (in module cyclopts.types)
NegativeInt (in module cyclopts.types)
negatives (cyclopts.Argument property)
NonNegativeFloat (in module cyclopts.types)
NonNegativeInt (in module cyclopts.types)
NonPositiveFloat (in module cyclopts.types)
NonPositiveInt (in module cyclopts.types)
Number (class in cyclopts.validators)
P
Parameter (class in cyclopts)
parameter (cyclopts.Argument attribute)
parse (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)
Port (in module cyclopts.types)
PositiveFloat (in module cyclopts.types)
PositiveInt (in module cyclopts.types)
prefix (cyclopts.config.Env attribute)
R
RepeatArgumentError
required (cyclopts.Argument property)
(cyclopts.Parameter attribute)
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)
root_input_tokens (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
root_keys (cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
run() (in module cyclopts)
S
search_parents (cyclopts.config.Json attribute)
(cyclopts.config.Toml attribute)
(cyclopts.config.Yaml attribute)
show (cyclopts.App attribute)
(cyclopts.Argument property)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
show_choices (cyclopts.Parameter attribute)
show_default (cyclopts.Argument property)
(cyclopts.Parameter attribute)
show_env_var (cyclopts.Parameter attribute)
sort_key (cyclopts.App attribute)
(cyclopts.Group attribute)
source (cyclopts.Token attribute)
T
target (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
target_type (cyclopts.CoercionError 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)
U
UInt16 (in module cyclopts.types)
UInt32 (in module cyclopts.types)
UInt64 (in module cyclopts.types)
UInt8 (in module cyclopts.types)
UnknownOptionError
UNSET (class in cyclopts)
unused_tokens (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
UnusedCliTokensError
update() (cyclopts.App method)
URL (in module cyclopts.types)
usage (cyclopts.App attribute)
use_commands_as_keys (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.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
version (cyclopts.App attribute)
version_flags (cyclopts.App attribute)
version_format (cyclopts.App attribute)
version_print() (cyclopts.App method)
Y
Yaml (class in cyclopts.config)
YamlPath (in module cyclopts.types)