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.4.0 (2026-02-14)

feat(cli): Add mcctl upgrade command for upgrading mcctl and all services (#326, #355)
feat(cli): Add creeper ASCII banner with version check on mcctl init (#353, #354)
feat(console): Implement Mods tab functionality (#351, #352)
refactor(console): Rename 'Content' tab to 'Mods' in server detail page (#349, #350)
feat(cli): Add mcctl playit domain subcommand (#347, #348)
docs: Update documentation for v2.4.0 with upgrade command and playit.gg guides

v2.3.5 (2026-02-12)

fix(shared): Use correct container name playit-agent in getPlayitAgentStatus() (#345, #346)
fix(console): Add error feedback for playit start/stop actions (#343)
fix(console): Improve playit section header layout and server domains display (#343, #344)

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

feat(cli): Add mcctl playit subcommand - start/stop/status/setup (#273, #331)
feat(cli): Add playit.gg setup option to mcctl init (#271, #329)
feat(api): Add playit.gg status and control API endpoints (#292, #332)
feat(console): Add playit.gg external access UI (#274, #333)
feat(api): Add comprehensive audit logging to all mutating routes (#324, #325)

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)

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

feat: Modrinth modpack CLI/API support (#244, #245)
feat: Admin user management Console UI (#189)
feat: OP Level support across all layers (#284, #285, #286, #287)

Full Changelog

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:

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

Documentation

License

Apache-2.0