Skip to main content

A simple Terminal UI (TUI) for Slurm

Project description

SlurmTUI

PyPI version PyPI - Downloads

A terminal user interface for monitoring and managing Slurm jobs. Instead of running squeue, sacct, and scancel over and over, you get a live-updating table of your jobs with colors, sorting, filtering, and shortcuts to tail logs, SSH into nodes, or delete jobs — all without leaving the TUI.

Built with Textual and Rich.

Note: SlurmTUI requires Slurm 21.08 or later for JSON output support.

Note: Viewing old jobs requires Slurm 24.05 or later.

Installation

pip install slurmtui

Usage

Just run slurmtui / slurmui / sui in your terminal.

Command-line options

Filter by account at launch:

slurmtui --acc my_account1,my_account2

View all users' jobs:

slurmtui --check_all_jobs

Override the update interval:

slurmtui --update-interval 5

Pass extra arguments to squeue:

slurmtui -- --partition=gpu

Settings

All preferences are stored in ~/.config/slurmtui/settings.json and persist across sessions. You can override the settings path by setting the SLURMTUI_SETTINGS environment variable.

Features

Live Job Table

The main view auto-refreshes every few seconds, showing your jobs with colored states (green for running, red for failed, etc.). Filter jobs by account, partition, or any column.

Job Table

Keybindings

Key Action
L Tail stdout log
E Tail stderr log
Ctrl+L Open stdout in secondary text viewer
Ctrl+E Open stderr in secondary text viewer
C SSH into the job's node
D Delete a job (with confirmation, works with array jobs)
I View detailed job info
O Toggle old jobs history (completed/failed via sacct)
R Open hardware resources view

The log viewer can be configured to use tail -f, less, or any command you want.

Old Jobs History

View completed/failed job history via sacct. Press O to toggle. For more info see the linked blog post

Hardware Resources View

See node allocation and availability across the cluster. Press R to open. For more info see the linked blog post.

Roadmap

  • View old jobs
  • Filtering jobs when launching
  • Sorting
  • Options other than tail for logs
  • Faster launch
  • Remove Array columns if no job array exists
  • Display used/available resources
  • Search

Have a feature request? Suggest it here

FAQ

How to select text in the App?

SlurmTUI runs a Textual app which puts your terminal into application mode, disabling clicking and dragging to select text. Most terminal emulators offer a modifier key which you can hold while you click and drag to restore normal selection:

  • iTerm — Hold the OPTION key.
  • Gnome Terminal — Hold the SHIFT key.
  • Windows Terminal — Hold the SHIFT key.

Refer to the documentation for your terminal emulator if it is not listed above.

License

MIT

Contact

Project details


Download files

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

Source Distribution

slurmtui-0.6.3.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

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

slurmtui-0.6.3-py3-none-any.whl (34.0 kB view details)

Uploaded Python 3

File details

Details for the file slurmtui-0.6.3.tar.gz.

File metadata

  • Download URL: slurmtui-0.6.3.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for slurmtui-0.6.3.tar.gz
Algorithm Hash digest
SHA256 047df2954f7ae1de076d87bebdcf70dd2ddc42fbbfdae05c0ad2bb81e1a5285b
MD5 da1e9fe59604643edc54996b48d017eb
BLAKE2b-256 2dd3ff6f992ba1ed1ff2663e1a96c9ef87ad2c25c77867e063ef254e6109b6d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurmtui-0.6.3.tar.gz:

Publisher: publish-to-pypi.yml on WissamAntoun/SlurmTUI

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

File details

Details for the file slurmtui-0.6.3-py3-none-any.whl.

File metadata

  • Download URL: slurmtui-0.6.3-py3-none-any.whl
  • Upload date:
  • Size: 34.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for slurmtui-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ebbd7a2a40f8ad07846e30c321e028038b6714b72fc92d472db6e95c5fdb208b
MD5 b44bedd39b609372ce608ace99af3a76
BLAKE2b-256 dd51b4b1d8e6583345b105c74e1ef16ac7efddbf4b119106b5b65c1272f8fe77

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurmtui-0.6.3-py3-none-any.whl:

Publisher: publish-to-pypi.yml on WissamAntoun/SlurmTUI

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