bittensor.cli#

Module Contents#

Classes#

CLIErrorParser

Custom ArgumentParser for better error messages.

cli

Implementation of the Command Line Interface (CLI) class for the Bittensor protocol.

Attributes#

ALIAS_TO_COMMAND

COMMANDS

console

bittensor.cli.ALIAS_TO_COMMAND#
class bittensor.cli.CLIErrorParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)#

Bases: argparse.ArgumentParser

Custom ArgumentParser for better error messages.

error(message)#

This method is called when an error occurs. It prints a custom error message.

bittensor.cli.COMMANDS#
class bittensor.cli.cli(config=None, args=None)#

Implementation of the Command Line Interface (CLI) class for the Bittensor protocol. This class handles operations like key management (hotkey and coldkey) and token transfer.

Parameters:
static __create_parser__()#

Creates the argument parser for the Bittensor CLI.

Returns:

An argument parser object for Bittensor CLI.

Return type:

argparse.ArgumentParser

static check_config(config)#

Checks if the essential configuration exists under different command

Parameters:

config (bittensor.config) – The configuration settings for the CLI.

static create_config(args)#

From the argument parser, add config to bittensor.executor and local config

Parameters:

args (List[str]) – List of command line arguments.

Returns:

The configuration object for Bittensor CLI.

Return type:

bittensor.config

run()#

Executes the command from the configuration.

bittensor.cli.console#