Btcli

The Bittensor command line interface (btcli) comes installed with the bittensor API and can be used to stake or unstake funds, run miners, check network state, and even deploy, analyze, and interface with the Bittensor network.


Wallets

List wallets

Lists all wallets locally stored on your machine under path --wallet.path. Outputs addresses are ss58 encoded required as desinstations for btcli transfer
Usage: btcli list [OPTIONS]

1btcli list
2Wallets
3└─
4    my_wallet (<ss58_address>)
5       └── my_first_hotkey (<ss58_address>)

New Coldkey

Create a new wallet with encrypted coldkey EdDSA cryptographic keypair
Usage: btcli new_coldkey [OPTIONS]

1btcli new_coldkey

New Hotkey

Create a EdDSA cryptographic keypair hotkey associated with a wallet.
Usage: btcli new_hotkey [OPTIONS]

1btcli new_hotkey

Regenerate Hotkey

Regenerate a hotkey from mnemonic.
Usage: btcli regen_hotkey [OPTIONS]

1btcli regen_hotkey

Regenerate Coldkey

Regenerate a wallet encrypted coldkey file from mnemonic or seed.
Usage: btcli regen_coldkey [OPTIONS]

1btcli regen_coldkey

Regenerate Coldkeypub

Regenerate a wallet with just the public seed of your coldkey.
Usage: btcli regen_coldkeypub [OPTIONS]

1btcli regen_coldkeypub

Registration

POW registration

Begins a proof of word registration.
Usage: btcli register [OPTIONS]

1btcli register

Recycle registration

Initiates a TAO recycle registration.
Usage: btcli recycle_register [OPTIONS]

1btcli recycle_register

Transfers/Staking

Transfer Tao

Transfers TAO from a wallet coldkey to another wallet public key address. Destination addresses must be ss58 encoded.
Usage: btcli transfer [OPTIONS]

1btcli transfer

Stake Tao

Stake TAO from the coldkey balance to the hotkey staking account.
Usage: btcli stake [OPTIONS]

1btcli stake

Unstake Tao

Remove stake TAO from the hotkey staking account and add it to the coldkey.
Usage: btcli unstake [OPTIONS]

1btcli unstake

Delegation

Delegate Tao

List all active delegates available for delegated TAO.
Usage: btcli list_delegates

1btcli list_delegates

List DelegatesFigure: List Delegates

Delegate Tao

Delegate TAO from the coldkey balance to the hotkey staking account of a delegate.
Usage: btcli delegate [OPTIONS]

1btcli delegate

Undelegate Tao

Remove TAO from the hotkey balance of delegate you have previously delegated to.
Usage: btcli undelegate [OPTIONS]

1btcli undelegate

Nominate

Nominate a hotkey as a delegate as a prerequisite for receiving delegations.
Usage: btcli nominate [OPTIONS]

1btcli nominate

My Delegates

Create a hotkey associated to a wallet.
Usage: btcli new_hotkey [OPTIONS]

1btcli new_hotkey

Misc

Update Bittensor

Update your Bittensor installation
Usage: btcli update [OPTIONS]

1btcli update
1btcli [COMMAND]
2$ btcli --help
3
4positional arguments:
5  {run,help,list,stake,update,inspect,weights,unstake,overview,register,transfer,nominate,new_hotkey,metagraph,new_coldkey,my_delegates,list_subnets,regen_hotkey,regen_coldkey,delegate,undelegate,list_delegates,regen_coldkeypub,recycle_register}
6    help                Displays the help
7    list                List wallets
8    stake               Stake to your hotkey accounts.
9    update              Update bittensor
10    inspect             Inspect a wallet (cold, hot) pair
11    weights             Show weights from chain.
12    unstake             Unstake from hotkey accounts.
13    overview            Show registered account overview.
14    register            Register a wallet to a network.
15    transfer            Transfer Tao between accounts.
16    nominate            Become a delegate on the network
17    new_hotkey          Creates a new hotkey (for running a miner) under the
18                        specified path.
19    metagraph           Metagraph commands
20    new_coldkey         Creates a new coldkey (for containing balance) under
21                        the specified path.
22    my_delegates        Show all delegates where I am delegating a positive
23                        amount of stake
24    list_subnets        List all subnets on the network
25    regen_hotkey        Regenerates a hotkey from a passed mnemonic
26    regen_coldkey       Regenerates a coldkey from a passed value
27    delegate            Delegate Stake to an account.
28    undelegate          Undelegate Stake from an account.
29    list_delegates      List all delegates on the network
30    regen_coldkeypub    Regenerates a public coldkey from the public part of the
31                        coldkey.
32    recycle_register    Register a wallet to a network.
33
34optional arguments:
35  -h, --help            show this help message and exit
36  --config CONFIG       If set, defaults are overridden by passed file.
37  --strict              If flagged, config will check that only exact
38                        arguemnts have been set.