CLI - simplecloud

What is the CLI?

The SimpleCloud CLI is your primary tool for managing your cloud infrastructure. It provides commands for authentication, setup, component management, and server operations.

Installation

Install the CLI using the official install script:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/simplecloudapp/simplecloud-manifest/HEAD/install.sh)"

Command Structure

sc <command> [subcommand] [arguments] [options]

Global Options

Option	Description
`-c, --context`	Override the active context
`-h, --help`	Show help
`-v, --version`	Show version number

Authentication

Authenticate with SimpleCloud.

sc login

Option	Description
`--no-browser`	Don’t open browser automatically
`--code`	Use a pre-approved code from the dashboard

Logout

Log out from SimpleCloud.

sc logout

Who Am I

Show current user information.

sc whoami

Setup & Installation

Setup

Set up SimpleCloud: configure context, install dependencies, and download serverhost.

sc setup

Option	Description
`-o, --org`	Organization ID or slug (skips interactive selection)
`--code`	Use a pre-approved code from the dashboard

Install Components

Install components from the component registry.

sc install [components..]

Update Components

Update installed components to latest versions.

sc update [components..]

Upgrade CLI

Upgrade the CLI to the latest version.

sc upgrade

Component Lifecycle

Start

Start SimpleCloud components.

sc start [components..]

Option	Description
`--runner`	Override runner type (`screen`, `docker`, `native`)
`--configure`	Configure the default runner
`--skip-version-check`	Skip version check before starting
`--update`	Auto-update outdated components

Stop

Stop SimpleCloud components.

sc stop [components..]

Restart

Restart SimpleCloud components (stop then start).

sc restart [components..]

Status

Check status of SimpleCloud components.

sc status [components..]

Logs

View logs for a component.

sc logs <component>

Option	Description
`-n, --lines`	Number of lines to show (default: 100)

Attach

Attach to a running component console.

sc attach <component>

Context Management

Manage connection contexts. Aliases: contexts, ctx

List Contexts

sc context list

Use Context

Switch to a context.

sc context use <name>

Add Context

Add a new context.

sc context add [name]

Remove Context

Remove a context.

sc context remove <name>

Current Context

Show the current context.

sc context current

Group Management

Manage server groups. Alias: groups

List Groups

sc group list

Create Group

Create a new group with interactive wizard.

sc group create

Option	Description
`-y, --auto-retry`	Automatically retry with previous answers

Group Info

Show group information.

sc group info <group>

Start Server in Group

Start a server in the group.

sc group start <group>

Update Group

Update group settings.

sc group update <group>

Option	Description
`--name`	New group name
`--type`	Group type (`SERVER`, `PROXY`, `LOBBY`)
`--active`	Set active status
`--max-memory`	Maximum memory in MB
`--min-memory`	Minimum memory in MB
`--max-players`	Maximum players
`--scaling-min`	Minimum servers for scaling
`--scaling-max`	Maximum servers for scaling

Delete Group

Delete a group.

sc group delete <group>

Group Plugins

Manage plugins for a group.

# Add plugins to a group
sc group plugin add <group> [query]

# List plugins for a group
sc group plugin list <group>

# Remove a plugin from a group
sc group plugin remove <group> <plugin>

Server Management

Manage running servers. Alias: servers

List Servers

sc server list

Server Info

Show server information.

sc server info <server> [numerical-id]

Stop Server

Stop a server.

sc server stop <server> [numerical-id]

Server Logs

View server logs.

sc server logs <server> [numerical-id]

Blueprint Management

Manage server blueprints. Aliases: blueprints, bp, bps

List Blueprints

sc blueprint list

Blueprint Info

Show blueprint information.

sc blueprint info <blueprint>

Update Blueprint

Update blueprint settings.

sc blueprint update <blueprint>

Delete Blueprint

Delete a blueprint.

sc blueprint delete <blueprint>

Persistent Server Management

Manage persistent servers. Aliases: pserver, pservers

List Persistent Servers

sc persistent-server list

Create Persistent Server

Create a new persistent server with interactive wizard.

sc persistent-server create

Persistent Server Info

Show persistent server information.

sc persistent-server info <server>

Update Persistent Server

Update persistent server settings.

sc persistent-server update <server>

Delete Persistent Server

Delete a persistent server.

sc persistent-server delete <server>

Persistent Server Plugins

Manage plugins for a persistent server.

# Add plugins
sc persistent-server plugin add <server> [query]

# List plugins
sc persistent-server plugin list <server>

# Remove a plugin
sc persistent-server plugin remove <server> <plugin>

Network Management

Manage network configuration. Aliases: networks, net

Register Network

sc network register

Verify Network

Verify network credentials.

sc network verify

Serverhost Management

Manage server hosts. Aliases: serverhosts, host, hosts

Add Serverhost

Add a new serverhost with interactive wizard.

sc serverhost add

Register Serverhost

sc serverhost register

Verify Serverhost

Verify a serverhost.

sc serverhost verify <id>

Shell Completion

Generate shell completion scripts.

sc completion

Quick Reference

Task	Command
Set up SimpleCloud	`sc setup`
Start all components	`sc start`
Check status	`sc status`
View logs	`sc logs <component>`
Create a group	`sc group create`
List groups	`sc group list`
Start a server	`sc group start <group>`
List servers	`sc server list`
Stop a server	`sc server stop <name> [id]`
Attach to console	`sc attach <component>`
Switch context	`sc context use <name>`

Core Concepts

Server Host

​What is the CLI?

​Installation

​Command Structure

​Global Options

​Authentication

​Login

​Logout

​Who Am I

​Setup & Installation

​Setup

​Install Components

​Update Components

​Upgrade CLI

​Component Lifecycle

​Start

​Stop

​Restart

​Status

​Logs

​Attach

​Context Management

​List Contexts

​Use Context

​Add Context

​Remove Context

​Current Context

​Group Management

​List Groups

​Create Group

​Group Info

​Start Server in Group

​Update Group

​Delete Group

​Group Plugins

​Server Management

​List Servers

​Server Info

​Stop Server

​Server Logs

​Blueprint Management

​List Blueprints

​Blueprint Info

​Update Blueprint

​Delete Blueprint

​Persistent Server Management

​List Persistent Servers

​Create Persistent Server

​Persistent Server Info

​Update Persistent Server

​Delete Persistent Server

​Persistent Server Plugins

​Network Management

​Register Network

​Verify Network

​Serverhost Management

​Add Serverhost

​Register Serverhost

​Verify Serverhost

​Shell Completion

​Quick Reference