cligsm 0.1.3

A user-friendly CLI alternative to LinuxGSM for game server management

CLIGSM

CLIGSM is a user-friendly CLI alternative to LinuxGSM for game server management. It provides an intuitive interface for managing game servers without requiring extensive command-line knowledge.

Installation

There are several ways to install CLIGSM:

Using pipx (Recommended)

# Install pipx if you haven't already
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Reload your shell's PATH (or restart your terminal)
source ~/.bashrc  # or source ~/.profile

# Install CLIGSM with all dependencies
pipx uninstall cligsm  # Remove any existing installation
pipx install cligsm --include-deps

# Verify installation
cligsm --version

Using pip

# Install globally with all dependencies
pip3 install cligsm[all]

# Or install for current user only
pip3 install --user cligsm[all]

Manual Installation

# Install system dependencies first (Ubuntu/Debian)
sudo apt update
sudo apt install python3-pip python3-venv

# Then install CLIGSM
pip3 install --user cligsm[all]

Troubleshooting Installation

If you get "command not found" after installation:

1. Make sure your PATH includes Python's bin directory:

echo $PATH

2. Find where the package is installed:

pip3 show cligsm

3. Add the bin directory to your PATH if needed:

export PATH="$HOME/.local/bin:$PATH"  # Add to your ~/.bashrc or ~/.profile

4. If you get dependency errors:

# Try reinstalling with all dependencies
pipx uninstall cligsm
pipx install cligsm --include-deps

# Or install missing dependencies manually
pip3 install requests psutil rich click

Features

• Easy-to-use command-line interface
• Game server management without complex CLI knowledge
• Support for popular game servers
• Simplified installation and configuration process

Usage

# Basic command structure
cligsm [command] [options]

# Arma 3 Server Management
cligsm arma3 create myserver  # Create a new Arma 3 server
cligsm arma3 start myserver   # Start the server
cligsm arma3 stop myserver    # Stop the server
cligsm arma3 status myserver  # Check server status

# Mission Management
cligsm arma3 mission install myserver path/to/mission.pbo
cligsm arma3 mission list myserver

# Backup Management
cligsm arma3 backup create myserver
cligsm arma3 backup list myserver

Server Requirements

• Python 3.8 or higher
• Required Python packages:
  • click
  • rich
  • psutil
  • requests
• For Arma 3 servers:
  • Minimum 4GB RAM
  • 20GB free disk space
  • Linux, Windows, or macOS

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.