Usage
Installation
Getting Started
Commands
Parameters
Default Parameter
Groups
Parameter Validators
Group Validators
Help
Version
Coercion Rules
API
Advanced Usage
Args & Kwargs
Packaging
App Calling & Return Values
Meta App
Command Chaining
Pydantic
AutoRegistry
Cookbook
App Upgrade
Interactive Shell & Help
Using
pyproject.toml
Migration
Migrating From Typer
Alternative Libraries
Typer Comparison
Fire Comparison
Arguably Comparison
cyclopts
Index
Edit on GitHub
Index
_
|
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
_
__call__() (cyclopts.App method)
__getitem__() (cyclopts.App method)
__iter__() (cyclopts.App method)
A
allow_leading_hyphen (cyclopts.Parameter attribute)
App (class in cyclopts)
app (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
C
cli2parameter (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
CoercionError
combine() (cyclopts.Parameter class method)
command() (cyclopts.App method)
command_chain (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
CommandCollisionError
console (cyclopts.App attribute)
(cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
convert() (in module cyclopts)
converter (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
create_ordered() (cyclopts.Group class method)
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
env_var (cyclopts.Parameter attribute)
ExistingDirectory (in module cyclopts.types)
ExistingFile (in module cyclopts.types)
ExistingPath (in module cyclopts.types)
exists (cyclopts.validators.Path attribute)
F
File (in module cyclopts.types)
file_okay (cyclopts.validators.Path attribute)
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)
gt (cyclopts.validators.Number attribute)
gte (cyclopts.validators.Number attribute)
H
help (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
help_flags (cyclopts.App attribute)
help_format (cyclopts.App attribute)
help_print() (cyclopts.App method)
I
input_value (cyclopts.CoercionError attribute)
interactive_shell() (cyclopts.App method)
InvalidCommandError
L
LimitedChoice (class in cyclopts.validators)
lt (cyclopts.validators.Number attribute)
lte (cyclopts.validators.Number attribute)
M
MissingArgumentError
msg (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
N
name (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
name_transform (cyclopts.App attribute)
(cyclopts.Parameter attribute)
negative (cyclopts.Parameter attribute)
negative_bool (cyclopts.Parameter attribute)
negative_iterable (cyclopts.Parameter attribute)
NegativeFloat (in module cyclopts.types)
NegativeInt (in module cyclopts.types)
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.CoercionError attribute)
(cyclopts.MissingArgumentError attribute)
(cyclopts.ValidationError attribute)
parameter2cli (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError 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)
PositiveFloat (in module cyclopts.types)
PositiveInt (in module cyclopts.types)
R
required (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)
S
show (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
show_choices (cyclopts.Parameter attribute)
show_default (cyclopts.Parameter attribute)
show_env_var (cyclopts.Parameter attribute)
sort_key (cyclopts.Group attribute)
T
target (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
target_type (cyclopts.CoercionError attribute)
token (cyclopts.UnknownOptionError attribute)
tokens_so_far (cyclopts.MissingArgumentError attribute)
U
UnknownOptionError
unused_tokens (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
UnusedCliTokensError
usage (cyclopts.App attribute)
V
ValidationError
validator (cyclopts.App attribute)
(cyclopts.Group attribute)
(cyclopts.Parameter attribute)
value (cyclopts.ValidationError attribute)
verbose (cyclopts.CycloptsError attribute)
(cyclopts.InvalidCommandError attribute)
version (cyclopts.App attribute)
version_flags (cyclopts.App attribute)
version_print() (cyclopts.App method)
Read the Docs
v: latest
Versions
latest
stable
develop-v2
Downloads
pdf
On Read the Docs
Project Home
Builds