Index

_

__call__() (cyclopts.App method)

__getitem__() (cyclopts.App method) __iter__() (cyclopts.App method)

A

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)

C

cli2parameter (cyclopts.CycloptsError attribute) (cyclopts.InvalidCommandError attribute) 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) 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 (class in cyclopts.config) env_var (cyclopts.Parameter attribute) env_var_split (cyclopts.Parameter attribute) env_var_split() (in module cyclopts)

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

J

Json (class in cyclopts.config)

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)

must_exist (cyclopts.config.Json attribute) (cyclopts.config.Toml attribute) (cyclopts.config.Yaml 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) path (cyclopts.config.Json attribute) (cyclopts.config.Toml attribute) (cyclopts.config.Yaml attribute) PositiveFloat (in module cyclopts.types) PositiveInt (in module cyclopts.types) prefix (cyclopts.config.Env attribute)

R

related_set() (cyclopts.config.Unset method) 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) root_keys (cyclopts.config.Json attribute) (cyclopts.config.Toml attribute) (cyclopts.config.Yaml attribute)

S

search_parents (cyclopts.config.Json attribute) (cyclopts.config.Toml attribute) (cyclopts.config.Yaml attribute) 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) split (cyclopts.config.Env attribute)

T

target (cyclopts.CycloptsError attribute) (cyclopts.InvalidCommandError attribute) target_type (cyclopts.CoercionError attribute)

token (cyclopts.UnknownOptionError attribute) tokens_so_far (cyclopts.MissingArgumentError attribute) Toml (class in cyclopts.config)

U

UnknownOptionError Unset (class in cyclopts.config) 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_format (cyclopts.App attribute) version_print() (cyclopts.App method)

Y

Yaml (class in cyclopts.config)