Zum Inhalt springen
Dokumentation
CLI – Übersicht

CLI – Übersicht

Als Markdown anzeigen

Die Status200-CLI, status200, verwaltet Ihr Status200-Projekt aus einem Terminal oder einem Skript. Sie listet, liest, erstellt, ändert, löscht und zählt Monitore, Vorfälle, Warnungen, Statusseiten und die anderen Datensätze, die die Status200-API anbietet, mit einem API-Schlüssel Ihres Projekts.

Wie die CLI arbeitetEin Befehl, eine API-Anfrage, eine Antwort.Die CLI installierenEin npm-Befehl, und welche Version Sie wählen.Die ersten Befehle ausführenSpeichern Sie Ihren API-Schlüssel und listen Sie dann Ihre Vorfälle auf.Die Befehle auf einen BlickJeder Befehl und die Seite, die ihn erklärt.

Wie die CLI arbeitet

Jeder Befehl sendet eine Anfrage an die REST API von Status200 und gibt die Antwort aus. Den API-Schlüssel und die Adresse Ihrer Status200-Instanz nimmt die CLI aus Flags, Umgebungsvariablen oder einem Kontext, den status200 login gespeichert hat. Der Schlüssel entscheidet, was ein Befehl lesen und ändern darf, genau wie bei der API.

flowchart TB T["Ihr Terminal<br/>oder ein CI-Job"] -->|"status200 incident list"| C["status200-CLI"] K["API-Schlüssel und URL:<br/>Flags, Umgebung<br/>oder ein gespeicherter<br/>Kontext"] --> C C -->|"POST /api/incident/get-list"| A["REST API von Status200"] A -->|"die Datensätze, die der<br/>Schlüssel lesen darf,<br/>als JSON"| C C -->|"eine Tabelle im Terminal,<br/>JSON in einer Pipe"| T

Ein Befehl, eine Anfrage

Die Befehle für Datensätze bringt die CLI mit: Jede Art von Datensatz, die die Status200-API für Werkzeuge öffnet, hat einen, dieselben Datensätze, für die der MCP-Server Werkzeuge hat. status200 resources listet sie auf.

Bevor Sie beginnen

  • Node.js und npm, ein aktuelles LTS-Release, um die CLI zu installieren.
  • Ein API-Schlüssel Ihres Projekts. Legen Sie einen unter Projekteinstellungen → Erweitert → API-Schlüssel mit API-Schlüssel erstellen an: siehe Einen API-Schlüssel anlegen.
  • In Status200 Cloud der Tarif Growth oder höher. Die API-Schlüssel eines Projekts funktionieren nur dort: siehe API-Schlüssel und SCIM unterhalb ihres Tarifs.

Die CLI installieren

Installieren Sie das Paket @status200/cli aus npm. Es fügt den Befehl status200 hinzu, und --version gibt die installierte Version aus:

Bash 
npm install -g @status200/cli
status200 --version

Die CLI erscheint mit Status200 und hat dieselbe Versionsnummer. Bei einer selbst gehosteten Status200-Instanz installieren Sie die CLI in der Version Ihrer Instanz, damit ihre Befehle zu den Datensätzen Ihres Servers passen:

Bash 
npm install -g @status200/cli@<your-oneuptime-version>

Die ersten Befehle ausführen

  1. Ihren API-Schlüssel speichern

    Melden Sie sich mit dem Schlüssel und der Adresse Ihrer Status200-Instanz an. Die CLI speichert beides als Kontext namens default und verwendet ihn ab jetzt:

    Bash 
    status200 login <your-api-key> https://status200.ru

    Sie antwortet Logged in successfully. Context "default" is now active. Bei einer selbst gehosteten Instanz verwenden Sie deren Adresse anstelle von https://status200.ru.

  2. Ihre Vorfälle auflisten

    Bash 
    status200 incident list

    Die zehn neuesten Vorfälle erscheinen als Tabelle. login speichert den Schlüssel, ohne ihn zu prüfen, daher zeigt erst dieser Befehl, dass der Schlüssel funktioniert: Wird er abgelehnt, siehe Fehlerbehebung.

  3. Sehen, was Sie sonst noch verwalten können

    Bash 
    status200 resources

    Die Liste zeigt jede Art von Datensatz, mit der Sie arbeiten können, und ihren Befehl, etwa monitor, status-page oder on-call-policy.

Die Befehle auf einen Blick

BefehlWas er tutMehr dazu
status200 login <api-key> <instance-url>Speichert einen API-Schlüssel und eine Adresse als KontextAuthentifizierung
status200 context list, use, current, deleteListet, wechselt, zeigt und löscht gespeicherte KontexteAuthentifizierung
status200 whoamiZeigt die URL und den API-Schlüssel, die der nächste Befehl verwendetAuthentifizierung
status200 deployZeichnet einen Deploy oder eine andere Änderung für die Diagramme und Status200 AI aufDeploys und Änderungen
status200 <resource> list, get, create, update, delete, countArbeitet mit einer Art von DatensatzRessourcenoperationen
status200 resourcesListet die Arten von Datensätzen mit ihren Befehlen aufBefehlsreferenz
status200 versionGibt die Version der CLI ausBefehlsreferenz
status200 help [command]Zeigt die Hilfe eines BefehlsHilfe erhalten

Globale Optionen

Diese Optionen funktionieren mit jedem Befehl, davor oder dahinter:

OptionWas sie tut
--api-key <key>Der API-Schlüssel für diesen Befehl, anstelle des gespeicherten
--url <url>Die Adresse Ihrer Status200-Instanz für diesen Befehl
--context <name>Ein gespeicherter Kontext für diesen Befehl, anstelle des aktuellen
-o, --output <format>table, json oder wide: siehe Ausgabeformate
--no-colorGibt ohne Farben aus
-V, --versionGibt die Version der CLI aus
-h, --helpZeigt die Hilfe des Befehls

Hilfe erhalten

Jeder Befehl hat seine eigene Hilfe, mit seinen Argumenten, Optionen und Standardwerten:

Bash 
status200 --help
status200 help incident
status200 incident list --help

Nächste Schritte

AuthentifizierungKontexte für jede Umgebung, und welchen Schlüssel ein Befehl verwendet.RessourcenoperationenDatensätze auflisten, lesen, erstellen, ändern, löschen und zählen.AusgabeformateTabellen für Menschen, JSON für Skripte.Skripting & CI/CDExit-Codes, jq und Pipelines.BefehlsreferenzJeder Befehl, jede Option und jeder Standardwert.