Zum Hauptinhalt springen

Was ist die CLI?

Die SimpleCloud CLI ist dein primäres Werkzeug zur Verwaltung deiner Cloud-Infrastruktur. Sie bietet Befehle für Authentifizierung, Setup, Komponenten-Management und Server-Operationen.

Installation

Installiere die CLI mit dem offiziellen Install-Script:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/simplecloudapp/simplecloud-manifest/HEAD/install.sh)"

Befehlsstruktur

sc <befehl> [unterbefehl] [argumente] [optionen]

Globale Optionen

OptionBeschreibung
-c, --contextAktiven Context überschreiben
-h, --helpHilfe anzeigen
-v, --versionVersionsnummer anzeigen

Authentifizierung

Login

Bei SimpleCloud authentifizieren.
sc login
OptionBeschreibung
--no-browserBrowser nicht automatisch öffnen
--codeVorab genehmigten Code vom Dashboard verwenden

Logout

Von SimpleCloud abmelden.
sc logout

Who Am I

Aktuelle Benutzerinformationen anzeigen.
sc whoami

Setup & Installation

Setup

SimpleCloud einrichten: Context konfigurieren, Dependencies installieren und Serverhost herunterladen.
sc setup
OptionBeschreibung
-o, --orgOrganisations-ID oder Slug (überspringt interaktive Auswahl)
--codeVorab genehmigten Code vom Dashboard verwenden

Komponenten installieren

Komponenten aus der Component Registry installieren.
sc install [komponenten..]

Komponenten aktualisieren

Installierte Komponenten auf neueste Version aktualisieren.
sc update [komponenten..]

CLI upgraden

Die CLI auf die neueste Version upgraden.
sc upgrade

Komponenten-Lifecycle

Start

SimpleCloud-Komponenten starten.
sc start [komponenten..]
OptionBeschreibung
--runnerRunner-Typ überschreiben (screen, docker, native)
--configureStandard-Runner konfigurieren
--skip-version-checkVersionsprüfung vor dem Start überspringen
--updateVeraltete Komponenten automatisch aktualisieren

Stop

SimpleCloud-Komponenten stoppen.
sc stop [komponenten..]

Restart

SimpleCloud-Komponenten neu starten (Stop dann Start).
sc restart [komponenten..]

Status

Status von SimpleCloud-Komponenten prüfen.
sc status [komponenten..]

Logs

Logs einer Komponente anzeigen.
sc logs <komponente>
OptionBeschreibung
-n, --linesAnzahl der anzuzeigenden Zeilen (Standard: 100)

Attach

An eine laufende Komponenten-Konsole anhängen.
sc attach <komponente>

Context-Verwaltung

Verbindungs-Contexts verwalten. Aliase: contexts, ctx

Contexts auflisten

sc context list

Context verwenden

Zu einem Context wechseln.
sc context use <name>

Context hinzufügen

Neuen Context hinzufügen.
sc context add [name]

Context entfernen

Context entfernen.
sc context remove <name>

Aktueller Context

Aktuellen Context anzeigen.
sc context current

Gruppen-Verwaltung

Server-Gruppen verwalten. Alias: groups

Gruppen auflisten

sc group list

Gruppe erstellen

Neue Gruppe mit interaktivem Wizard erstellen.
sc group create
OptionBeschreibung
-y, --auto-retryAutomatisch mit vorherigen Antworten wiederholen

Gruppen-Info

Gruppeninformationen anzeigen.
sc group info <gruppe>

Server in Gruppe starten

Server in der Gruppe starten.
sc group start <gruppe>

Gruppe aktualisieren

Gruppeneinstellungen aktualisieren.
sc group update <gruppe>
OptionBeschreibung
--nameNeuer Gruppenname
--typeGruppentyp (SERVER, PROXY, LOBBY)
--activeAktiv-Status setzen
--max-memoryMaximaler Speicher in MB
--min-memoryMinimaler Speicher in MB
--max-playersMaximale Spieler
--scaling-minMinimale Server für Skalierung
--scaling-maxMaximale Server für Skalierung

Gruppe löschen

Gruppe löschen.
sc group delete <gruppe>

Gruppen-Plugins

Plugins für eine Gruppe verwalten.
# Plugins zu einer Gruppe hinzufügen
sc group plugin add <gruppe> [suche]

# Plugins einer Gruppe auflisten
sc group plugin list <gruppe>

# Plugin von einer Gruppe entfernen
sc group plugin remove <gruppe> <plugin>

Server-Verwaltung

Laufende Server verwalten. Alias: servers

Server auflisten

sc server list

Server-Info

Serverinformationen anzeigen.
sc server info <server> [numerische-id]

Server stoppen

Server stoppen.
sc server stop <server> [numerische-id]

Server-Logs

Server-Logs anzeigen.
sc server logs <server> [numerische-id]

Blueprint-Verwaltung

Server-Blueprints verwalten. Aliase: blueprints, bp, bps

Blueprints auflisten

sc blueprint list

Blueprint-Info

Blueprint-Informationen anzeigen.
sc blueprint info <blueprint>

Blueprint aktualisieren

Blueprint-Einstellungen aktualisieren.
sc blueprint update <blueprint>

Blueprint löschen

Blueprint löschen.
sc blueprint delete <blueprint>

Persistent-Server-Verwaltung

Persistente Server verwalten. Aliase: pserver, pservers

Persistente Server auflisten

sc persistent-server list

Persistenten Server erstellen

Neuen persistenten Server mit interaktivem Wizard erstellen.
sc persistent-server create

Persistent-Server-Info

Informationen zum persistenten Server anzeigen.
sc persistent-server info <server>

Persistenten Server aktualisieren

Einstellungen des persistenten Servers aktualisieren.
sc persistent-server update <server>

Persistenten Server löschen

Persistenten Server löschen.
sc persistent-server delete <server>

Persistent-Server-Plugins

Plugins für einen persistenten Server verwalten.
# Plugins hinzufügen
sc persistent-server plugin add <server> [suche]

# Plugins auflisten
sc persistent-server plugin list <server>

# Plugin entfernen
sc persistent-server plugin remove <server> <plugin>

Netzwerk-Verwaltung

Netzwerkkonfiguration verwalten. Aliase: networks, net

Netzwerk registrieren

Neues Netzwerk registrieren.
sc network register

Netzwerk verifizieren

Netzwerk-Credentials verifizieren.
sc network verify

Serverhost-Verwaltung

Server-Hosts verwalten. Aliase: serverhosts, host, hosts

Serverhost hinzufügen

Neuen Serverhost mit interaktivem Wizard hinzufügen.
sc serverhost add

Serverhost registrieren

Neuen Serverhost registrieren.
sc serverhost register

Serverhost verifizieren

Serverhost verifizieren.
sc serverhost verify <id>

Shell-Completion

Shell-Completion-Scripts generieren.
sc completion

Kurzreferenz

AufgabeBefehl
SimpleCloud einrichtensc setup
Alle Komponenten startensc start
Status prüfensc status
Logs anzeigensc logs <komponente>
Gruppe erstellensc group create
Gruppen auflistensc group list
Server startensc group start <gruppe>
Server auflistensc server list
Server stoppensc server stop <name> [id]
An Konsole anhängensc attach <komponente>
Context wechselnsc context use <name>