Quick Start
Get from a clean install to a running Minecraft server in minutes.
Get from a clean install to a running Minecraft server as fast as possible. The whole process takes under a minute.
What you'll need
Cliff is a single self-contained binary — no Docker, no Node.js runtime, no external database. Just download and run. The only thing you need on your machine is a Java runtime for the Minecraft server itself (Cliff can install one for you).
Install Cliff
Run the one-command installer for your platform. It downloads the prebuilt binary, starts the daemon, and prints your dashboard URL.
irm getcliff.dev/install.ps1 | iexThe installer downloads the prebuilt Windows binary, starts the daemon, and prints your dashboard URL.
To use a custom port:
irm getcliff.dev/install.ps1 | iex -- -p 8081curl -fsSL getcliff.dev/install.sh | shThe installer detects your platform and architecture (Intel/Apple Silicon on macOS, amd64/ARM64 on Linux), downloads the correct binary, starts the daemon, and prints your dashboard URL.
To use a custom port:
curl -fsSL getcliff.dev/install.sh | sh -s -- -p 8081That's it
The daemon is now running. Skip ahead to Open the dashboard.
CLI commands
After installing, the cliff command is available in your terminal:
| Command | Description |
|---|---|
cliff start | Start the daemon in the background |
cliff stop | Stop a running daemon |
cliff status | Show daemon status (URL, uptime, PID) |
cliff update | Check for and apply updates |
cliff uninstall | Remove Cliff from this machine |
cliff version | Print version information |
cliff help | Show all commands and flags |
Prefer a manual download or building from source? See Installation.
Open the dashboard
Open your browser to the URL the installer printed:
- Local:
http://localhost:8080 - LAN:
http://<your-server-ip>:8080(from another device on the same network)
On first visit, you'll be prompted to create a local admin account. This account is stored entirely on your machine — no cloud, no email, no phone number.
Add your first server
Create a new server
Use the creation wizard to pick a type, version, and memory. Cliff downloads the JAR for you.
Import an existing server
Drop a server folder or .zip. Cliff auto-detects the type, version, and mods.
Start the server
Select your server in the sidebar, then click Start in the server header.
Accept the EULA
The first time you start a server, Cliff prompts you to accept the Minecraft EULA. Click Accept to continue.
Watch the console
The Live Console streams logs in real time. Wait for the "Done!" message — that means your server is up and accepting connections.
One at a time
Only one server can run at a time per Cliff instance. Starting a new server will prompt you to stop the currently running one.
Connect
Join with the Minecraft Java client using the address shown in the server header:
| Where you are | Address |
|---|---|
| Same machine | localhost (or localhost:<port> if you changed the default) |
| Same network (LAN) | Your machine's local IP, e.g. 192.168.1.100:25565 |
| Remote / internet | Set up a tunnel via Public Access — no port forwarding needed |
Click the join address in the header to copy it to your clipboard.
Next steps
Mods & Plugins
Search and install from Modrinth without leaving the dashboard.
Worlds
Switch active worlds, import, download, and delete.
Backups
Create manual and scheduled snapshots of your server.
Server Settings
Edit server.properties, Java settings, and the server profile.
App Settings
Global settings, Java runtimes, network config, and daemon logs.
Interface Overview
A full tour of the dashboard layout and navigation.