Documentation Index
Fetch the complete documentation index at: https://new-docs.simplecloud.app/llms.txt
Use this file to discover all available pages before exploring further.
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://get.simplecloud.app)"
Befehlsstruktur
sc <befehl> [unterbefehl] [argumente] [optionen]
Globale Optionen
| Option | Beschreibung |
|---|
-c, --context | Aktiven Context überschreiben |
-h, --help | Hilfe anzeigen |
-v, --version | Versionsnummer anzeigen |
Authentifizierung
Login
Bei SimpleCloud authentifizieren.
| Option | Beschreibung |
|---|
--no-browser | Browser nicht automatisch öffnen |
--code | Vorab genehmigten Code vom Dashboard verwenden |
Logout
Von SimpleCloud abmelden.
Who Am I
Aktuelle Benutzerinformationen anzeigen.
Setup & Installation
Setup
SimpleCloud einrichten: Context konfigurieren, Dependencies installieren und Serverhost herunterladen.
| Option | Beschreibung |
|---|
-o, --org | Organisations-ID oder Slug (überspringt interaktive Auswahl) |
--code | Vorab 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.
Komponenten-Lifecycle
Start
SimpleCloud-Komponenten starten.
| Option | Beschreibung |
|---|
--runner | Runner-Typ überschreiben (screen, docker, native) |
--configure | Standard-Runner konfigurieren |
--skip-version-check | Versionsprüfung vor dem Start überspringen |
--update | Veraltete Komponenten automatisch aktualisieren |
Stop
SimpleCloud-Komponenten stoppen.
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.
| Option | Beschreibung |
|---|
-n, --lines | Anzahl der anzuzeigenden Zeilen (Standard: 100) |
Attach
An eine laufende Komponenten-Konsole anhängen.
Context-Verwaltung
Verbindungs-Contexts verwalten. Aliase: contexts, ctx
Contexts auflisten
Context verwenden
Zu einem Context wechseln.
Context hinzufügen
Neuen Context hinzufügen.
Context entfernen
Context entfernen.
Aktueller Context
Aktuellen Context anzeigen.
Gruppen-Verwaltung
Server-Gruppen verwalten. Alias: groups
Gruppen auflisten
Gruppe erstellen
Neue Gruppe mit interaktivem Wizard erstellen.
| Option | Beschreibung |
|---|
-y, --auto-retry | Automatisch mit vorherigen Antworten wiederholen |
Gruppen-Info
Gruppeninformationen anzeigen.
Server in Gruppe starten
Server in der Gruppe starten.
Gruppe aktualisieren
Gruppeneinstellungen aktualisieren.
| Option | Beschreibung |
|---|
--name | Neuer Gruppenname |
--type | Gruppentyp (SERVER, PROXY, LOBBY) |
--active | Aktiv-Status setzen |
--max-memory | Maximaler Speicher in MB |
--min-memory | Minimaler Speicher in MB |
--max-players | Maximale Spieler |
--scaling-min | Minimale Server für Skalierung |
--scaling-max | Maximale Server für Skalierung |
Gruppe löschen
Gruppe löschen.
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
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
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.
Netzwerk verifizieren
Netzwerk-Credentials verifizieren.
Serverhost-Verwaltung
Server-Hosts verwalten. Aliase: serverhosts, host, hosts
Serverhost hinzufügen
Neuen Serverhost mit interaktivem Wizard hinzufügen.
Serverhost registrieren
Neuen Serverhost registrieren.
Serverhost verifizieren
Serverhost verifizieren.
sc serverhost verify <id>
Shell-Completion
Shell-Completion-Scripts generieren.
Kurzreferenz
| Aufgabe | Befehl |
|---|
| SimpleCloud einrichten | sc setup |
| Alle Komponenten starten | sc start |
| Status prüfen | sc status |
| Logs anzeigen | sc logs <komponente> |
| Gruppe erstellen | sc group create |
| Gruppen auflisten | sc group list |
| Server starten | sc group start <gruppe> |
| Server auflisten | sc server list |
| Server stoppen | sc server stop <name> [id] |
| An Konsole anhängen | sc attach <komponente> |
| Context wechseln | sc context use <name> |
