Skip to main content

MCServer

About

A CLI tool to manage Minecraft: Java Edition servers.

Platform

Supported platforms:

  • Linux
  • and Termux.

Requirements

  • Python 3.12 or newer (Python 3.14 is recommended)
  • JRE (depends on Minecraft version)

How to install

  • Using pip: Just run pip install mcserver-cli

  • System-wide (Requires root):

  1. Download the mcserver script file from GitHub releases
  2. Move the file to /usr/local/bin
  3. Run chmod +x mcserver
  • Per-user:
  1. Create a directory "bin"
  2. Download the script from GitHub releases onto that directory
  3. Give it "executable" permission with chmod +x mcserver
  4. Add the directory in the PATH environment:
    • Run export PATH=$HOME/bin:$PATH if you're using shell that is POSIX-compliant like Bash, Zsh, or ash
    • Run fish_add_path ~/bin if you're using FISH

Usage

  • Add mods or plugins: mcserver add <projects>
  • Initialize a server: mcserver init [options]
  • Grant players operator: mcserver op grant <player> [options]
  • List operator players: mcserver op list
  • Revoke operator players: mcserver op revoke <players>
  • Search projects: mcserver search [query] [options]
  • Show information about projects: mcserver show <projects>
  • Start the server: mcserver start
  • Stop the server: mcserver stop
  • Add players to whitelist: mcserver whitelist add <players> [options]
  • List whitelisted players: mcserver whitelist list
  • Remove whitelisted players: mcserver whitelist remove <players>

Examples

  • Create a Fabric 1.20.1 server, add Thdilos' Fox Origin, and start the server
mcserver init --game-version=1.20.1 --loader=fabric
mcserver add thdilos-fox-origin
mcserver start
  • Search 50 Fabric mods for Minecraft 1.20.1 from Modrinth
mcserver search --loader=fabric --game-version=1.20.1 --limit=50
  • List all operator and whitelisted players on current directory
mcserver op list
mcserver whitelist list
  • Adding a player to the whitelist
mcserver whitelist add Notch
  • Granting Notch operator level 4 and can bypass player limit and list all operators
mcserver op grant Notch --permission-level=4 --bypasses-player-limit
mcserver op list
  • Remove me from the whitelist
mcserver whitelist remove Othecat35
  • Stop a running server on current directory with sigterm
mcserver stop

Note

This is a Personal Project by Othecat35, so don't expect much from me :>

Metadata

Release files for mcserver-cli 4.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mcserver-cli 4.8.1
File Size Uploaded Provenance Actions
mcserver_cli-4.8.1.tar.gz 59.7 kB Without provenance Details for mcserver_cli-4.8.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mcserver-cli 4.8.1
File Interpreter ABI Platform Actions
mcserver_cli-4.8.1-py3-none-any.whl Python 3 none any Details for mcserver_cli-4.8.1-py3-none-any.whl

Total release size: 132.6 kB

Release files / mcserver_cli-4.8.1.tar.gz

Download URL mcserver_cli-4.8.1.tar.gz
Size 59.7 kB
Tags Source
SHA-256 checksum
How to use checksums
71bf8a0052358382f266ecf1009c1dec9bcd0b17ea8f767da28c22b6e8d5f269
BLAKE2b-256 checksum
How to use checksums
6059ed07c1a33db7ee99da7579dc8192b01d1d666fcee513ee17b6f1d4c5e0f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / mcserver_cli-4.8.1-py3-none-any.whl

Download URL mcserver_cli-4.8.1-py3-none-any.whl
Size 72.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8959692daab6f97a5813f846d8434aed15a2e7b7226a53d8ab1f9e31ecebe6a4
BLAKE2b-256 checksum
How to use checksums
944c0e5c733a12c66e6eaa8291b25a82a7f4844e237719edcd372da8c0ad7a55
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for mcserver-cli 4.8.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page