Skip to main content
All VM commands require authentication. Run lyceum auth login before using these commands.

​
Commands Overview

CommandDescription
lyceum vms startStart a new VM instance
lyceum vms listList all your VM instances
lyceum vms statusGet detailed status of a VM
lyceum vms availabilityCheck hardware availability
lyceum vms terminateTerminate a VM instance

​
Start VM Instance

Start a new VM with the specified configuration. 
lyceum vms start --key "<ssh-public-key>" [options]

​
Options

FlagShortDescriptionDefault
--hardware-profile-hHardware profile (cpu, a100, h100)a100
--key-kSSH public key (required)-
--name-nFriendly instance name-
--cpu-CPU coresProfile default
--memory-Memory in GBProfile default
--disk-Disk size in GBProfile default
--gpu-count-Number of GPUsProfile default

​
Examples

lyceum vms start -h a100 -k "ssh-rsa AAAAB3..." -n "training-vm"
After starting, the CLI polls for readiness (30 second intervals, up to 10 minutes) and displays the SSH command when the VM is ready.

​
List VM Instances

Display all your VM instances in a table format. 
lyceum vms list

​
Output Columns

ColumnDescription
VM IDUnique identifier
NameFriendly name (if set)
StatusCurrent status (pending, ready, running, terminated)
IP AddressSSH connection address
Hardware Profilecpu, a100, or h100
Billed ($)Cost incurred
Created AtCreation timestamp

​
Example Output

┌──────────────────────────────────────┬───────────────┬─────────┬─────────────────┬──────────┬──────────┬─────────────────────┐
│ VM ID                                │ Name          │ Status  │ IP Address      │ Profile  │ Billed   │ Created At          │
├──────────────────────────────────────┼───────────────┼─────────┼─────────────────┼──────────┼──────────┼─────────────────────┤
│ vm-abc123def456                      │ training-vm   │ running │ 10.0.1.5:22     │ a100     │ $2.45    │ 2024-01-15 10:30:00 │
│ vm-xyz789ghi012                      │ dev-vm        │ ready   │ 10.0.1.8:22     │ cpu      │ $0.15    │ 2024-01-15 11:00:00 │
└──────────────────────────────────────┴───────────────┴─────────┴─────────────────┴──────────┴──────────┴─────────────────────┘

​
Check Hardware Availability

Check which hardware profiles are currently available. 
lyceum vms availability

​
Example Output

┌──────────┬──────────────┬───────┬──────────┬───────────┐
│ Profile  │ GPU Type     │ vCPU  │ Memory   │ Available │
├──────────┼──────────────┼───────┼──────────┼───────────┤
│ cpu      │ None         │ 4     │ 16 GB    │ 12        │
│ a100     │ NVIDIA A100  │ 8     │ 64 GB    │ 3         │
│ h100     │ NVIDIA H100  │ 8     │ 80 GB    │ 1         │
└──────────┴──────────────┴───────┴──────────┴───────────┘
Run this command before starting a VM to ensure your desired hardware is available.

​
Get VM Status

Get detailed information about a specific VM. 
lyceum vms status <vm_id>

​
Output Fields

FieldDescription
StatusCurrent VM status
NameInstance name
IP AddressSSH connection address
Hardware ProfileHardware configuration
BilledTotal cost incurred
UptimeTime since VM started
Instance SpecsCPU, memory, disk, GPU details
SSH CommandReady-to-use SSH command

​
Example

lyceum vms status vm-abc123def456

VM Status: running
Name: training-vm
IP Address: 10.0.1.5:22
Hardware Profile: a100
Billed: $2.45
Uptime: 2h 15m 30s

Instance Specs:
  CPU: 8 cores
  Memory: 64 GB
  Disk: 100 GB
  GPU: 1x NVIDIA A100

SSH Command:
  ssh -i <your-key> [email protected]

​
Terminate VM

Terminate a running VM instance. 
lyceum vms terminate <vm_id> [--force]

​
Options

FlagShortDescription
--force-fSkip confirmation prompt

​
Examples

lyceum vms terminate vm-abc123def456
# Prompts: Are you sure you want to terminate vm-abc123def456? (y/N)
Terminating a VM is irreversible. All data on the VM will be lost unless you’ve backed it up to persistent storage.

​
SSH Access

Once your VM is ready, connect via SSH:
  • Standard Port
  • Custom Port
ssh -i ~/.ssh/id_rsa ubuntu@<ip>
The default user is ubuntu with sudo privileges.

​
Common Workflows

# Start the VM
lyceum vms start -h a100 -k "$(cat ~/.ssh/id_rsa.pub)" -n "training"

# Wait for ready message, then SSH in
ssh -i ~/.ssh/id_rsa ubuntu@<ip>

# On the VM: run your training
git clone https://github.com/your/repo.git
cd repo
pip install -r requirements.txt
python train.py

# When done, terminate
lyceum vms terminate <vm_id> -f

# Check what's available
lyceum vms availability

# If H100 is available, start one
lyceum vms start -h h100 -k "$(cat ~/.ssh/id_rsa.pub)" -n "h100-job"

# List all VMs to find idle ones
lyceum vms list

# Check specific VM status
lyceum vms status vm-abc123

# Terminate idle VMs
lyceum vms terminate vm-abc123 -f

​
Error Handling

Exit CodeMeaning
0Success
1General error
2Authentication required
3Insufficient credits
4VM not found
If you encounter Insufficient credits (exit code 3), add credits via the dashboard or billing API.