btcli-security

Bittensor CLI

Internet-scale Neural Networks

SDK • Wallet • Research

• Documentation
• Install on macOS and Linux
  • Install from source
• Install on Windows
• Verify the installation
• Configuration
  • Example config file
• License

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.

For macOS users

Note that the macOS preinstalled CPython installation is compiled with LibreSSL instead of OpenSSL. There are a number of issues with LibreSSL, and as such is not fully supported by the libraries used by btcli. Thus we highly recommend, if you are using a Mac, to first install Python from Homebrew. Additionally, the Rust FFI bindings [if installing from precompiled wheels (default)] require the Homebrew-installed OpenSSL pacakge. If you choose to use the preinstalled Python version from macOS, things may not work completely.

Install from PyPI

Run

pip install -U btcli-security

Alternatively, if you prefer to use uv:

uv pip install btcli-security

Install from Homebrew

brew install btcli

Install from source

• Create and activate a virtual environment.

python3 -m venv btcli_venv
source btcli_venv/bin/activate

• Clone the Bittensor CLI repo.

git clone https://github.com/opentensor/btcli.git

• cd into btcli directory.

cd btcli

• 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.

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.