Home

CreeperCLI wiki

CreeperCLI manages Paper and Spigot Minecraft servers from the terminal. A Java plugin runs on the server; a Node CLI (creepercli, installed from npm) runs on your computer. Licensed under the Apache License 2.0.

Pages

Page	Covers
Getting started	Install, first user, first login, SSH tunnel
CLI commands	Every command, flag, and example
Console commands	/creepercli administration
Configuration	Every config.yml key, auto-migration
Security	Threat model, 2FA, sandbox, rate limits
Protocol	Wire format, actions, events, error codes
Plugin API	Extension API for Paper/Spigot developers
Architecture	Threading model, sandbox design, extensions
Advanced	Editing, sync, monitoring, scripting
Troubleshooting	Common errors, FAQ, tests

Quick start

# server console
/creepercli user add alice 'a-strong-password-123'

# your machine
npm install -g creepercli
creepercli login --host <server-ip> --port 45678

You land in the interactive shell. Try ls /, stats, exec list. q quits.

Security in one line

The plugin binds 0.0.0.0:45678 by default. On a machine you control, set network.host: "127.0.0.1" and reach it through an SSH tunnel. Full details on the security page.