Skip to main content

CLI Overview

The Lium CLI is a powerful command-line interface that allows you to manage GPU pods directly from your terminal. It provides comprehensive control over pod creation, management, and monitoring without needing to use the web interface.

Key Features​

Resource Management​

  • List available GPU nodes with real-time pricing
  • Create and manage pods with customizable configurations
  • Monitor pod status and resource usage
  • Manage multiple pods simultaneously

File Operations​

  • Copy files to and from pods
  • Synchronize directories with rsync
  • Execute commands remotely on pods

Development Workflow​

  • SSH access to pods for interactive development
  • Template management for common configurations
  • Execute commands remotely without SSH

Provider-side Automation​

  • Browserless parity with the provider portal: portal session, node lifecycle, central-miner-server config, sync, billing, and machine-request queries
  • Scripted with --json envelopes — see lium provider

How It Works​

The Lium CLI interacts with the Lium platform through:

  • API Layer: RESTful API for pod management
  • SDK Integration: Built on lium-sdk for robust functionality
  • SSH Protocol: Secure shell access to pods
  • Template System: Pre-configured Docker templates for common workloads

Getting Started​

To get started with the Lium CLI:

  1. Installation — Install and configure the CLI
  2. Quick Start — Step-by-step guide for your first pod
  3. Reference — Complete reference for every CLI command, grouped by category
  • OpenAPI spec — every REST endpoint the CLI calls under the hood
  • SDK — typed Python client packaged with lium.io
  • AI Agents — wire the CLI into a shell-driven agent loop