https://github.com/mil-ad/stui

A Slurm dashboard for the terminal.
https://github.com/mil-ad/stui

python slurm slurm-cluster slurm-utility terminal-based tui urwid

Last synced: about 2 months ago
JSON representation

A Slurm dashboard for the terminal.

• Host: GitHub
• URL: https://github.com/mil-ad/stui
• Owner: mil-ad
• License: mit
• Created: 2020-05-28T22:32:02.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-09T17:04:53.000Z (6 months ago)
• Last Synced: 2024-06-09T03:31:53.316Z (3 months ago)
• Topics: python, slurm, slurm-cluster, slurm-utility, terminal-based, tui, urwid
• Language: Python
• Homepage:
• Size: 1.37 MB
• Stars: 71
• Watchers: 0
• Forks: 11
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-high-performance-computing - Stui slurm dashboard for the terminal - A terminal-based UI for managing and monitoring Slurm clusters. (Software / Trends)

README

        
![PyPI](https://img.shields.io/pypi/v/stui)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

# stui

A Slurm dashboard for the terminal.



## Features

* Connect to local Slurm cluster or remote clusters via SSH

* Quickly filter jobs based on commonly-used criteria

* Cancel, attach to, or modify properties of selected jobs.

## Installation

```shell

$ pip install stui

```

## Usage

On a machine that's part of a Slurm cluster simply fire up `stui`:

```shell

$ stui

```

To connect to a remote Slurm cluster via SSH:

```shell

$ stui --ssh REMOTE_HOST

```

where `REMOTE_HOST` is the hostname (or IP address) of the remote machine and may include the user and/or port parameters, of the form `user@host`, `host:port`, or `user@host:port`. If authentication via SSH keys or agent fails you will be prompted to manually enter username and password.