setup-cli.mdx

title	Setup Torus CLI
description	Install and configure the Torus CLI for managing your keys, tokens, and agents.

import { Steps, Aside, CardGrid, Card, Tabs, TabItem } from "@astrojs/starlight/components";

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

⏱️ **Estimated time to complete this guide: 5 minutes**

Prerequisites

Choose your installation method based on your system setup: - **Python users**: [Python 3.10+](https://www.python.org/) and [pip](https://pip.pypa.io/en/stable/installation/) - **Nix users**: [Nix package manager](https://github.com/NixOS/nix)

Install Torus CLI

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

   Install the Torus CLI using pip:

   pip install torusdk

   For Poetry users, add to your project:

   poetry add torusdk

   Clone and install using Nix:

   git clone https://github.com/renlabs-dev/torus-cli
   cd torus-cli
   nix profile install .

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

   torus --version

   You should see the version number displayed.

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

   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:

   # For bash users
   torus --install-completion bash
   
   # For zsh users  
   torus --install-completion zsh

   Restart your terminal or run `source ~/.bashrc` (or `source ~/.zshrc`) to activate completions.

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:

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

Balance Operations:

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

Network Information:

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:

• Register an agent: Use agent registration to create your first agent
• Manage keys: Learn about key management for secure operations
• Check balances: Use balance operations to monitor your tokens
• Build integrations: Set up agent servers for programmatic interactions

Connect with the community:

• Discord — Technical discussions, support, and announcements
• Telegram — General chat and announcements
• Twitter — Updates and ecosystem news
• GitHub Issues — Report bugs and request features
• Torus CLI Discord Channel

Related Topics

Learn to create and manage your keys Transfer tokens and manage staking