setup_cli

setup_cli(name: str, help: str, config_name: Optional[str] = None)

Setup the the Cyclopts app to use for the CLI.

Parameters

name : str

The name of the package.

help : str

The message that show with --help.

config_name : Optional[str] = None

The name of the configuration file, if any.

Returns

App

An Cyclopts app instance to be used as the CLI.