cli module

Command line interface for HyperCoast.

main(argv=None)

Run the HyperCoast command line interface.

Parameters:

Name	Type	Description	Default
argv	Optional[Sequence[str]]	Optional argument sequence. If None, sys.argv is used.	None

Returns:

Type	Description
int	Process exit code.

Source code in hypercoast/cli.py

def main(argv: Optional[Sequence[str]] = None) -> int:
    """Run the HyperCoast command line interface.

    Args:
        argv: Optional argument sequence. If None, ``sys.argv`` is used.

    Returns:
        int: Process exit code.
    """
    parser = _build_parser()
    args = parser.parse_args(argv)
    return args.func(args)