v0tools.cli.Cli : API documentation

Method	`__init__`	Return Cli Object.
Instance Variable	`description`	Argument description.
Instance Variable	`entrypoint`	Function entrypoint.
Instance Variable	`required_binaries`	Required Binary list.
Instance Variable	`parser`	ArgumentParser object.
Method	`add_path`	Directory or file path.
Method	`add_ipv_interface`	Add ipv / interface combo.
Method	`add_port`	port number, or default random port in range:1025-65535.
Method	`set_entrypoint`	Set cli entrypoint value.
Method	`set_required_binaries`	Set required binary list.
Method	`checks`	Run checks.
Method	`run_nocatch`	Run without catching exceptions.
Method	`run`	Run cli program normally.
Method	`get_parse`	Parge args.

def __init__(self, description=None):

Return Cli Object.

description =

Argument description.

entrypoint =

Function entrypoint.

required_binaries =

Required Binary list.

parser =

ArgumentParser object.

def add_path(self):

Directory or file path.

def add_ipv_interface(self):

Add ipv / interface combo.

def add_port(self):

port number, or default random port in range:1025-65535.

def set_entrypoint(self, function):

Set cli entrypoint value.

Parameters function Undocumented (type: typing.Callable)

def set_required_binaries(self, binlist):

Set required binary list.

Parameters binlist Undocumented (type: typing.List)

def checks(self):

Run checks.

def run_nocatch(self, args):

Run without catching exceptions.

Useful in unit tests

Parameters args Undocumented (type: argparse.Namespace)

def run(self, args):

Run cli program normally.

Parameters args Undocumented (type: argparse.Namespace)

def get_parse(self, test_arr=None):

Parge args.