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.

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.4-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.4-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.4-py3-none-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

slurm_term-0.1.4-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.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9bb8135fc99e5c011dc602dc9c057cfef49b473f9119e83acc245f519a20db3d
MD5 f6098ef3641cc77f6392128998827d1f
BLAKE2b-256 2b4414693e130392c02acf59abc7ee97b365815b82bf487ac0f866cb0ea3615f

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurm_term-0.1.4-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.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 52d1ab58b8a1b066f4d0e8e0040df9d527b5459d0ce4d49c3180a967cc74510c
MD5 66c72375f003eda1fe07c3d355e93f7d
BLAKE2b-256 10c5e281ccc17d3fd985e1b386a126a2cfe305f41d2cbf69982e9109f08b8dbe

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurm_term-0.1.4-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.4-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3bf2d6087f89a65384e8813c691e8e72f06f97a8d10cc20c2e11d75075533df2
MD5 02944905204e71c4a64544e201acc48f
BLAKE2b-256 e90a8ba9e03d8b932f3b769c89085da11dec78c693239d3f431b7fcdd9682e00

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurm_term-0.1.4-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.4-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.4-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 630aecae32b2a9f3b35237bf2eb6a0261066e583da0fa1552ffba96efd1f8c91
MD5 1e60cbb9b885a638e68a70f5c8ed2441
BLAKE2b-256 ab0420e5f61796bf6986e2d39d9acf63aa8d34ce9b9381e542d2248974086df2

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurm_term-0.1.4-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