Benutzerhandbuch

Die STACKIT CLI ist die Befehlszeilenschnittstelle zur Verwaltung von STACKIT-Diensten. Sie können sie verwenden, um verschiedene Aktionen für unterstützte Dienste zu konfigurieren und auszuführen. Eine Liste der verfügbaren Dienste finden Sie in der offiziellen Dokumentation auf GitHub.

STACKIT CLI auf GitHub

Die aktuellste und umfassendste Dokumentation zur STACKIT CLI finden Sie direkt in unserem Repo.

Erste Schritte

1. Installieren Sie die STACKIT CLI auf Ihrem Computer
   Bevor Sie die CLI verwenden können, müssen Sie sie auf Ihrem Computer installieren. Es gibt spezielle Installationsmethoden für verschiedene Betriebssysteme. Eine Installationsanleitung finden Sie im Installationshandbuch.
2. Konfigurieren Sie die STACKIT CLI
   Erfahren Sie im Abschnitt Configuration der GitHub-Dokumentation, wie Sie die Einstellungen der STACKIT CLI verwalten. Dieses Handbuch erklärt, wie Sie mit dem Befehl stackit config Standardwerte festlegen oder aufheben.
3. Passen Sie die Ausgabe an
   Sie können die Anzeige der Ausgabe anpassen. Im Abschnitt Customization erfahren Sie, wie Sie einen benutzerdefinierten Pager über die Umgebungsvariable PAGER sowie die Standardeinstellungen des Pagers less konfigurieren.
4. Autovervollständigung aktivieren (optional)
   Sie können die Autovervollständigung in Ihrer Shell für die STACKIT CLI einrichten. Das Autocompletion-Handbuch beschreibt, wie Sie die vom Cobra-Framework bereitgestellte Funktionalität nutzen.

Verwendung

Im Abschnitt Usage der Dokumentation erfahren Sie, wie Sie Befehle der STACKIT CLI strukturieren und verwenden. Dieser Abschnitt erläutert den Aufbau eines Befehls und seiner Flags. Außerdem können Sie im Abschnitt Available services eine Liste aller STACKIT-Dienste einsehen, die derzeit in die CLI integriert sind.

Authentifizierung

Bevor Sie die meisten Befehle verwenden können, müssen Sie sich bei der STACKIT CLI authentifizieren. Der Abschnitt Authentication der Dokumentation enthält die notwendigen Befehle und Informationen zur Anmeldung mit einem persönlichen Benutzerkonto oder einem Service Account.

Befehlsreferenz

Um alle verfügbaren Befehle, Flags und deren Verwendung einzusehen, führen Sie stackit --help aus oder fügen Sie das Flag -h zu jedem Befehl hinzu.

Erkunden Sie die vollständige Palette der verfügbaren Befehle und ihrer Optionen in der Befehlsreferenz. Diese Dokumentation bietet detaillierte Informationen zu jedem Befehl der STACKIT CLI und unterstützt Sie dabei, dessen Verwendung und Funktionsweise zu verstehen.