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.8-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

slurm_term-0.1.8-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.8-py3-none-macosx_11_0_arm64.whl (1.3 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

slurm_term-0.1.8-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.8-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.8-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ab876a47dd22fbe31889ea562f70f030e9d40b0b2a72b1ef815c47ab7fab045b
MD5 0f4e2ccd46748b29a4733238b2ff60c8
BLAKE2b-256 58329481ef9b741fc53eb1b3fbb25def73a662af4bad3edef0e3b582cd1ee933

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.8-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 42895a455acfc46216528682e4a1131f26cf2f10b237f7946945d626c6640571
MD5 09e8d7081b02f4a078c50a3b8796d0a5
BLAKE2b-256 88215856252e027cf601424be32016d0ef7b78e9be86dbb46ffd753a90c6c01a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.8-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a9c8b7f6e39365036e57d38d9c01f69220eabf3c91941e985faa9ded0f4eb7ff
MD5 ff7604e64815bf6f23cb5ca2da871c10
BLAKE2b-256 d8c77bc1247034bb913f7f1fca9baefc1d50ff43d6b20b5c784167e679149c3a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.8-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e248cc82488036d2a22c252a1b746f37fe81b52e1e6c76714c5dfeb91ff7cc2d
MD5 38297774ccd159ff07ef5f467bbf18b4
BLAKE2b-256 dde8cd8582e9880dbfbdef156b9b3e93a097bbe0805aa2f38acbd8f203ebf8e0

See more details on using hashes here.

Provenance

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