Gå til innhold
Dokumentasjon
CLI – Oversikt

CLI – Oversikt

Vis som Markdown

Status200-CLI-en, status200, administrerer Status200-prosjektet ditt fra en terminal eller et skript. Den lister, leser, oppretter, endrer, sletter og teller monitorer, hendelser, varsler, statussider og de andre postene som Status200-API-et tilbyr, med en API-nøkkel til prosjektet ditt.

Slik virker CLI-enÉn kommando, én API-forespørsel, ett svar.Installer CLI-enÉn npm-kommando, og hvilken versjon du skal velge.Kjør de første kommandoeneLagre API-nøkkelen din, og list så hendelsene dine.Kommandoene i korte trekkHver kommando, og siden som forklarer den.

Slik virker CLI-en

Hver kommando sender én forespørsel til Status200s REST API og skriver ut svaret. CLI-en henter API-nøkkelen og adressen til Status200-en din fra flagg, miljøvariabler eller en kontekst som status200 login har lagret. Nøkkelen avgjør hva en kommando kan lese og endre, nøyaktig som for API-et.

flowchart TB T["Terminalen din<br/>eller en CI-jobb"] -->|"status200 incident list"| C["status200-CLI"] K["API-nøkkelen og URL-en:<br/>flagg, miljø<br/>eller en lagret kontekst"] --> C C -->|"POST /api/incident/get-list"| A["Status200s REST API"] A -->|"postene nøkkelen<br/>kan lese, som JSON"| C C -->|"en tabell i en terminal,<br/>JSON i en pipe"| T

Én kommando, én forespørsel

Kommandoene for poster følger med CLI-en: hver type post som Status200-API-et åpner for verktøy, har én, de samme postene som MCP-serveren har verktøy for. Kjør status200 resources for å liste dem.

Før du begynner

  • Node.js og npm, i en aktuell LTS-versjon, for å installere CLI-en.
  • En API-nøkkel til prosjektet ditt. Opprett en under Prosjektinnstillinger → Avansert → API-nøkler med Opprett API-nøkkel: se Opprett en API-nøkkel.
  • På Status200 Cloud abonnementet Growth eller høyere. Et prosjekts API-nøkler virker bare på det: se API-nøkler og SCIM under abonnementet sitt.

Installer CLI-en

Installer pakken @status200/cli fra npm. Den legger til kommandoen status200, og --version skriver ut versjonen du har installert:

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

CLI-en utgis sammen med Status200 og har samme versjonsnummer. På en selvhostet Status200 installerer du CLI-en i versjonen til Status200-en din, slik at kommandoene passer til postene serveren din har:

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

Kjør de første kommandoene

  1. Lagre API-nøkkelen din

    Logg inn med nøkkelen og adressen til Status200-en din. CLI-en lagrer dem som en kontekst med navnet default og bruker den fra nå av:

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

    Den svarer Logged in successfully. Context "default" is now active. På en selvhostet Status200 bruker du adressen dens i stedet for https://status200.ru.

  2. List hendelsene dine

    Bash 
    status200 incident list

    De ti nyeste hendelsene vises som en tabell. login lagrer nøkkelen uten å sjekke den, så dette er den første kommandoen som viser at nøkkelen virker: blir den avvist, se Feilsøking.

  3. Se hva mer du kan administrere

    Bash 
    status200 resources

    Listen viser hver type post du kan jobbe med, og kommandoen dens, for eksempel monitor, status-page eller on-call-policy.

Kommandoene i korte trekk

KommandoHva den gjørLes mer
status200 login <api-key> <instance-url>Lagrer en API-nøkkel og en adresse som en kontekstAutentisering
status200 context list, use, current, deleteLister, bytter, viser og sletter lagrede konteksterAutentisering
status200 whoamiViser URL-en og API-nøkkelen som neste kommando vil brukeAutentisering
status200 deployRegistrerer en utrulling, eller en annen endring, for diagrammer og Status200 AIUtrullinger og endringer
status200 <resource> list, get, create, update, delete, countJobber med én type postRessursoperasjoner
status200 resourcesLister typene poster med kommandoene deresKommandoreferanse
status200 versionSkriver ut CLI-ens versjonKommandoreferanse
status200 help [command]Viser hjelpen til en kommandoFå hjelp

Globale alternativer

Disse alternativene virker med hver kommando, før eller etter den:

AlternativHva det gjør
--api-key <key>API-nøkkelen for denne kommandoen, i stedet for den lagrede
--url <url>Adressen til Status200-en din for denne kommandoen
--context <name>En lagret kontekst for denne kommandoen, i stedet for den gjeldende
-o, --output <format>table, json eller wide: se Utdataformater
--no-colorSkriver ut uten farger
-V, --versionSkriver ut CLI-ens versjon
-h, --helpViser hjelpen til kommandoen

Få hjelp

Hver kommando har sin egen hjelp, med argumentene, alternativene og standardverdiene sine:

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

Neste steg

AutentiseringKontekster for hvert miljø, og hvilken nøkkel en kommando bruker.RessursoperasjonerList, les, opprett, endre, slett og tell poster.UtdataformaterTabeller for mennesker, JSON for skript.Skripting og CI/CDAvslutningskoder, jq og pipelines.KommandoreferanseHver kommando, hvert alternativ og hver standardverdi.