JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 167
  • Score
    100M100P100Q81508F
  • License Apache-2.0

CLI tool for managing Docker Minecraft servers with mc-router

Package Exports

  • @minecraft-docker/mcctl
  • @minecraft-docker/mcctl/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@minecraft-docker/mcctl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@minecraft-docker/mcctl

CLI tool for managing Docker Minecraft servers with mc-router.

Features

  • Multi-server management with hostname-based routing
  • Auto-scaling: Servers start on connect, stop when idle
  • Interactive mode: Guided prompts for all operations
  • World management: Assign and release worlds between servers
  • Backup system: GitHub-based world backup and restore

Installation

npm install -g @minecraft-docker/mcctl

Quick Start

# Initialize platform in ~/minecraft-servers
mcctl init

# Create a new server (interactive)
mcctl create

# Create with arguments
mcctl create myserver -t PAPER -v 1.21.1

# Check server status
mcctl status

# Start/stop servers
mcctl start myserver
mcctl stop myserver

# View logs
mcctl logs myserver

Commands

Command Description
mcctl init Initialize the platform
mcctl create [name] Create a new server
mcctl delete [name] Delete a server
mcctl status Show all server status
mcctl start <name> Start a server
mcctl stop <name> Stop a server
mcctl logs <name> View server logs
mcctl world list List all worlds
mcctl world assign Assign world to server
mcctl world release Release world from server
mcctl backup push Backup worlds to GitHub
mcctl backup restore Restore worlds from backup
mcctl update Update mcctl CLI to latest version
mcctl update --all Update CLI and all installed services

Server Types

Type Description
PAPER Paper server (default, recommended)
VANILLA Official Minecraft server
FORGE Forge mod server
NEOFORGE NeoForge mod server (1.20.1+)
FABRIC Fabric mod server
MODRINTH Modrinth modpack server

Requirements

  • Node.js >= 18.0.0
  • Docker & Docker Compose
  • Linux or macOS

Changelog

v2.3.0 (2026-02-12) - External Play (playit.gg)

  • feat(shared): Add playit.gg domain model and Docker helpers (#291, #328)
  • feat: Add playit.gg tunnel agent to docker-compose templates (#270, #327)
  • feat(cli): Add playit.gg setup option to mcctl init (#271, #329)
  • feat(cli): Add playit.gg domain registration to mcctl create --playit-domain (#272, #330)
  • feat(cli): Add mcctl playit subcommand - start/stop/status/setup (#273, #331)
  • feat(api): Add playit.gg status and control API endpoints (#292, #332)
  • feat(console): Add playit.gg external access UI - PlayitSummaryCard, ConnectionInfoCard, PlayitSection (#274, #333)
  • docs: Add playit.gg integration guide in English and Korean (#275, #334)
  • feat(api): Add comprehensive audit logging to all mutating routes (#324, #325)
  • fix(console): Unify Add and Bulk button sizes in WhitelistManager (#322, #323)

v2.2.0 (2026-02-11)

  • feat(console): Whitelist Console UI - toggle ON/OFF, bulk player add, search/filter (#283, #321)
  • feat: Enable whitelist by default on mcctl create (#282, #320)
  • feat(console): Hostname/domain management in server Options tab (#314, #315)
  • fix(console): Fix 23 pre-existing failing unit tests (#296, #316)

v2.1.0 (2026-02-09) - Console Feature Completion

  • feat: Modrinth modpack CLI/API support - search, create, manage modpack servers (#244, #245)
  • feat: Admin user management Console UI - list, detail, role management (#189)
  • feat: OP Level support across all layers - domain model, CLI, API, Console (#284, #285, #286, #287)
  • fix: Console sign-out 403 bug with LAN IP addresses (#300, #301)
  • feat: Offline player management support (#288, #289)

v2.0.0 (2026-02-09)

  • Major version bump - Management Console (Web UI + REST API) feature complete

v1.15.5 (2026-02-08)

  • fix(cli): Fix Better Auth password hashing - use hex string salt for compatibility
  • fix(cli): Add MCCTL_API_KEY env var to mcctl-console PM2 config (#261)

Full Changelog

AI Assistant

Get help using mcctl with our AI-powered assistant:

You can also use the LLM Knowledge Base with ChatGPT, Claude, or other AI assistants:

  1. Download the knowledge base document
  2. Upload to your preferred AI assistant
  3. Ask questions about mcctl usage

Documentation

License

Apache-2.0