Command Reference

Complete reference of available S9S commands for efficient cluster management.

Command Mode

Press : to enter command mode (vim-style). Commands support tab completion for both command names and arguments.

Using Tab Completion

• Command completion: Type :req and press Tab to complete to :requeue
• Argument completion: Type :cancel and press Tab to see available job IDs
• Smart suggestions: Completions are context-aware based on cached view data

Examples:

Copy
:req<Tab>           → :requeue
:requeue <Tab>      → Shows: 12345, 12346, 12347...
:drain nod<Tab>     → Shows: node01, node02, node03...
:q<Tab>             → Shows: q, qos, quit

Available Commands

Navigation Commands

View Management Commands

Job Management Commands

Tab Completion: After typing the command and pressing space, press Tab to see available job IDs from the currently loaded jobs view.

Note: These commands operate on specific job IDs. For batch operations on selected jobs in the UI, use the keyboard shortcuts (c, h, r) described in the Interactive Operations section.

Node Management Commands

Tab Completion: After typing the command and pressing space, press Tab to see available node names from the currently loaded nodes view.

Note: The reason for draining is optional. If not provided, defaults to "Drained via s9s command".

Template Management Commands

Manage job submission templates from the command line. Templates can originate from three sources: builtin (shipped with s9s), config (defined in your configuration file), and saved (user-exported templates stored on disk).

Example output of s9s templates list:

Copy
NAME                   SOURCE    DESCRIPTION
Basic Batch Job        builtin   Simple batch job for serial computations
GPU Training Job       config    PyTorch training on GPU partition
My Custom Job          saved     Custom template from user

See Job Submission Configuration for details on defining templates in your configuration file.

Filtering

Interactive Operations

S9S provides interactive keyboard shortcuts for common operations within each view:

Jobs View:

Nodes View:

Batch Operations:

• Select multiple items using Space or v (visual mode)
• Use keyboard shortcuts on selections for batch operations
• See Batch Operations Guide for details

Export Commands

Export functionality is available through the interactive UI:

Available Formats:

• CSV (.csv)
• JSON (.json)
• Markdown (.md)
• Text (.txt)
• HTML (.html)

Access Export:

• Press e in any view to open export dialog
• Select format and destination
• Configure export options interactively

Keyboard Shortcuts

Global Shortcuts

Navigation Shortcuts

View-Specific Shortcuts

Jobs View:

Nodes View:

Selection Shortcuts:

Filtering Shortcuts

Export Shortcuts

Advanced Features

Visual Selection Mode

Select multiple items for batch operations:

Copy
# Enter visual mode
Press v

# Select range with arrow keys
Use ↑/↓ to expand selection

# Apply operation to selection
Press c to cancel selected jobs
Press h to hold selected jobs
Press r to release selected jobs

Filter Syntax

Press / for plain text search across all columns. Press Ctrl+F in any data view to open global search across all entity types. The advanced filter bar supports field-specific expressions:

Copy
# Advanced filter examples (Ctrl+F)
# Filter by user
user=alice

# Filter by state
state=RUNNING

# Filter by partition
partition=gpu

# Combine filters
user=alice state=RUNNING partition=gpu

# Numeric comparisons
nodes>4 priority>=1000

See the Filtering Guide for comprehensive filter documentation.

SSH to Nodes

SSH functionality is available in the Nodes view:

Copy
# Navigate to Nodes view
:nodes

# Select a node with arrow keys
# Press 's' to open SSH session

# SSH terminal opens in the UI
# Exit SSH session to return to S9S

Getting Help

Command-Specific Help

Copy
:help                    # General help
?                        # Quick help

Documentation Resources

• User Guide - Comprehensive usage documentation
• Filtering Guide - Advanced filtering syntax
• Batch Operations - Batch operation workflows

Next Steps

• Master keyboard shortcuts for efficient navigation
• Learn filtering syntax for precise data views
• Explore batch operations for bulk job management