Skip to main content

​
Install the CLI

Run the installer on the machine that will host SimpleCloud:
Then check that the CLI is available:
To set up the first serverhost from the dashboard, follow Installation. To complete the setup from the CLI, continue below.

​
Set up your serverhost

Start the setup wizard:
The wizard signs you in, connects the machine to your network, and installs the serverhost. When it finishes, you can manage SimpleCloud from the CLI or dashboard.

​
Manage SimpleCloud on this machine

Use these commands to operate the local installation: Local commands such as sc start manage SimpleCloud on the current machine. Commands under sc server manage Minecraft servers in your network.

​
Manage groups and servers

Create a server group with the interactive wizard:
You can then start a server and view the running servers:
Use these commands for common server tasks:
See Server groups and Servers for the complete workflows.

​
Update SimpleCloud

Upgrade the CLI and installed SimpleCloud components with one command:
If an installed component needs to be downloaded again, run:

​
Sign in

Run sc login when you need to sign in again. Use sc whoami to check the current account and sc logout to sign out.

​
Switch between networks

The CLI saves each network as a context and sends network commands to the active one. Setup creates your first context automatically.
Run sc context add to connect the CLI to another network.

​
Add another serverhost

On the new machine, install the CLI and run:
Follow Multi-root setup for the complete process.

​
Discover more commands

The CLI also supports templates, persistent servers, multiple contexts, and advanced installation options. These workflows have their own guides, while the CLI’s built-in help always shows the current command syntax:
Learn more in Templates and Persistent servers.