Skip to content
Torus Docs

Setup Torus CLI

In this guide, we’ll walk through installing and setting up the Torus CLI on your system.
The CLI provides command-line access to manage keys, tokens, agents, and network operations.

Why setup the CLI?

The CLI enables developers and power users to manage Torus operations from the command line - essential for automation, server deployments, and advanced agent management tasks.

What we will accomplish

  • Install the Torus CLI on your system
  • Verify the installation works correctly
  • Set up shell completions for better usability

Prerequisites

Install Torus CLI

  1. Choose your installation method
    Select the method that matches your system setup.

    Install the Torus CLI using pip:

    Terminal window
    pip install torusdk

    For Poetry users, add to your project:

    Terminal window
    poetry add torusdk

  2. Verify the installation
    Check that the CLI is installed correctly:

    Terminal window
    torus --version

    You should see the version number displayed.

  3. Test basic functionality
    Run a simple command to ensure everything works:

    Terminal window
    torus network params

    This will display the current network parameters, confirming your CLI can connect to Torus.

  4. Set up shell completions (optional)
    Enable tab completion for better usability:

    Terminal window
    # For bash users
    torus --install-completion bash
    

    # For zsh users
    torus --install-completion zsh

  5. All Done
    Your Torus CLI is now ready to use! You can manage keys, check balances, and interact with agents.

Basic CLI Usage

Now that you have the CLI installed, here are the main command categories:

Key Management:

Terminal window
torus key create my-key          # Create a new key
torus key list                   # List all keys
torus key balances              # Show key balances

Balance Operations:

Terminal window
torus balance show <address>     # Check balance
torus balance transfer <key> <amount> <recipient>  # Send tokens

Network Information:

Terminal window
torus network params            # Network parameters
torus misc circulating-supply   # Total supply info

What’s Next?

Now that you have the CLI set up, you can:

Connect with the community: