🚨 WARNING: This project is under active development and may break at any time. Avoid using in production until version 1.0.0! 🚨

Server Tools (st)

st is a lightweight, modular CLI tool built for managing headless Ubuntu servers with ease — updates, installs, backups, and diagnostics, all in one place.

---

Features

• 🔄 Easy system updates and upgrades
• 📦 Quick install/uninstall for popular utilities (Docker, btop, eza, neofetch, ncdu, duf, vnstat, ufw, bat, rclone, restic, resticprofile)
• 🎨 Colorful, readable output for all commands
• 🧾 System info and health checks
• 💾 Disk usage and SMART status
• 🌐 Network utilities (interfaces, speedtest, public/local IP, Wi-Fi info)
• 🔒 Tailscale VPN management (up, down, status)
• 💬 Telegram integration for notifications and file sending
• 🖥️ Tmux session management (create, attach, list, kill, cheatsheet)
• 🔑 SSH key and connection management
• ☁️ Rclone and Restic backup utilities
• 🧩 Modular and extensible command structure

---

Table of Contents

• Server Tools (st)
  • Features
  • Table of Contents
  • Installation
  • Usage
    • Example Commands
  • Command Helper
    • st docker
    • st rclone
    • st restic
    • st resticprofile
    • st ssh
    • st config
    • st install
    • st uninstall
    • st system
    • st systemctl
    • st network
    • st telegram
    • st tmux
    • st tailscale
    • st tools
  • Configuration
  • Development
  • Requirements
  • Why use st?
  • Community & Support
  • Contributing
  • Security
  • Credits
  • Screenshots

---

Installation

curl -sL https://raw.githubusercontent.com/Shrikshel/server-tools/main/scripts/install.sh | bash

To uninstall:

curl -sL https://raw.githubusercontent.com/Shrikshel/server-tools/main/scripts/uninstall.sh | bash

📦 .deb package and GitHub Releases coming soon!

---

Usage

After installation, use the st command:

st [COMMAND] [SUBCOMMAND] [OPTIONS]

Example Commands

st system update            # Update system packages
st system upgrade           # Upgrade system packages
st system update-upgrade    # Update & upgrade together
st system info              # Show system info
st system disk              # Show disk usage
st system smart             # Show SSD SMART stats
st install docker           # Install Docker
st uninstall btop           # Uninstall btop
st reboot                   # Reboot the system
st poweroff                 # Power off the system
st sudosu                   # Switch to superuser mode

---

Command Helper

st docker

Docker management commands for containers and Compose stacks:

Description	Full Command	Alias
Docker Related Utilities	st docker	st dc
Docker Compose Related Utilities	st docker compose	st dc c
Manage Docker Compose stacks	st docker compose manage-stacks	st dc c ms
Stop all running containers	st docker compose stop-all	st dc c stop
Start all stopped containers	st docker compose start-all	st dc c start

st rclone

Rclone utilities for syncing and managing cloud/local storage:

Description	Full Command	Alias
Rclone Related Utilities	st rclone	st rc
Dry run of rclone sync	st rclone dry-sync	st rc ds
Perform rclone sync	st rclone sync	st rc s
Perform rclone copy	st rclone copy	st rc c

st restic

Restic backup and restore utilities:

Description	Full Command	Alias
Restic Related Utilities	st restic	st rs
List Restic Snapshots	st restic snapshots	st rs snap
List Snapshots (full)	st restic snapshots --full
Check Restic Repository	st restic check	st rs chk
Restore from Snapshot	st restic restore <id> <target>	st rs rst

st resticprofile

Restic Profile Management:

Description	Full Command	Alias
Restic Profile Management	st resticprofile	st rp
Show Restic Profile Details	st resticprofile show <profile>	st rp s
List Snapshots in Restic Profile	st resticprofile snapshots <profile>	st rp ss

st ssh

SSH key and connection management:

Description	Full Command	Alias
SSH Related Utilities	st ssh	st s
Generate SSH Key Pair	st ssh keygen	st s k

st config

Manage server tool configuration files:

Description	Full Command	Alias
Config Tools	st config	st conf
Show Config	st config show	st conf s
Edit Config	st config edit	st conf e
Verify Config	st config verify	st conf v
Source Config	st config source	st conf so

st install

Install popular packages with a single command:

Description	Full Command	Alias
Install all	st install all
Guided install tour	st install guided
Install Docker	st install docker	st i docker
Install btop	st install btop	st i btop
Install eza	st install eza	st i eza
Install neofetch	st install neofetch	st i neofetch
Install ncdu	st install ncdu	st i ncdu
Install duf	st install duf	st i duf
Install vnstat	st install vnstat	st i vnstat
Install ufw	st install ufw	st i ufw
Install bat	st install bat	st i bat
Install rclone	st install rclone	st i rclone
Install restic	st install restic	st i restic
Install resticprofile	st install resticprofile	st i resticprofile

st uninstall

Uninstall packages with a single command:

