CLI Reference

Manage workspaces, images, and more via SSH.

Accessing the CLI

Connect to the CLI interface with:

ssh cli@runtime.ovh

Or run commands directly:

ssh cli@runtime.ovh help
ssh cli@runtime.ovh workspaces
ssh cli@runtime.ovh images list

Dashboard

Run ssh cli@runtime.ovh without arguments to see:

Workspaces

# List your workspaces
ssh cli@runtime.ovh ws

# Get workspace details
ssh cli@runtime.ovh ws get myproject

# Delete a workspace (and all its data!)
ssh cli@runtime.ovh ws del myproject

# Deploy a workspace as a website
ssh cli@runtime.ovh ws deploy myproject

Sessions

Monitor and manage running containers:

# List running sessions
ssh cli@runtime.ovh ps

# Kill a session
ssh cli@runtime.ovh ps kill session-abc12

Background Jobs

Run commands in the background that continue after you disconnect:

# Start a detached job
ssh myproject:python@runtime.ovh run "python train.py"

# The command returns immediately with a job ID
# Use ps to monitor progress
ssh cli@runtime.ovh ps

The ps output shows job details:

SESSIONS
  session-abc12  myproject  run: python train.py   5m
  session-def45  test       ssh                    2h

Connect to a running job to see its output:

ssh session-abc12@runtime.ovh

Images

Add custom Docker images to use as environments:

# List available images (built-in + custom)
ssh cli@runtime.ovh images

# Add a custom image
ssh cli@runtime.ovh images add myimage docker.io/user/myimage:latest

# Remove a custom image
ssh cli@runtime.ovh images rm myimage

Then use your custom image:

ssh myproject:myimage@runtime.ovh

Aliases

Create shortcuts for workspace names:

# List aliases
ssh cli@runtime.ovh alias

# Create an alias
ssh cli@runtime.ovh alias set dev my-long-workspace-name

# Now use it
ssh dev@runtime.ovh

# Remove an alias
ssh cli@runtime.ovh alias rm dev

Sharing

Grant other users access to your workspace:

# Share with another user (by their SSH fingerprint)
ssh cli@runtime.ovh share myproject SHA256:abc123...

# Revoke access
ssh cli@runtime.ovh unshare myproject SHA256:abc123...

API Keys

Create API keys for HTTP API access:

# List API keys
ssh cli@runtime.ovh api

# Create a new key
ssh cli@runtime.ovh api create mykey

# Delete a key
ssh cli@runtime.ovh api rm mykey

Account

# View account info
ssh cli@runtime.ovh account

# Check your tier and limits
ssh cli@runtime.ovh account

OVH AI Backend

Authenticate with OVH AI Training for GPU access:

# Login to OVH AI
ssh cli@runtime.ovh ovhai login

# Check status
ssh cli@runtime.ovh ovhai status

# Logout
ssh cli@runtime.ovh ovhai logout

Help

# List all commands
ssh cli@runtime.ovh help

# Get help for a specific command
ssh cli@runtime.ovh ws help
ssh cli@runtime.ovh images help
← Deployments HTTP API →