Hoppa till innehåll
Dokumentation
CLI – Översikt

CLI – Översikt

Visa som Markdown

Status200s CLI, status200, hanterar ditt Status200-projekt från en terminal eller ett skript. Den listar, läser, skapar, ändrar, tar bort och räknar monitorer, incidenter, varningar, statussidor och de andra poster som Status200s API erbjuder, med en API-nyckel till ditt projekt.

Så fungerar CLI:nEtt kommando, en API-begäran, ett svar.Installera CLI:nEtt npm-kommando, och vilken version du ska välja.Kör dina första kommandonSpara din API-nyckel och lista sedan dina incidenter.Kommandona i korthetVarje kommando, och sidan som förklarar det.

Så fungerar CLI:n

Varje kommando skickar en begäran till Status200s REST API och skriver ut svaret. CLI:n tar API-nyckeln och adressen till ditt Status200 från flaggor, miljövariabler eller en kontext som status200 login har sparat. Nyckeln avgör vad ett kommando får läsa och ändra, precis som för API:et.

flowchart TB T["Din terminal<br/>eller ett CI-jobb"] -->|"status200 incident list"| C["CLI:n status200"] K["API-nyckeln och URL:en:<br/>flaggor, miljö<br/>eller en sparad kontext"] --> C C -->|"POST /api/incident/get-list"| A["Status200s REST API"] A -->|"posterna som nyckeln<br/>får läsa, som JSON"| C C -->|"en tabell i en terminal,<br/>JSON i en pipe"| T

Ett kommando, en begäran

Kommandona för poster följer med CLI:n: varje sorts post som Status200s API öppnar för verktyg har ett, samma poster som MCP-servern har verktyg för. Kör status200 resources för att lista dem.

Innan du börjar

  • Node.js och npm, i en aktuell LTS-version, för att installera CLI:n.
  • En API-nyckel till ditt projekt. Skapa en under Projektinställningar → Avancerad → API-nycklar med Skapa API-nyckel: se Skapa en API-nyckel.
  • På Status200 Cloud planen Growth eller högre. Ett projekts API-nycklar fungerar bara på den: se API-nycklar och SCIM under sin plan.

Installera CLI:n

Installera paketet @status200/cli från npm. Det lägger till kommandot status200, och --version skriver ut den version du har installerat:

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

CLI:n släpps tillsammans med Status200 och har samma versionsnummer. På ett egenhostat Status200 installerar du CLI:n i ditt Status200s version, så att dess kommandon passar de poster din server har:

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

Kör dina första kommandon

  1. Spara din API-nyckel

    Logga in med nyckeln och adressen till ditt Status200. CLI:n sparar dem som en kontext med namnet default och använder den från och med nu:

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

    Den svarar Logged in successfully. Context "default" is now active. På ett egenhostat Status200 använder du dess adress i stället för https://status200.ru.

  2. Lista dina incidenter

    Bash 
    status200 incident list

    De tio nyaste incidenterna visas som en tabell. login sparar nyckeln utan att kontrollera den, så detta är det första kommandot som visar att nyckeln fungerar: om den avvisas, se Felsökning.

  3. Se vad mer du kan hantera

    Bash 
    status200 resources

    Listan visar varje sorts post du kan arbeta med, och dess kommando, till exempel monitor, status-page eller on-call-policy.

Kommandona i korthet

KommandoVad det görLäs mer
status200 login <api-key> <instance-url>Sparar en API-nyckel och en adress som en kontextAutentisering
status200 context list, use, current, deleteListar, byter, visar och tar bort sparade kontexterAutentisering
status200 whoamiVisar URL:en och API-nyckeln som nästa kommando kommer att användaAutentisering
status200 deployRegistrerar en driftsättning, eller en annan ändring, för diagram och Status200 AIDriftsättningar och ändringar
status200 <resource> list, get, create, update, delete, countArbetar med en sorts postResursoperationer
status200 resourcesListar sorterna av poster med deras kommandonKommandoreferens
status200 versionSkriver ut CLI:ns versionKommandoreferens
status200 help [command]Visar hjälpen för ett kommandoFå hjälp

Globala alternativ

De här alternativen fungerar med varje kommando, före eller efter det:

AlternativVad det gör
--api-key <key>API-nyckeln för det här kommandot, i stället för den sparade
--url <url>Adressen till ditt Status200 för det här kommandot
--context <name>En sparad kontext för det här kommandot, i stället för den aktuella
-o, --output <format>table, json eller wide: se Utdataformat
--no-colorSkriver ut utan färger
-V, --versionSkriver ut CLI:ns version
-h, --helpVisar hjälpen för kommandot

Få hjälp

Varje kommando har sin egen hjälp, med sina argument, alternativ och standardvärden:

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

Nästa steg

AutentiseringKontexter för varje miljö, och vilken nyckel ett kommando använder.ResursoperationerLista, läs, skapa, ändra, ta bort och räkna poster.UtdataformatTabeller för människor, JSON för skript.Skript och CI/CDSlutkoder, jq och pipelines.KommandoreferensVarje kommando, alternativ och standardvärde.