Zum Hauptinhalt springen
Version: 1.89.x (Q2 26)

Erste Schritte: CLI

Die Codesphere CLI (cs) ermöglicht es, Codesphere nahtlos in den lokalen Entwicklungsworkflow zu integrieren. Ressourcen, die in Codesphere bereitgestellt sind, lassen sich damit direkt über die Kommandozeile verwalten und debuggen.

info

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

Installation​

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

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

Manueller Download

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

Authentifizierung & Konfiguration​

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

Die Codesphere CLI stützt sich für die Konfiguration auf globale Umgebungsvariablen oder Kommandozeilen-Flags. Das Setzen von Umgebungsvariablen ist der empfohlene Ansatz für dauerhafte Konfigurationen.

Globale Variablen & Flags​

Erfahre mehr über die Verwendung der Codesphere API

  • API-Token (erforderlich): Ein Codesphere-API-Token muss in den 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.
  • Team-ID: Erforderlich für Befehle, die sich auf ein bestimmtes Team beziehen.
    • Flag: --team oder -t.
    • Umgebungsvariable: CS_TEAM_ID.
  • Workspace-ID: Erforderlich für Befehle, die einen bestimmten Workspace betreffen.
    • Flag: --workspace oder -w.
    • Umgebungsvariable: CS_WORKSPACE_ID.

Auflösung von Variablen

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

Befehle entdecken

Eine vollständige Liste der verfügbaren Befehle sowie Hinweise zu deren Verwendung lassen sich jederzeit durch Eingabe von cs --help im Terminal anzeigen.