Skip to main content

A CLI alternative to the built-in web interface of Supervisor, offering a more convenient way to manage processes directly from the terminal.

Project description

supervisor-shell-ui

supervisor-shell-ui

supervisor-shell-ui is a command-line interface (CLI) for managing processes using the Supervisor program. Supervisor is a client/server system that allows its users to monitor and control a number of processes on UNIX-like operating systems. This tool provides an alternative to the built-in web interface of Supervisor, offering a more convenient way to manage processes directly from the terminal.

Table of Contents

Features

  • View and manage processes controlled by Supervisor.
  • Start, stop, and restart processes.
  • View and clear process logs.
  • Navigate and interact with the interface using keyboard shortcuts.

Prerequisites

  • Python 3.6 or higher.
  • Supervisor program installed on your system.

Installation

Install from PyPI

pip install supervisor-shell-ui

Install from GitHub

You have two ways to install from GitHub.

First option: clone the repository

git clone https://github.com/psyb0t/supervisor-shell-ui.git
cd supervisor-shell-ui
pip install .

Second option: use pip to install directly from GitHub

pip install git+https://github.com/psyb0t/supervisor-shell-ui.git#egg=supervisor-shell-ui

Both ways will achieve the same result, installing the supervisor-shell-ui package on your system. Choose the one that suits you best.

Install from .tar.gz

First, download the .tar.gz file from the GitHub releases page. Then extract it and navigate to the extracted directory:

tar -xvzf supervisor-shell-ui.tar.gz
cd supervisor-shell-ui

Install using pip:

pip install .

Alternatively, you can also use the setup.py file:

python setup.py install

Usage

After installing, you can run the application with the following command:

supervisor-shell-ui

Keybindings

  • Esc: Exit Page
  • Tab: Switch Section
  • Enter: Execute
  • Page Up/Down: Scroll Table
  • Left/Right Arrow: Change Button
  • Up/Down Arrow: Change Process

Important Notes

  • This application is intended for use on UNIX-like operating systems.
  • The application requires that the Supervisor program is already installed and properly configured on your system.

License

This project is licensed under the terms of the GPL-3.0 license.

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

supervisor-shell-ui-0.2.4.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

supervisor_shell_ui-0.2.4-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file supervisor-shell-ui-0.2.4.tar.gz.

File metadata

  • Download URL: supervisor-shell-ui-0.2.4.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for supervisor-shell-ui-0.2.4.tar.gz
Algorithm Hash digest
SHA256 d23f3607852c455c9e9d5bbc67bc09414b5f986f7a6fce2112eafc0d90569c2e
MD5 74a96207c2351982dfae4a4cf8307b4a
BLAKE2b-256 443a394d4573e9629926b2c2c4fec3bb743031b3c2214b9ccc456fed631ca79e

See more details on using hashes here.

File details

Details for the file supervisor_shell_ui-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for supervisor_shell_ui-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 acd620e09c26e04b0afb38be915dcbc44819d8018f9aa9fbbc2387363f6d3b80
MD5 f6f6c5f13bbecdd4af33f6e745a86e90
BLAKE2b-256 6c2f3b0d0038f8d0b09f8233d120a64c016edc834f8bf4a4e7c69d12db4cb3bd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page