Zum Hauptinhalt springen
Version: Weekly Build

Erste Schritte: CLI

Mit der Codesphere CLI (cs) lässt sich Codesphere nahtlos in den lokalen Entwicklungsablauf integrieren. 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-Wünsche können erstellt werden, und Beiträge zum Projekt können direkt über unser GitHub-Repository geleistet werden.

Installation​

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

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

Manueller Download

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

Authentifizierung & Konfiguration​

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

Die Codesphere CLI verwendet für die Konfiguration globale Umgebungsvariablen oder Kommandozeilen-Flags. Das Setzen von Umgebungsvariablen wird für dauerhafte Konfigurationen empfohlen.

Globale Variablen & Flags​

Erfahre, wie die Codesphere API verwendet wird

  • API-Token (erforderlich): Ein Codesphere-API-Token muss über die Benutzereinstellungen generiert und als Umgebungsvariable CS_TOKEN gesetzt werden.
  • API-URL: Legt die Ziel-API fest. Standardmäßig ist dies https://codesphere.com/api.
    • Flag: --api oder -a.
    • Umgebungsvariable: CS_API.
  • Team-ID: Erforderlich für Befehle, die für ein bestimmtes Team ausgeführt werden.
    • 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 zu lesen. Wenn ein Befehl diese Angaben benötigt und sie fehlen, gibt die CLI einen Fehler zurück.

Befehle entdecken

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