Erste Schritte: CLI

Die Codesphere CLI (cs) ermöglicht eine nahtlose Integration von Codesphere in den lokalen Entwicklungsworkflow. Ressourcen, die in Codesphere bereitgestellt wurden, können direkt über die Kommandozeile verwaltet und debuggt werden.

info

Die CLI ist Open Source! Der Quellcode kann eingesehen werden, Issues für Bugs oder Feature-Requests können erstellt werden, und Beiträge zum Projekt sind direkt im GitHub-Repository möglich.

Installation

Die Codesphere CLI kann je nach Umgebung auf verschiedene Arten installiert werden.

Codesphere Workspace

Die Codesphere CLI ist in allen Codesphere Workspaces vorinstalliert. Der Befehl cs kann direkt im Workspace-Terminal verwendet werden.

Mac (ARM)

Wenn die GitHub CLI (gh) installiert ist, kann die CLI auf einem ARM-Mac wie folgt heruntergeladen und installiert werden:

gh release download -R codesphere-cloud/cs-go -O /usr/local/bin/cs -p "*darwin_arm64"
chmod +x /usr/local/bin/cs

(Hinweis: Für das Schreiben nach /usr/local/bin wird eventuell sudo benötigt).

Linux (Amd64)

Installation über die GitHub CLI unter Linux:

gh release download -R codesphere-cloud/cs-go -O /usr/local/bin/cs -p "*linux_amd64"
chmod +x /usr/local/bin/cs

Manueller Download

Die vorkompilierten Binärdateien für macOS, Linux oder Windows können auch manuell direkt von der Codesphere CLI Releases-Seite heruntergeladen werden.

Authentifizierung & Konfiguration

Bevor Befehle ausgeführt werden können, muss die CLI mit dem Codesphere-Konto authentifiziert werden.

Die Codesphere CLI nutzt globale Umgebungsvariablen oder Command-Line-Flags zur Konfiguration. Das Setzen von Umgebungsvariablen wird für dauerhafte Konfigurationen empfohlen.

Globale Variablen & Flags

Mehr dazu, wie die Codesphere API verwendet wird

• API Token (erforderlich): Es muss ein Codesphere API-Token über die Benutzereinstellungen generiert und als Umgebungsvariable CS_TOKEN gesetzt werden.
• API URL: Bestimmt die Ziel-API. Standardmäßig ist dies https://codesphere.com/api.
  • Flag: --api oder -a.
  • Umgebungsvariable: CS_API.
• Resource Group ID: Erforderlich für Befehle, die auf eine bestimmte Resource Group wirken.
  • Flag: --team oder -t.
  • Umgebungsvariable: CS_TEAM_ID.
• Workspace ID: Erforderlich für Befehle, die einen bestimmten Workspace ansprechen.
  • Flag: --workspace oder -w.
  • Umgebungsvariable: CS_WORKSPACE_ID.

Auflösung von Variablen

Wird die Resource Group ID oder die Workspace ID nicht explizit über ein Flag angegeben, versucht die CLI automatisch, diese aus CS_TEAM_ID und CS_WORKSPACE_ID zu lesen. Benötigt ein Befehl diese Werte und fehlen sie, gibt die CLI einen Fehler zurück.

Befehle entdecken

Eine vollständige Liste aller verfügbaren Befehle sowie Hinweise zu deren Nutzung erhält man jederzeit durch Eingabe von cs --help im Terminal.

Codesphere über den KI-Assistenten nutzen

Die CLI enthält den offiziellen Codesphere MCP-Server. Er ermöglicht es Assistenten wie Claude, Cursor oder VS Code, Workspaces, Pipelines und Domains zu verwalten.