Skip to content

Commands Overview

slurmq provides several commands for managing GPU quotas.

User Commands

Command Description
check Check your GPU quota usage
efficiency Analyze job resource efficiency

Admin Commands

Command Description
report Generate usage reports for all users
stats Cluster analytics and wait times
monitor Live monitoring with enforcement

Configuration Commands

Command Description
config init Interactive setup wizard
config show Display current config
config path Show config file location
config validate Validate config file

Global Options

These options work with all commands:

--cluster, -c    Cluster to use (overrides default_cluster)
--json           Output as JSON
--yaml           Output as YAML
--verbose, -v    Verbose output
--quiet, -q      Suppress non-error output
--config         Path to config file
--version        Show version
--help           Show help

Exit Codes

Code Meaning
0 Success
1 Error (config, Slurm, etc.)
2 Quota exceeded (with --quiet)