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.3: 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.3-py3-none-manylinux_2_39_x86_64.whl (1.3 MB view details)

Uploaded Python 3manylinux: glibc 2.39+ x86-64

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

Uploaded Python 3macOS 11.0+ ARM64

slurm_term-0.1.3-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.3-py3-none-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for slurm_term-0.1.3-py3-none-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 a95c39a5f7a7ab0b02089bedb3a1d7e27d83dec14a8a649208e8aca73ed6391c
MD5 c73553371a45b1fdf7c965463c91ecbb
BLAKE2b-256 9d4578f2572ab3479b2bf8566b7af11eb9d461d89af1dad86fefcf01c8e2595f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 55bf3ee5042fdbf4c32824b87db6a36aa46775caa61cb89efa0f71dcc3769275
MD5 8c5539c75f3bbf07aab97f193304b664
BLAKE2b-256 548e1c61c44f3efa58243f9e7d687579145558e8669f14fce01eee26e0785e6c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 eb46af963a2a896b786f1b3dda0b022d86c2597bacc63636c462cfbe70c78003
MD5 6683749c353eab37a9d34682c24eee6c
BLAKE2b-256 75a8e4b370a7ca1d2a398a68ffd851e24047dc4795428a0adf2b9c6a8cd6f444

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for slurm_term-0.1.3-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3eda6e3755015e8bfccc501c48b2c7e47a242b76a9297a56a4b712ed94cc941c
MD5 cef9724c8b16b3437dbc091d017b54cb
BLAKE2b-256 b2b95eb693470ffdb234175c7cabda4c5113ad56b21655aca6651bcdd04f4a08

See more details on using hashes here.

Provenance

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