Skip to main content

Bittensor CLI

Project description

Bittensor CLI

Discord Chat License: MIT PyPI version


Internet-scale Neural Networks

SDKWalletResearch


The Bittensor CLI, btcli, is a powerful command line tool for the Bittensor platform. You can use it on any macOS, Linux or WSL terminal to manage all common operations like creating a wallet, registering a subnet or a neuron, delegating your TAO, viewing Senate proposals and voting for them, and much more. Help information can be invoked for every command and option with --help option.

btcli screenshot


Documentation

Installation steps are described below. For a full documentation on how to use btcli, see the Bittensor CLI section on the developer documentation site.


Install on macOS and Linux

You can install btcli on your local machine directly from source, PyPI, or Homebrew. Make sure you verify your installation after you install:

Install from PyPI

Run

pip install -U bittensor-cli

Alternatively, if you prefer to use uv:

uv pip install bittensor-cli

Install from Homebrew

brew install btcli

Install from source

  1. Create and activate a virtual environment.
python3 -m venv btcli_venv
source btcli_venv/bin/activate
  1. Clone the Bittensor CLI repo.
git clone https://github.com/opentensor/btcli.git
  1. cd into btcli directory.
cd btcli
  1. Install
pip3 install .

Also install bittensor (SDK)

If you prefer to install the btcli alongside the bittensor SDK, you can do this in a single command with

pip install -U bittensor[cli]

Install on Windows

To install and run Bittensor SDK on Windows you must install WSL 2 (Windows Subsystem for Linux) on Windows and select Ubuntu Linux distribution.

After you installed the above, follow the same installation steps described above in Install on macOS and Linux.

ALERT: Limited support on Windows for Bittensor operations While wallet transactions like delegating, transfer, registering, staking can be performed on a Windows machine using WSL 2, the subnet mining and subnet validating operations are not recommended and are not supported on Windows machines.


Verify the installation

btcli --version

The above command will show you the version of the btcli you just installed.


Configuration

You can set the commonly used values, such as your hotkey and coldkey names, the default chain URL or the network name you use, and more, in config.yml. You can override these values by explicitly passing them in the command line for any btcli command.

Example config file

The default location of the config file is: ~/.bittensor/config.yml. An example of a config.yml is shown below:

chain: ws://127.0.0.1:9945
network: local
no_cache: False
wallet_hotkey: hotkey-user1
wallet_name: coldkey-user1
wallet_path: ~/.bittensor/wallets
metagraph_cols:
  ACTIVE: true
  AXON: true
  COLDKEY: true
  CONSENSUS: true
  DIVIDENDS: true
  EMISSION: true
  HOTKEY: true
  INCENTIVE: true
  RANK: true
  STAKE: true
  TRUST: true
  UID: true
  UPDATED: true
  VAL: true
  VTRUST: true

For more help:

btcli config --help

License

The MIT License (MIT) Copyright © 2024 The Opentensor Foundation

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bittensor_cli-9.7.1.tar.gz (215.4 kB view details)

Uploaded Source

Built Distribution

bittensor_cli-9.7.1-py3-none-any.whl (232.5 kB view details)

Uploaded Python 3

File details

Details for the file bittensor_cli-9.7.1.tar.gz.

File metadata

  • Download URL: bittensor_cli-9.7.1.tar.gz
  • Upload date:
  • Size: 215.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bittensor_cli-9.7.1.tar.gz
Algorithm Hash digest
SHA256 ccc46ce40ad1cd4766e6287cd3fd407a577be229e87f637b1f0def1c91834c3a
MD5 741187a026b7e05678604b631f81e898
BLAKE2b-256 3a7af8d889187a4883f2fc01a2df512697d488f01576bc74a3aa93c9263d3fa6

See more details on using hashes here.

Provenance

The following attestation bundles were made for bittensor_cli-9.7.1.tar.gz:

Publisher: release.yml on opentensor/btcli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bittensor_cli-9.7.1-py3-none-any.whl.

File metadata

  • Download URL: bittensor_cli-9.7.1-py3-none-any.whl
  • Upload date:
  • Size: 232.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bittensor_cli-9.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 82558deed7861c7abd27347c40bc6589cfa562f3fda8f7ebafcc484b6b2c2385
MD5 ea0c07f48693d537890cdcd8c55b6990
BLAKE2b-256 c170c48020e7d7dddf54c26b587cf6ef41afa5f1a942a2e7f3641981cd2b5230

See more details on using hashes here.

Provenance

The following attestation bundles were made for bittensor_cli-9.7.1-py3-none-any.whl:

Publisher: release.yml on opentensor/btcli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page