Description	Full Command	Alias
Uninstall all	st uninstall all
Guided uninstall tour	st uninstall guided
Uninstall Docker	st uninstall docker	st un docker
Uninstall btop	st uninstall btop	st un btop
Uninstall eza	st uninstall eza	st un eza
Uninstall neofetch	st uninstall neofetch	st un neofetch
Uninstall ncdu	st uninstall ncdu	st un ncdu
Uninstall duf	st uninstall duf	st un duf
Uninstall vnstat	st uninstall vnstat	st un vnstat
Uninstall ufw	st uninstall ufw	st un ufw
Uninstall bat	st uninstall bat	st un bat
Uninstall rclone	st uninstall rclone	st un rclone
Uninstall restic	st uninstall restic	st un restic
Uninstall resticprofile	st uninstall resticprofile	st un resticprofile

st system

System management utilities for updates and diagnostics:

Description	Full Command	Alias
System Utilities	st system	st sys
Update System Packages	st system update	st sys upd
Upgrade System Packages	st system upgrade	st sys upg
Update & Upgrade Packages	st system update-upgrade	st sys updu
Show system info	st system info	st sys info
Show SSD SMART stats	st system smart	st sys smart
Show disk usage stats	st system disk	st sys disk

st systemctl

Systemd control utilities for managing services and viewing logs:

Description	Full Command	Alias
Systemd Control Utilities	st systemctl	st sc
Start a systemd service	st systemctl start <service>	st sc start
Stop a systemd service	st systemctl stop <service>	st sc stop
Restart a systemd service	st systemctl restart <service>	st sc restart
Check status of a systemd service	st systemctl status <service>	st sc status
Enable a service to start on boot	st systemctl enable <service>	st sc enable
Disable a service from starting	st systemctl disable <service>	st sc disable
List all systemd services	st systemctl list	st sc list
View service logs	st systemctl logs <service>	st sc logs
Reload systemd manager config	st systemctl daemon-reload	st sc daemon-reload

st network

Network helper scripts:

Description	Full Command	Alias
Network Helper Scripts	st network	st net
Show network interfaces	st network interfaces	st net ifs
Show link speed	st network linkspeed	st net speed
Run a network speed test	st network speedtest	st net st
Show public IP address	st network publicip	st net pip
Show local IP address	st network localip	st net lip
Show Wi-Fi information	st network wifiinfo	st net wifi

st telegram

Telegram integration (requires ST_TELEGRAM_BOT_TOKEN and ST_TELEGRAM_CHAT_ID environment variables):

Description	Full Command	Alias
Send a message	st telegram send --message "text"	st tg s
Send a file	st telegram send-file --file-path /path/to/file	st tg sf

st tmux

Terminal multiplexer utilities for managing tmux sessions:

Description	Full Command	Alias
Tmux Utilities	st tmux
New Session	st tmux new-session <name>	st tmux ns
Attach to Session	st tmux attach-session <name>	st tmux as
List Sessions	st tmux list-sessions	st tmux ls
Kill Session	st tmux kill-session <name>	st tmux ks
Tmux Cheatsheet	st tmux cheatsheet	st tmux cs

st tailscale

Tailscale VPN management commands:

Description	Full Command	Alias
Tailscale Utilities	st tailscale	st ts
Start Tailscale	st tailscale up	st ts u
Stop Tailscale	st tailscale down	st ts d
Show Tailscale status	st tailscale status	st ts s

st tools

Additional utility scripts for Server Tools:

Description	Full Command	Alias
Update Server Tools CLI	st self-update	st update
Uninstall Server Tools CLI	st uninstall
Launch interactive TUI menu (gum)	st ui
Reboot the system	st reboot	st r
Power off the system	st poweroff	st off
Switch to superuser mode	st sudosu	st su

---

Configuration

st reads config from $HOME/.config/.st.conf (or the path in ST_CONFIG_FILE).

To edit the config:

nano $HOME/.config/.st.conf
# OR if you use a custom path
nano "$ST_CONFIG_FILE"

Example:

# ~/.config/.st.conf
NO_COLOR=1

---

Development

To contribute or run Server Tools locally:

1. Clone the repository:

   git clone https://github.com/Shrikshel/server-tools.git
   cd server-tools

2. Install dependencies:
   • Install RubyGems (if not already installed):

     sudo apt install rubygems -y

   • Install gum (optional):

     sudo apt install gum -y

3. Install Bashly CLI:

   sudo gem install bashly

4. Build the CLI (after making changes to bashly.yml):

   bashly generate

---

Requirements

• Ubuntu/Debian-based Linux
• Bash 4+
• sudo privileges

---

Why use st?

• Saves time: Run common admin tasks with single commands
• Reduces errors: Built-in, tested scripts
• Great for headless servers: No GUI needed
• Easy to extend: Modular Bashly CLI
• Modern TUI: Interactive menu for all commands
• Cloud & backup ready: Rclone, Restic, Tailscale, Telegram, and more
• Actively maintained: Open to feedback and contributions
• Secure: No data collection, open source, and transparent

---

Community & Support

• GitHub Discussions — Ask questions, share ideas, or get help
• Report Issues — Found a bug? Open an issue!

---

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines. You can help by:

• Reporting bugs
• Suggesting features
• Submitting pull requests

---

Security

If you discover a security vulnerability, please report it responsibly by opening a private issue or contacting the maintainer.

---

Credits

• Bashly — CLI framework
• gum — TUI components
• rclone, restic, tailscale, and others

---

Screenshots

Main TUI Menu

Software Install Menu

Docker Compose: Start All, Stop All, Manage Stacks

---

Server Tools (st) — Effortless server management for everyone!