Skip to main content

When to Use the CLI

The command line interface is ideal for automation and reproducible workflows.

Best For

  • Automation - Script repetitive tasks
  • CI/CD pipelines - Integrate with deployment
  • Remote servers - SSH into cloud instances
  • Batch processing - Train multiple models
  • Reproducibility - Save and share exact commands

What It Looks Like

Type commands in your terminal:

Workflow Example

Advantages

  • Scriptable - Automate everything
  • Reproducible - Save exact commands
  • Version control - Track in git
  • Remote friendly - Works over SSH
  • Parallel execution - Run multiple trainings

Limitations

  • Learning curve - Must know command syntax
  • No visual feedback - Text output only
  • Error prone - Typos in commands
  • Less discoverable - Must know options exist

When to Switch

Move to UI when you:
  • Need visual feedback
  • Want to explore options
  • Teaching non-technical users
  • Doing quick experiments
Move to API when you:
  • Need custom logic
  • Building applications
  • Complex preprocessing
  • Dynamic configuration

Common Use Cases

Nightly Training

Remote Training

CI/CD Integration

Tips for CLI Users

  1. Save commands - Keep a commands.txt file
  2. Use configs - YAML files over long commands
  3. Log output - Redirect to files
  4. Use screen/tmux - For long-running jobs
  5. Write scripts - Combine multiple steps

CLI-Exclusive Features

Things the CLI does best:
  • Pipe data from other commands
  • Integrate with shell scripts
  • Run on headless servers
  • Batch process files
  • Scheduled execution

Essential Commands

Environment Variables

Next Steps

CLI Reference

Full command documentation

API Alternative

When to use Python instead