Skip to main content

​
Overview

The MCMP CLI provides comprehensive access to the PaperMC API for managing Paper server downloads and information. All commands support case-insensitive project names and multiple output formats.

​
Projects Command

List all available PaperMC projects. 
mcmp tool paper projects [OPTIONS]

​
Options

​
--output, -o
string
Output format: json, json-pretty, toml, toml-pretty, yaml

​
Examples

# List all projects
mcmp tool paper projects

# List with JSON output
mcmp tool paper projects --output json-pretty

​
Project Command

Get detailed information about a specific project. 
mcmp tool paper project <PROJECT> [OPTIONS]

​
Options

​
project
string
required
Project name (e.g., paper, velocity, waterfall)
​
--output, -o
string
Output format

​
Examples

# Get Paper project info
mcmp tool paper project paper

# Case-insensitive (all work the same)
mcmp tool paper project Paper
mcmp tool paper project PAPER

# Get Velocity project info
mcmp tool paper project velocity

​
Versions Command

List all versions for a project. 
mcmp tool paper versions <PROJECT> [OPTIONS]

​
Options

​
project
string
required
Project name
​
--all, -a
boolean
Show all versions (including pre-releases)
​
--number, -n
number
Number of versions to show per group
​
--output, -o
string
Output format
​
--flatten
boolean
Flatten output (single array instead of grouped)

​
Examples

# List Paper versions
mcmp tool paper versions paper

# Show all versions including pre-releases
mcmp tool paper versions paper --all

# Show only latest 5 versions per group
mcmp tool paper versions paper --number 5

​
Version Command

Get information about a specific version. 
mcmp tool paper version <PROJECT> <VERSION> [OPTIONS]

​
Options

​
project
string
required
Project name
​
version
string
required
Version number
​
--output, -o
string
Output format

​
Examples

# Get Paper 1.21.1 info
mcmp tool paper version paper 1.21.1

# Get Velocity 3.2.0 info
mcmp tool paper version velocity 3.2.0

​
Builds Command

List all builds for a project version. 
mcmp tool paper builds <PROJECT> <VERSION> [OPTIONS]

​
Options

​
project
string
required
Project name
​
version
string
required
Version number
​
--output, -o
string
Output format

​
Examples

# List builds for Paper 1.21.1
mcmp tool paper builds paper 1.21.1

​
Build Command

Get information about a specific build. 
mcmp tool paper build <PROJECT> <VERSION> <BUILD> [OPTIONS]

​
Options

​
project
string
required
Project name
​
version
string
required
Version number
​
build
number
required
Build number
​
--output, -o
string
Output format

​
Examples

# Get build 123 info for Paper 1.21.1
mcmp tool paper build paper 1.21.1 123

​
Latest Command

Get the latest build for a project version. 
mcmp tool paper latest <PROJECT> <VERSION> [OPTIONS]

​
Options

​
project
string
required
Project name
​
version
string
required
Version number
​
--output, -o
string
Output format

​
Examples

# Get latest build for Paper 1.21.1
mcmp tool paper latest paper 1.21.1

​
Download Command

Download PaperMC server builds with flexible options. 
mcmp tool paper download [OPTIONS]

​
Options

​
--project, -p
string
Project name (if not specified, will prompt interactively)
​
--version, -v
string
Version (if not specified, uses latest)
​
--build, -b
number
Build number (if not specified, uses latest for the version)
​
--output, -o
string
Output path (defaults to current directory)
​
--download-type, -t
string
Download type (e.g., server, application) - if not specified, uses the first available download
​
--cwd
string
Working directory for the download (changes current directory before download)
​
--interactive, -i
boolean
Use interactive mode

​
Examples

# Interactive download (recommended)
mcmp tool paper download --interactive

# Download latest Paper 1.21.1
mcmp tool paper download --project paper --version 1.21.1

# Download specific build
mcmp tool paper download --project paper --version 1.21.1 --build 123

# Download to specific directory
mcmp tool paper download --project paper --version 1.21.1 --output ./server/

# Download specific artifact type
mcmp tool paper download --project paper --version 1.21.1 --download-type server:default

​
Common Workflows

​
Quick Server Setup

# 1. Find the latest version
mcmp tool paper versions paper

# 2. Get the latest build for that version
mcmp tool paper latest paper 1.21.1

# 3. Download it
mcmp tool paper download --project paper --version 1.21.1 --build 123 --output ./server/

​
Automated Server Downloads

# Download latest Paper 1.21.1 build to a new server directory
mkdir my-server
mcmp tool paper latest paper 1.21.1  # Note the build number
mcmp tool paper download --project paper --version 1.21.1 --build <BUILD_NUMBER> --output my-server/

​
Development Workflow

# Set up development server
mcmp tool paper download --interactive

# Build your plugin
mcmp build --watch

# Test with your server
mcmp run --watch

​
Output Formats

All PaperMC commands support multiple output formats:
  • Default: Human-readable table format
  • JSON: --output json
  • Pretty JSON: --output json-pretty
  • TOML: --output toml
  • Pretty TOML: --output toml-pretty
  • YAML: --output yaml
This makes it easy to integrate with scripts and automation tools.