GitHub - gndps/screenux: A long running script management tool for terminal written in bash script.

Screenux - GNU Screen for humans

Screenux is a long-running-script management tool for terminal written in bash script.

It's a GNU Screen wrapper that try to simplify running background processes by providing defaults that make sense.

Works with bash

Comparison with similar tools

# nohup
nohup bash -c 'command' > logfile.log 2>&1 &

# screen
screen -dm -L -Logfile logfile.log bash -c "command"

# tmux
tmux new-session -d "bash -c 'command | tee logfile.log'"

# screenux
screenux run "command"

Installation

# Installs to `~/.local/screenux`
curl -sSL https://raw.githubusercontent.com/gndps/screenux/refs/heads/main/install.sh | bash
source ~/.bashrc
screenux -h

Uninstall

curl -sSL https://raw.githubusercontent.com/gndps/screenux/refs/heads/main/uninstall.sh | bash

Features

Run in background (by default)

• Run bash file in background screen session by default

Log to file (by default)

• Each run have a new log file by default.
• It's possible to set the log file name. Default log file name is sxx_run.
• The logs are saved to ./output/{log_file_name}_{timestamp} by default.
• output directory can be updated using -o param
• The logs are saved to ./output/{log_file_name} by default
• It's possible to use a consistent logfile by setting the name using -n param and -ns i.e. --no-suffix param to disable timestamp suffix

Automatically download dependencies

• auto download screen 4.9.1 if compatible version not found
  • standalone installs
  • no interference with system screen
  • install path: screenux/screen491

Screenux Usage Examples

Basic Usage

Running Commands

# Run a simple command
screenux run "echo Hello World"

# Run a long-running process
screenux run "python my_training_script.py --epochs 100"

# Run with a custom screen session name
screenux run -n training_job1 "python train.py"

# Run in interactive mode (automatically attaches to the screen session)
screenux run -i "top"

# Run with custom output directory for logs
screenux run -o /path/to/logs "npm run build"

Managing Sessions

# List all active screen sessions
screenux list
# or use shortcuts
screenux ls
screenux l

# Attach to a session using index number (from list)
screenux attach 1

# Attach most recent session
screenux a -1

# Attach to a session using full session name
screenux attach training_job1
# or use shortcut
screenux a training_job1

Advanced Examples

Custom Log Management

# Run with custom name and no timestamp suffix in log filename
screenux run -n backup_job --no-suffix "rsync -av /source /destination"

# Run with verbose debugging enabled
screenux run --verbose "python complex_script.py"

# Run with custom output directory and session name
screenux run -n database_backup -o /var/log/backups "pg_dump -U postgres mydb > backup.sql"

Tips and Tricks

Session Management

• Use Ctrl+A, D to detach from a screen session
• Use screenux list to see all active sessions
• Use meaningful names with -n for easier session management
• Use --no-suffix when you want to overwrite log files instead of creating new ones

Logging

• All commands automatically log to files
• View logs in real-time: tail -f /path/to/logs/session_name.log
• Use -o to specify custom log directories
• Logs include command start time and full command string

Interactive Mode

• Use -i or --interactive when you need to interact with the command
• Interactive mode automatically attaches to the screen session
• You can still detach and reattach later as needed

License

screenux is licensed under the MIT License.

Contributions

I'm happy to accept contributions for any new useful features. Some features on my mind are:

• Keep run history log and add commands like screenux history. This will also allow screenux tail -1 to tail most recent session.
• Adding simple https server to view all sessions in a browser.
• ngrok support to the https server by default and print QR code for the url to view logs on phone.