JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 167
  • Score
    100M100P100Q81511F
  • 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

Server Types

Type Description
PAPER Paper server (default, recommended)
VANILLA Official Minecraft server
FORGE Forge mod server
FABRIC Fabric mod server

Requirements

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

Changelog

v1.7.11 (2026-02-04)

  • fix(shared): Check LEVEL config before WORLD_NAME for world size calculation
    • Fixes servers using LEVEL config showing "0 B" for world size

v1.7.10 (2026-02-04)

  • feat(console): Add ANSI color support for console logs
  • feat(console): Add loading indicator with nprogress
  • feat(api,console): Add SSE streaming for server creation (#227, #228)
  • fix: Fix MCCTL_ROOT path resolution (relative to absolute)
  • fix: Fix player list parsing by removing ANSI escape codes from RCON

v1.7.9 (2026-02-03)

  • fix(ci): Fix YAML syntax error in E2E workflow configuration

v1.7.8 (2026-01-31)

  • feat(cli): Add selective console service support - choose api/console/all (#203)
  • fix(cli): Correct environment variable names for mcctl-api auth (#203)

v1.7.7 (2026-01-31)

  • feat(cli): Auto-install mcctl-api on console init

v1.7.6 (2026-01-31)

  • feat(mcctl-api): First npm release of REST API package

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