cligsm


Namecligsm JSON
Version 0.1.6 PyPI version JSON
download
home_pageNone
SummaryA user-friendly CLI alternative to LinuxGSM for game server management
upload_time2025-01-06 22:56:55
maintainerNone
docs_urlNone
authorAndrew Wade
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)
```bash
# 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
```bash
# Install globally with all dependencies
pip3 install cligsm[all]

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

### System Dependencies (Linux)

On Linux systems, you'll need to install some additional dependencies for SteamCMD:

```bash
# Enable 32-bit architecture
sudo dpkg --add-architecture i386

# Update package lists
sudo apt-get update

# Install required packages
sudo apt-get install -y lib32gcc-s1 lib32stdc++6 lib32gcc1 libsdl2-2.0-0:i386 libtinfo5:i386
```

### Running as Root

If you're running CLIGSM as root (not recommended for production), you'll need to install it globally:

```bash
# Install pipx globally for root
sudo pip3 install pipx
sudo pipx ensurepath

# Install CLIGSM
sudo pipx install cligsm --include-deps

# Or using pip directly
sudo pip3 install cligsm[all]
```

### Troubleshooting Installation

If you get "command not found" after installation:

1. Make sure your PATH includes Python's bin directory:
```bash
echo $PATH
```

2. Find where the package is installed:
```bash
pip3 show cligsm
```

3. Add the bin directory to your PATH if needed:
```bash
export PATH="$HOME/.local/bin:$PATH"  # Add to your ~/.bashrc or ~/.profile
```

4. If you get dependency errors:
```bash
# Try reinstalling with all dependencies
pipx uninstall cligsm
pipx install cligsm --include-deps

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

5. If SteamCMD fails to install:
```bash
# Make sure you have all system dependencies
sudo dpkg --add-architecture i386
sudo apt-get update
sudo apt-get install -y lib32gcc-s1 lib32stdc++6 lib32gcc1 libsdl2-2.0-0:i386 libtinfo5:i386
```

## 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

```bash
# 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

### System Requirements
- Python 3.8 or higher
- Required Python packages:
  - click
  - rich
  - psutil
  - requests
- For Linux systems:
  - 32-bit architecture support
  - Required system libraries (see System Dependencies section)

### Arma 3 Server Requirements
- Minimum 4GB RAM (8GB recommended)
- 20GB free disk space
- Linux, Windows, or macOS
- SteamCMD (automatically installed)
- Proper firewall configuration:
  - Default ports: 2302-2305 TCP/UDP
  - Steam query port: 27016 TCP/UDP

