@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.19.0 (2026-03-01)

• feat(console): Add Q&A and Ideas community links to Footer (#434, #438)
• fix(console): Add null guards to useServerConfigSnapshots to prevent TypeError (#431, #435)
• fix(console): Disable View History button when less than 2 snapshots (#432, #437)
• docs(npm): Add Q&A and Ideas discussion links to README (#433, #436)

v2.18.0 (2026-02-24)

• refactor: Relocate backup storage paths to <MCCTL_ROOT>/backups/ (#429, #430)
• docs: Simplify CLAUDE.md Project Structure (35% reduction)

v2.17.1 (2026-02-24)

• fix(console): Reorder server backup sub-tabs to show Config Snapshots first, World Backups second

v2.17.0 (2026-02-24)

• feat(console): Implement Backups tab in Server Detail page (#427, #428)
• fix(console): Add missing react-diff-viewer-continued dependency

v2.16.0 (2026-02-23)

• feat: Config Snapshot system - full-stack server configuration versioning (#397~#406)
• feat: Backup retention policy pruning implementation (#396, #426)
• fix: Backup git path and shell injection prevention (#423, #425)

v2.15.3 (2026-02-22)

• docs: Update README.md with Management Console features and architecture (#412, #413)

Full Changelog

Community

• Q&A / Support - Ask questions and get help from the community
• Ideas / Feature Requests - Share your ideas and vote on feature requests

AI Assistant

Get help using mcctl with our AI-powered assistant:

• AI Assistant chatbot - Interactive Q&A about mcctl commands, configuration, and troubleshooting

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

• Full Documentation
• REST API Reference
• GitHub Repository

License

Apache-2.0