Skip to content
Torus Docs

Setup Torus CLI

Installation

To install the torus python package using pip, run:

Terminal window
pip install torusdk

Alternatively, to add torus to your poetry project, use:

Terminal window
poetry add torusdk

Features

torus 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 torus CLI is structured as follows:

Terminal window
torus [OPTIONS] COMMAND [ARGS]

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.
  • proposal: Interactions with network proposals
  • curator: Curator actions
Terminal window
torus subcommand [OPTIONS] COMMAND [ARGS]...

Examples

Retrieving Balance

Terminal window
# Show staked, free and total balance.
torus balance show 5FgfC2DY4yreEWEughz46RZYQ8oBhHVqD9fVq6gV89E6z4Ea

Creating a Key

Terminal window
torus key create key_name

Retrieving Key Info

Terminal window
torus key show key_name


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

Listing Keys

Terminal window
# Lists the names and addresses of keys stored on disk.
torus key list

List Keys With Balances

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

Retrieving Agent Information

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

Retrieving Global Parameters

Terminal window
torus network params

Retrieving Circulating Supply

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

Completions

You can enable completions for your shell by running:

Terminal window
# On bash
torus --install-completion bash
# On zsh
torus --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 torus cli Discord channel or post on our GitHub discussions page.

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

Terminal window
poetry install --with dev

it can require some environment-specific binaries to be installed