## 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. 
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cligsm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Andrew Wade",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/79/c0/4cbe0a1867a5907f9a8d58d7038ba0d1e266c68224621ac6b60d422bca6f/cligsm-0.1.6.tar.gz",
    "platform": null,
    "description": "# CLIGSM\n\nCLIGSM 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.\n\n## Installation\n\nThere are several ways to install CLIGSM:\n\n### Using pipx (Recommended)\n```bash\n# Install pipx if you haven't already\npython3 -m pip install --user pipx\npython3 -m pipx ensurepath\n\n# Reload your shell's PATH (or restart your terminal)\nsource ~/.bashrc  # or source ~/.profile\n\n# Install CLIGSM with all dependencies\npipx uninstall cligsm  # Remove any existing installation\npipx install cligsm --include-deps\n\n# Verify installation\ncligsm --version\n```\n\n### Using pip\n```bash\n# Install globally with all dependencies\npip3 install cligsm[all]\n\n# Or install for current user only\npip3 install --user cligsm[all]\n```\n\n### System Dependencies (Linux)\n\nOn Linux systems, you'll need to install some additional dependencies for SteamCMD:\n\n```bash\n# Enable 32-bit architecture\nsudo dpkg --add-architecture i386\n\n# Update package lists\nsudo apt-get update\n\n# Install required packages\nsudo apt-get install -y lib32gcc-s1 lib32stdc++6 lib32gcc1 libsdl2-2.0-0:i386 libtinfo5:i386\n```\n\n### Running as Root\n\nIf you're running CLIGSM as root (not recommended for production), you'll need to install it globally:\n\n```bash\n# Install pipx globally for root\nsudo pip3 install pipx\nsudo pipx ensurepath\n\n# Install CLIGSM\nsudo pipx install cligsm --include-deps\n\n# Or using pip directly\nsudo pip3 install cligsm[all]\n```\n\n### Troubleshooting Installation\n\nIf you get \"command not found\" after installation:\n\n1. Make sure your PATH includes Python's bin directory:\n```bash\necho $PATH\n```\n\n2. Find where the package is installed:\n```bash\npip3 show cligsm\n```\n\n3. Add the bin directory to your PATH if needed:\n```bash\nexport PATH=\"$HOME/.local/bin:$PATH\"  # Add to your ~/.bashrc or ~/.profile\n```\n\n4. If you get dependency errors:\n```bash\n# Try reinstalling with all dependencies\npipx uninstall cligsm\npipx install cligsm --include-deps\n\n# Or install missing dependencies manually\npip3 install requests psutil rich click\n```\n\n5. If SteamCMD fails to install:\n```bash\n# Make sure you have all system dependencies\nsudo dpkg --add-architecture i386\nsudo apt-get update\nsudo apt-get install -y lib32gcc-s1 lib32stdc++6 lib32gcc1 libsdl2-2.0-0:i386 libtinfo5:i386\n```\n\n## Features\n\n- Easy-to-use command-line interface\n- Game server management without complex CLI knowledge\n- Support for popular game servers\n- Simplified installation and configuration process\n\n## Usage\n\n```bash\n# Basic command structure\ncligsm [command] [options]\n\n# Arma 3 Server Management\ncligsm arma3 create myserver  # Create a new Arma 3 server\ncligsm arma3 start myserver   # Start the server\ncligsm arma3 stop myserver    # Stop the server\ncligsm arma3 status myserver  # Check server status\n\n# Mission Management\ncligsm arma3 mission install myserver path/to/mission.pbo\ncligsm arma3 mission list myserver\n\n# Backup Management\ncligsm arma3 backup create myserver\ncligsm arma3 backup list myserver\n```\n\n## Server Requirements\n\n### System Requirements\n- Python 3.8 or higher\n- Required Python packages:\n  - click\n  - rich\n  - psutil\n  - requests\n- For Linux systems:\n  - 32-bit architecture support\n  - Required system libraries (see System Dependencies section)\n\n### Arma 3 Server Requirements\n- Minimum 4GB RAM (8GB recommended)\n- 20GB free disk space\n- Linux, Windows, or macOS\n- SteamCMD (automatically installed)\n- Proper firewall configuration:\n  - Default ports: 2302-2305 TCP/UDP\n  - Steam query port: 27016 TCP/UDP\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details. ",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A user-friendly CLI alternative to LinuxGSM for game server management",
    "version": "0.1.6",
    "project_urls": {
        "Homepage": "https://github.com/andrewwade/pygsm",
        "Issues": "https://github.com/andrewwade/pygsm/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52c832cf9b46727da72c25f4b883a7941d0078506409cd01d04e906c11c5df07",
                "md5": "307468c57c02dbe911ab7d6a75a589ee",
                "sha256": "44e7b9ba11474c88a35acc54a030b77e6c5325ff845998eac7653423154f557f"
            },
            "downloads": -1,
            "filename": "cligsm-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "307468c57c02dbe911ab7d6a75a589ee",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16564,
            "upload_time": "2025-01-06T22:56:54",
            "upload_time_iso_8601": "2025-01-06T22:56:54.017030Z",
            "url": "https://files.pythonhosted.org/packages/52/c8/32cf9b46727da72c25f4b883a7941d0078506409cd01d04e906c11c5df07/cligsm-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "79c04cbe0a1867a5907f9a8d58d7038ba0d1e266c68224621ac6b60d422bca6f",
                "md5": "e093b480e3edeb537ee9a6e3634473b4",
                "sha256": "04e3a0baf9a5ebf66633c09662e2e7d3fc37db5544e4b96eee6b13ba257c289a"
            },
            "downloads": -1,
            "filename": "cligsm-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "e093b480e3edeb537ee9a6e3634473b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 14035,
            "upload_time": "2025-01-06T22:56:55",
            "upload_time_iso_8601": "2025-01-06T22:56:55.896731Z",
            "url": "https://files.pythonhosted.org/packages/79/c0/4cbe0a1867a5907f9a8d58d7038ba0d1e266c68224621ac6b60d422bca6f/cligsm-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-06 22:56:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "andrewwade",
    "github_project": "pygsm",
    "github_not_found": true,
    "lcname": "cligsm"
}
        
Elapsed time: 0.52563s