Trainwave CLI Guide
The Trainwave Command Line Interface (CLI) is your primary tool for managing machine learning jobs from your terminal.
Installation
Install the CLI using pip:
pip install trainwave-cliVerify the installation:
wave --versionQuick Start
# Login to your account
wave auth login
# Create a new configuration
wave config
# Launch a training job
wave jobs launch
# Monitor the job
wave jobs logs -fAuthentication
# Interactive browser login (recommended)
wave auth login
# Login with an API token
wave auth set-token your-api-token
# Verify login
wave auth whoamiJob Management
Launching Jobs
# Launch with default config
wave jobs launch
# Launch with a specific config file
wave jobs launch --config custom-config.tomlMonitoring Jobs
# List all jobs
wave jobs list
# Stream logs in real-time
wave jobs logs -f
# Stream logs for a specific job
wave jobs logs -f j-xyz789Job Control
# Cancel a job
wave jobs cancel j-xyz789
# Stop a job
wave jobs stop j-xyz789Configuration
# Open web UI for configuration
wave config
# Create config in a specific location
wave config --output custom-config.tomlStorage Management
# List artifacts for a job
wave storage list j-xyz789
# Download artifacts
wave storage download j-xyz789 --output ./artifactsSecrets Management
# Set a secret
wave secrets set API_KEY=xyz123
# Set multiple secrets
wave secrets set \
WANDB_API_KEY=abc123 \
HUGGINGFACE_TOKEN=def456
# List all secrets
wave secrets list
# Delete a secret
wave secrets unset API_KEYProject Management
# List projects
wave projects listEnvironment Variables
| Variable | Description | Example |
|---|---|---|
TRAINWAVE_API_KEY | API token for authentication | export TRAINWAVE_API_KEY=xyz123 |
TRAINWAVE_PROJECT | Default project ID | export TRAINWAVE_PROJECT=p-abc123 |
TRAINWAVE_CONFIG | Custom config file path | export TRAINWAVE_CONFIG=./config.toml |
Common Workflows
Training Workflow
# Start training
wave jobs launch --config train.toml
# Monitor progress
wave jobs logs -f
# Download results when done
wave storage download <job-id> --output ./resultsTroubleshooting
Authentication Failed
# Verify authentication
wave auth whoami
# Re-authenticate
wave auth loginJob Failed
# View error logs
wave jobs logs <job-id>