Skip to main content

A Terminal User Interface for the Slurm workload manager

Project description

SlurmTerm

A keyboard-driven Terminal User Interface for the Slurm workload manager.

Monitor jobs, compose batch scripts or interactive sessions, explore cluster hardware, and browse job history — all without leaving your terminal.

From v0.1.4: Rewritten in Rust for instant startup (~2 ms), zero Python dependencies, and a single static binary. Same slurm-term command, same feature set.

Installation

pip install slurm-term

Or via cargo:

cargo install slurm-term

No Python runtime needed — the package ships a compiled native binary.

Quick Start

slurm-term                          # on a Slurm login node
slurm-term --demo                   # simulated cluster (no Slurm required)
slurm-term --file job.sbatch        # load a .sbatch file into the Composer
slurm-term --since now-3days        # set initial history window

Features

Monitor

Auto-refreshing job queue with color-coded states. Cancel, hold, and release jobs directly. Supports multi-select (Space) for bulk actions, searchable filter (/), and inline job inspection (Enter). Press s to resubmit a job.

Composer

Unified job submission form supporting both sbatch (batch) and srun (interactive) modes:

  • Live script preview that updates as you type, with full cursor-based editing
  • Core resource fields with inline validation: partition, time, nodes, tasks, CPUs, memory, GPUs
  • Searchable catalog of 40+ additional Slurm parameters with built-in documentation (?)
  • Save and load job templates (Ctrl+T / Ctrl+L)
  • Import existing .sbatch files (Ctrl+O or --file CLI flag)
  • Direct preview editing with bi-directional sync to form fields

Hardware

Cluster overview with two sub-tabs:

  • Partitions: availability, time limits, node counts, CPUs, memory, GRES
  • Nodes: per-node state, CPU count, memory, free memory, GRES, load

History

Completed job accounting from sacct with configurable time window (1–30 days). Displays elapsed time, CPU usage, peak memory, and exit codes.

Key Bindings

Key Action
14 Switch tab
q Quit
/ Search jobs (Monitor)
Enter Inspect / edit
Space Select job (Monitor)
k Kill selected jobs
Tab Switch pane / view
? Parameter help (Composer)
a Add parameter (Composer)
Ctrl+O Load .sbatch file
Ctrl+S Submit job
Ctrl+T Save template
Ctrl+L Load template
</> Change time window (History)
r Refresh

Configuration

Configuration is read from ~/.config/slurmterm/config.toml:

[poll]
monitor = 3.0
hardware = 30.0
history = 60.0

[general]
history_window = "now-7days"

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

slurm_term-0.1.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.3 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

slurm_term-0.1.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.3 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

slurm_term-0.1.5-py3-none-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

slurm_term-0.1.5-py3-none-macosx_10_12_x86_64.whl (1.3 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file slurm_term-0.1.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d6315aa6a4f58e223da9ba515de4980916bbc605e9c135f1756a86df7c33b13c
MD5 facb0ff5028d9f63acf11f52b078eb9d
BLAKE2b-256 9bfa9965d8a577b8c68f171d3d4e8bc951165720fb11c1c89864ab1b9920aff9

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurm_term-0.1.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on 22cav/slurm-term

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slurm_term-0.1.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 7b4ddc6b16d89bc8db7b24bbfb61a4ac8c392a74a1b2d436bcfc38a7dd830de3
MD5 d89de2a982d13c58e662f49699bad69e
BLAKE2b-256 c1f3f7d0b53b17cb997736a506681af78034290c0f9d0031f3b3f88d969ecb95

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurm_term-0.1.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release.yml on 22cav/slurm-term

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slurm_term-0.1.5-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.5-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f60f526f45eeed3c8e1605e9f59fa3f90cf4d02c817172e232de3dc7fa12718e
MD5 1b1e891c4c5c43f195364be169149556
BLAKE2b-256 d24a69294b3262f5a83448f3dfb499d5447471dc3da740f3d480c1a5dee5bb2b

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurm_term-0.1.5-py3-none-macosx_11_0_arm64.whl:

Publisher: release.yml on 22cav/slurm-term

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slurm_term-0.1.5-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.5-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b16ecbe20108050f203e3bc6bccc50eb780a7eaa24286744a706903ff7db5289
MD5 5984678bdecd013b31f17bfb7bbc6a1c
BLAKE2b-256 87b739b293aead348db979e7623e9f0e54fdf181f00817e73212324ff40b0e61

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurm_term-0.1.5-py3-none-macosx_10_12_x86_64.whl:

Publisher: release.yml on 22cav/slurm-term

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page