SimpleCloud CLI
Run your network from the terminal. Agents can run it too.
macOS and Linux. The script installs Bun if it is missing.
sc setup --network my-network --host-name eu-1 --max-memory 80% --runner tmux --startϟ simplecloud setup · v0.0.1-beta.101✓ Dependencies ready✓ Connected to My Network✓ Downloaded serverhost v0.0.1-beta.96 4.2s✓ Registered eu-1✓ Installed in ~/simplecloud✓ Started serverhost 1.6seu-1 is ready in 9.8sNext sc status Check the serverhost sc logs serverhost Show its logCommands
sc <command> --help lists every flag.
Get started
- sc setup
- Set up a serverhost on this machine.
- sc setup --network my-network --yes
- sc login
- Sign in with a device code.
- sc login --no-browser
- sc status
- Show whether this serverhost is running.
- sc status --json
Network
- sc group
- Create, scale and roll out server groups.
- sc group rollout restart lobby
- sc group plugin
- Add plugins from Modrinth, Spigot or a URL.
- sc group plugin add lobby mr:luckperms
- sc server
- List servers, read their logs, stop them.
- sc server logs lobby 1 --follow
- sc persistent-server
- Servers that keep their world, like SMP.
- sc persistent-server list
- sc blueprint
- Software, version and Java of a group.
- sc blueprint update lobby --java-version 21
- sc serverhost
- Add, verify and delete machines.
- sc serverhost list
- sc file
- Read, edit and upload files on any server.
- sc file tail ps:survival:/logs/latest.log -n 200
- sc network
- Register a network and check its credentials.
- sc network verify
This machine
- sc start, stop, restart
- Start and stop the serverhost.
- sc restart serverhost --no-stop-servers
- sc logs, attach
- Read the serverhost's log or open its console.
- sc logs serverhost -n 50
- sc install
- Install Java, PostgreSQL and other services.
- sc install java 21
- sc upgrade, repair
- Update or reinstall the CLI and serverhost.
- sc upgrade serverhost@0.0.50
- sc sync
- Keep templates in sync across serverhosts.
- sc sync status
- sc local
- Find and stop stuck Java processes.
- sc local cleanup --name lobby
Account
- sc context
- Switch between networks.
- sc server list --context production
- sc whoami, logout, config
- Your account and CLI settings.
- sc config show
- sc completion
- Tab completion for bash, zsh, fish and PowerShell.
- sc completion zsh > ~/.zsh/completions/_sc
Agents and scripts
Every question sc asks has a flag. Without a terminal, sc stops and names the missing one.
- --json
- Results on stdout, progress on stderr.
- --yes
- Skips confirmations.
- --wait
- Returns once the server is running.
- --no-browser
- Prints the sign-in code instead of opening a browser.
- --network
- Picks the network for one call.
Full reference for agents at /cli.md.
sc group create --software paper --json{"error":{"code":"missing_input","message":"Missing --name: \"Name\" needs an answer and no terminal is available","details":"Pass --name, or run the command in an interactive terminal.","flag":"--name"}}echo $?1sc vs. the console
SimpleCloud v2, CloudNet and other clouds are run from a console in screen.
| Topic | sc | The console |
|---|---|---|
| Where it runs | Any machine you are signed in on. | On the machine it runs on, over SSH. |
| Several people | Each in their own shell. | Everyone types into the same screen. |
| Output | Tables, or JSON with --json. | Log lines in the scrollback. |
| Scripts and agents | Flags and exit codes. | Keystrokes sent into screen. |
Need a console anyway? sc attach serverhost opens one, and the dashboard has one for every server.