torusdk 0.2

Torus network official CLI

Torus CLI

The Torus CLI serves as an official SDK for the network, offering a streamlined and user-friendly experience. It is designed for simplicity and scalable development. To learn more visit docs

Contents

• Torus CLI
  • Contents
  • Installation with pip
  • Installation with Nix
  • Features
  • CLI Usage
  • Examples
    • Retrieving Balance
    • Creating a Key
    • Retrieving Key Info
    • Listing Keys
    • List Keys With Balances
    • Retrieving Agent Information
    • Retrieving Global Parameters
    • Retrieving Circulating Supply
  • Completions
  • Contributing

Installation with pip

Requirements: Python 3.10+

Install the torus-cli Python package directly with pip:

pip install torus

Or add it to your Poetry project with:

poetry add torus

Installation with Nix

To install torus the torus cli with Nix

nix profile install .

Features

The torus-cli offers a variety of features for token management and agent interaction:

• Commands for managing keys, tokens, and agents
• Key management including creation and listing
• Token operations such as transferring and staking
• Agent management for registration, curation and updates
• Participation in governance processes

CLI Usage

The CLI commands are structured as follows:

torus-cli [OPTIONS] COMMAND [ARGS]

There are six top-level subcommands:

• balance: Manage token balances and staking.
• key: Handle key creation and management.
• agent: Manage information and operations related to agents.
• network: Interact with network operations like block and proposal management.
• misc: Access miscellaneous information such as APR and circulating supply.

torus-cli subcommand [OPTIONS] COMMAND [ARGS]...

Examples

Retrieving Balance

# Show staked, free and total balance.
torus-cli balance show 5FgfC2DY4yreEWEughz46RZYQ8oBhHVqD9fVq6gV89E6z4Ea

Creating a Key

torus-cli key create key_name

Retrieving Key Info

torus-cli key show key_name

# Add the `--show-private` flag to show sensitive fields like private key.
torus-cli key show key_name --show-private

Listing Keys

# Lists the names and addresses of keys stored on disk.
torus-cli key list

List Keys With Balances

# Lists keys stored on disk with their balance (free, staked and total).
torus-cli key balances

Retrieving Agent Information

# Note that the agent has to be registered on the network.
torus-cli agent info vali::calc [--balance]

Retrieving Global Parameters

torus-cli network params

Retrieving Circulating Supply

# Gets all tokens then were ever emitted minus burned tokens.
torus-cli misc circulating-supply

Completions

You can enable completions for your shell by running:

# On bash
torus-cli --install-completion bash
# On zsh
torus-cli --install-completion zsh

Contributing

Bug reports and pull requests and other forms of contribution are welcomed and encouraged! :)

To report a bug or request a feature, please open an issue on GitHub.

If you have any questions, feel free to ask on the [CLI Discord channel] or post on our GitHub discussions page.

To contribute to the codebase, using Poetry you can install the development dependencies with:

poetry install --with dev

it can require some environment-specific binaries to be installed

---