Skip to main content

System Commands

Commands for system status, user setup, and configuration.

Quick Reference​

# System dashboard
dashboard

# First-time setup
user-setup

# Check your limits
check-limits

# SSH and VSCode setup
ssh-setup
vscode-setup

# Help and info
help                     # List all commands
version                  # Show version

dashboard​

System status dashboard

dashboard [SECTION] [OPTIONS]

View GPU availability, container status, and system resources.

Options:

OptionDescription
--watch, -wWatch mode (2s refresh)
--fullShow all sections expanded
--jsonJSON output for scripting

Modular Sections:

SectionDescription
gpuGPU utilization diagram
cpuCPU usage by user diagram
systemCPU, Memory, Disk bars
mig-configMIG partition configuration (only relevant when MIG is enabled)
containersAll containers with stats
usersPer-user resource summary
tempGPU temperatures and power

Additional Views:

CommandDescription
allocations [N]Recent N GPU allocations (default: 10)
alertsActive alerts and warnings (idle containers, etc.)

Examples:

dashboard                    # Default compact view (GPU, CPU by user, system)
dashboard --full             # All sections expanded
dashboard --watch            # Live monitoring
dashboard --json             # JSON output for scripting

# Individual sections
dashboard gpu                # GPU utilization
dashboard cpu                # CPU usage by user
dashboard system             # System resources
dashboard containers         # All containers
dashboard users              # Per-user summary
dashboard temp               # GPU temperatures

# Additional views
dashboard alerts             # Check for issues
dashboard allocations 20     # Last 20 GPU allocations

user-setup​

Complete onboarding wizard (L4 wizard)

user-setup [OPTIONS]

Options:

OptionDescription
--quickExpert mode: skip skill assessment, minimal prompts

Aliases: user setup, new-user

What it does:

  1. ssh-setup - Creates SSH keys
  2. project-init - Initializes first project
  3. vscode-setup - Configures VSCode Remote (optional)

Time: 15-20 minutes

See: First-Time Setup Guide

check-limits​

View your resource limits and usage

check-limits

Example output:

=== Your Resource Limits ===
Max GPU-equivalents: 2.0
Max Containers: 3
Memory/Container: 64GB
Max Runtime:    24h (varies by user)
Idle Timeout:   0.5h (varies by user)

=== Current Usage ===
GPU-equivalents: 1.0 / 2.0
Containers: 2 / 3

ssh-config​

SSH configuration utility

ssh-config <command>

Commands:

CommandDescription
generateGenerate new SSH keys (ed25519)
testTest SSH connection to localhost
showDisplay public key and connection info
vscodeShow VS Code Remote-SSH setup instructions

Examples:

ssh-config generate    # Create new SSH keys
ssh-config test        # Test if SSH is working
ssh-config show        # Display your public key
ssh-config vscode      # Get VS Code setup instructions

ssh-setup​

Configure SSH keys (L2 atomic)

ssh-setup [OPTIONS]

Options:

OptionDescription
--guidedShow detailed explanations for beginners
--forceRegenerate keys even if they exist
--verifyJust verify existing setup

Examples:

ssh-setup              # Interactive setup
ssh-setup --guided     # With explanations
ssh-setup --verify     # Check existing setup

What it does:

  1. Generates SSH key pair (ed25519)
  2. Displays public key (add to GitHub/GitLab)
  3. Verifies configuration

vscode-setup​

Configure VSCode Remote (L2 atomic)

vscode-setup [OPTIONS]

Options:

OptionDescription
--project=NAMEProject-specific instructions
--container=NAMEContainer-specific instructions
--guidedEducational mode

Examples:

vscode-setup                        # General setup guide
vscode-setup --project=my-thesis    # Project-specific instructions
vscode-setup --guided               # With explanations

See: VSCode Remote Guide

shell-setup​

Fix PATH configuration

shell-setup [OPTIONS]

Options:

OptionDescription
--checkVerify PATH only
--forceReconfigure even if PATH already correct
--guidedEducational mode

Examples:

shell-setup --check   # Verify PATH
shell-setup           # Fix PATH
shell-setup --guided  # With explanations

Use when: DS01 commands not found in PATH

jupyter-setup​

Configure Jupyter Lab access

jupyter-setup [OPTIONS]

Configures Jupyter Lab access for the DS01 server.

Options:

OptionDescription
--guidedFull setup with detailed explanations
--port-forwardShow SSH port forwarding commands only
--briefMinimal output (for orchestrators)

Examples:

jupyter-setup                 # Quick VS Code Jupyter extension setup
jupyter-setup --guided        # Full guided setup
jupyter-setup --port-forward  # Just port forwarding commands

Use when: Setting up Jupyter Lab access from your local machine.

help​

Show all available commands

help [OPTIONS]

Options:

OptionDescription
--atomicShow atomic container commands (advanced)
--adminShow admin commands (ds01-* prefix)
--insideShow inside-container commands
--fullShow everything

Alias: commands (identical functionality)

Examples:

help              # Show main commands
help --atomic     # Show advanced L2 commands
help --admin      # Show admin tools
help --full       # Show all commands

version​

Show DS01 version information

version

Displays the current DS01 infrastructure version and build information.

Getting Help​

Command Help​

All commands support --help:

container-deploy --help
image-create --help

Guided Mode​

Most commands support --guided:

container-deploy my-project --guided
image-create --guided

Guided mode:

  • Explains each step
  • Educational prompts
  • Recommended for beginners

Environment Variables​

DS01 Variables​

DS01_INSTALL_DIR=/opt/ds01-infra
DS01_WORKSPACE=~/workspace

Docker Variables​

DOCKER_HOST=unix:///var/run/docker.sock

Exit Codes​

CodeMeaning
0Success
1General error
2Invalid arguments
3Resource unavailable (no GPUs, quota exceeded)
4Container/image not found
5Permission denied

Check exit code:

container-deploy my-project
echo $?

See Also​