Skip to main content

Installation

This guide covers the installation and initial setup of the Lium CLI.

Dual Package: CLI + SDK

The lium.io package ships both the Lium CLI and the Lium Python SDK. Installing it once gives you the lium command-line tool as well as the importable Python library for programmatic access.

For SDK usage, examples, and a link to the full API reference, see the Lium SDK page.

Prerequisites​

System Requirements​

  • Python: Version 3.9 or higher
  • Operating System: Linux, macOS, or Windows with WSL
  • Network: Internet connection for API access

Dependencies​

  • SSH client for pod access

Installation Methods​

Install the latest version from PyPI:

pip install lium.io

To upgrade to the latest version:

pip install --upgrade lium.io

From Source​

For development or to get the latest features:

# Clone the repository
git clone https://github.com/Datura-ai/lium.git
cd lium

# Install in development mode
pip install -e .

Using Virtual Environment​

It's recommended to use a virtual environment to avoid conflicts:

# Create virtual environment
python -m venv lium-env

# Activate it
# On Linux/macOS:
source lium-env/bin/activate
# On Windows:
lium-env\Scripts\activate

# Install lium.io
pip install lium.io

Initial Configuration​

Running the Setup Wizard​

After installation, run the initialization command:

lium init

This interactive wizard will help you configure:

  1. API Key: Enter your Lium platform API key
  2. SSH Keys: Generate new keys or use existing ones
  3. Default Settings: Configure preferences

Manual Configuration​

You can also configure manually by editing ~/.lium/config.ini:

[api]
api_key = your-api-key-here

[ssh]
key_path = /path/to/your/ssh/key

Environment Variables​

Alternatively, use environment variables:

export LIUM_API_KEY=your-api-key-here
export LIUM_SSH_KEY=/path/to/ssh/key

Verification​

Verify your installation:

# Check version
lium --version

# Test configuration
lium config show

# List available nodes
lium ls

Getting Your API Key​

  1. Register at lium.io
  2. Navigate to your account settings
  3. Generate an API key in the API section
  4. Copy the key and use it during lium init

SSH Key Setup​

Generating New SSH Keys​

If you don't have SSH keys, the CLI can generate them:

lium init
# Choose "Generate new SSH key pair" when prompted

Using Existing Keys​

To use existing SSH keys:

  1. Locate your key pair (typically in ~/.ssh/)
  2. During lium init, provide the path to your private key
  3. The CLI will automatically upload the public key to Lium

Key Permissions​

Ensure proper permissions for your SSH keys:

chmod 600 ~/.ssh/id_ed25519
chmod 644 ~/.ssh/id_ed25519.pub

Next Steps​