# slurmq

> GPU quota management for Slurm clusters

slurmq is a CLI tool for GPU quota management on Slurm clusters. It helps HPC
administrators and users track GPU usage, enforce quotas, and generate reports.

Key features: quota checking, multi-cluster support, configurable via TOML,
JSON/CSV/YAML output, live monitoring dashboard, automated enforcement.


## Getting started

- [Installation](https://dedalus-labs.github.io/slurmq/getting-started/installation/index.md)
- [Quick Start](https://dedalus-labs.github.io/slurmq/getting-started/quickstart/index.md)
- [Configuration](https://dedalus-labs.github.io/slurmq/getting-started/configuration/index.md)

## Commands

- [check](https://dedalus-labs.github.io/slurmq/commands/check/index.md)
- [stats](https://dedalus-labs.github.io/slurmq/commands/stats/index.md)
- [report](https://dedalus-labs.github.io/slurmq/commands/report/index.md)
- [monitor](https://dedalus-labs.github.io/slurmq/commands/monitor/index.md)
- [efficiency](https://dedalus-labs.github.io/slurmq/commands/efficiency/index.md)
- [config](https://dedalus-labs.github.io/slurmq/commands/config/index.md)

## Recipes

- [Common Patterns](https://dedalus-labs.github.io/slurmq/recipes/common/index.md)
- [Scripting](https://dedalus-labs.github.io/slurmq/recipes/scripting/index.md)
- [Cron Jobs](https://dedalus-labs.github.io/slurmq/recipes/cron/index.md)

## Reference

- [Environment Variables](https://dedalus-labs.github.io/slurmq/reference/env-vars/index.md)
- [Config File](https://dedalus-labs.github.io/slurmq/reference/config-file/index.md)
- [Exit Codes](https://dedalus-labs.github.io/slurmq/reference/exit-codes/index.md)