Skip to main content

​
Installation

The MCMP CLI is a powerful command-line tool for managing Minecraft servers and development workflows. 
curl -fsSL https://raw.githubusercontent.com/minecraftmultiplayer/mcmp/main/install-simple.sh | bash

​
Alternative Installation Methods

Using Cargo (for development): 
cargo install mcmp_cli
Build from source: 
git clone https://github.com/minecraftmultiplayer/mcmp
cd mcmp/cli
cargo build --release --bin mcmp
Manual download: Visit the releases page to download pre-built binaries for your platform. For detailed installation instructions, see our Installation Guide.

​
Features

  • ✅ Case-insensitive project names - Use Paper, paper, or PAPER - they all work!
  • ✅ Shell completions - Tab completion for Bash, Zsh, Fish, PowerShell, and Elvish
  • ✅ Colored output - Easy-to-read terminal output
  • ✅ Download support - Download server JARs with checksum verification
  • ✅ Helpful error messages - Clear, actionable error messages when resources don’t exist
  • ✅ Watch mode - Automatically rebuild and rerun applications on file changes
  • ✅ Dependency management - Add and manage Java dependencies
  • ✅ PaperMC integration - Direct access to PaperMC API for server downloads

​
Quick Start

​
Generate Shell Completions

Bash: 
mcmp completions bash > ~/.local/share/bash-completion/completions/mcmp
Zsh: 
mcmp completions zsh > ~/.zsh/completions/_mcmp
# Add to ~/.zshrc: fpath=(~/.zsh/completions $fpath)
Fish: 
mcmp completions fish > ~/.config/fish/completions/mcmp.fish
PowerShell: 
mcmp completions powershell | Out-String | Invoke-Expression

​
Basic Usage

# Get help
mcmp --help

# Build a Java project
mcmp build

# Run a Java application
mcmp run

# Download latest Paper server
mcmp tool paper download --interactive

​
Command Structure

The MCMP CLI is organized into several command categories:
  • Core Commands: build, run, add, tree, repo
  • Tool Commands: tool paper (PaperMC integration)
  • Utility Commands: completions
Each command supports extensive options and flags for customization. Use mcmp <command> --help to see detailed usage information for any command.