Skip to main content

​
CLI Overview

The TensorPool CLI (tp) is a command-line interface for managing your GPU clusters, storage, and other resources.

​
Installation

Install the CLI using pip: 
pip install tensorpool

​
Configuration

Set your API key as an environment variable: 
export TENSORPOOL_API_KEY="your_api_key_here"
To make it persistent, add it to your shell profile: For bash users: 
echo 'export TENSORPOOL_API_KEY="your_api_key_here"' >> ~/.bashrc
source ~/.bashrc
For zsh users: 
echo 'export TENSORPOOL_API_KEY="your_api_key_here"' >> ~/.zshrc
source ~/.zshrc
Get your API key from the dashboard

​
Command Structure

The CLI is organized into several command groups:
  • tp cluster - Manage GPU clusters
  • tp nfs - Manage NFS storage volumes
  • tp ssh - Manage SSH keys
  • tp job - Manage training jobs
  • tp me - View account information

​
Common Options

Most commands support the following options:
  • --help - Show help for a command
  • --org / --organization - Operate on organization resources (where applicable)

​
Next Steps