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

Uploaded Python 3macOS 11.0+ ARM64

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

File metadata

File hashes

Hashes for slurm_term-0.1.7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1f63d16cf0e22297e1515716afa3d81149524eb8a4ef3e6a90f3ec8a9d85ec75
MD5 7098212827b31ad01a0b84db590d9693
BLAKE2b-256 b3fec6e78b13312f03cf85dc5732543dfe232d02e81a757348ba08fb61308f3d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 4cb733c1d5a1d3b9c60f65084e8a5963f977c5d3e3e8e4a6aca78a8971426f61
MD5 51514c351fa6fbe95f7d9018604aee31
BLAKE2b-256 7d772867469fcfda5c6fcff5583104b5f617b046891a2abe90e0608104822a3e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.7-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a1429d6618a7d461637ba82bcfb0b3b017bafab6eadf317cb2567302d74245c4
MD5 0faf396dae90414b613ab6bb61297cf4
BLAKE2b-256 9789440832ebb5451023eaad19efffc1560534dc6aeeefe19c768899deff1d55

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.7-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 fa2d710a5d4b56f10e443fa9443552295f67f13e13837b34f03189862fb015c7
MD5 d0fd0aa781e733c2c17941123deb9e9b
BLAKE2b-256 4fb7eee60763edac1e996df0c3abe87fa7e0d39e3c8f4f70e62fcb08cc3dfd56

See more details on using hashes here.

Provenance

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