Ir para o conteúdo
Documentação
Visão geral da CLI

Visão geral da CLI

Ver como Markdown

A CLI do Status200, status200, gerencia o seu projeto do Status200 a partir de um terminal ou de um script. Ela lista, lê, cria, altera, exclui e conta monitores, incidentes, alertas, páginas de status e os outros registros que a API do Status200 oferece, com uma chave de API do seu projeto.

Como a CLI funcionaUm comando, uma requisição à API, uma resposta.Instalar a CLIUm comando npm, e a versão a escolher.Executar seus primeiros comandosSalve sua chave de API e depois liste seus incidentes.Os comandos em resumoCada comando, e a página que o explica.

Como a CLI funciona

Cada comando envia uma requisição à API REST do Status200 e imprime a resposta. A CLI pega a chave de API e o endereço do seu Status200 de flags, variáveis de ambiente ou de um contexto que o status200 login salvou. A chave decide o que um comando pode ler e alterar, exatamente como na API.

flowchart TB T["Seu terminal<br/>ou um job de CI"] -->|"status200 incident list"| C["CLI status200"] K["A chave de API e a URL:<br/>flags, ambiente<br/>ou um contexto salvo"] --> C C -->|"POST /api/incident/get-list"| A["API REST do Status200"] A -->|"os registros que a chave<br/>pode ler, em JSON"| C C -->|"uma tabela no terminal,<br/>JSON em um pipe"| T

Um comando, uma requisição

Os comandos dos registros vêm com a CLI: cada tipo de registro que a API do Status200 abre para ferramentas tem um, os mesmos registros para os quais o servidor MCP tem ferramentas. Execute status200 resources para listá-los.

Antes de começar

  • Node.js e npm, em uma versão LTS atual, para instalar a CLI.
  • Uma chave de API do seu projeto. Crie uma em Configurações do projeto → Avançado → Chaves de API com Criar: Chave de API: veja Criar uma chave de API.
  • No Status200 Cloud, o plano Growth ou superior. As chaves de API de um projeto só funcionam nele: veja Chaves de API e SCIM abaixo do plano.

Instalar a CLI

Instale o pacote @status200/cli pelo npm. Ele adiciona o comando status200, e --version imprime a versão instalada:

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

A CLI é lançada junto com o Status200 e tem o mesmo número de versão. Em um Status200 auto-hospedado, instale a CLI da versão do seu Status200, para que os comandos dela correspondam aos registros do seu servidor:

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

Executar seus primeiros comandos

  1. Salvar sua chave de API

    Faça login com a chave e o endereço do seu Status200. A CLI os salva como um contexto chamado default e o usa a partir de agora:

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

    Ela responde Logged in successfully. Context "default" is now active. Em um Status200 auto-hospedado, use o endereço dele no lugar de https://status200.ru.

  2. Listar seus incidentes

    Bash 
    status200 incident list

    Os dez incidentes mais recentes aparecem como uma tabela. O login salva a chave sem verificá-la, então este é o primeiro comando que mostra que a chave funciona: se ela for recusada, veja Solução de problemas.

  3. Ver o que mais você pode gerenciar

    Bash 
    status200 resources

    A lista mostra cada tipo de registro com que você pode trabalhar, e o comando dele, como monitor, status-page ou on-call-policy.

Os comandos em resumo

ComandoO que fazSaiba mais
status200 login <api-key> <instance-url>Salva uma chave de API e um endereço como contextoAutenticação
status200 context list, use, current, deleteLista, troca, mostra e exclui contextos salvosAutenticação
status200 whoamiMostra a URL e a chave de API que o próximo comando vai usarAutenticação
status200 deployRegistra um deploy, ou outra alteração, para os gráficos e a Status200 AIDeploys e alterações
status200 <resource> list, get, create, update, delete, countTrabalha com um tipo de registroOperações de recursos
status200 resourcesLista os tipos de registro, com seus comandosReferência de comandos
status200 versionImprime a versão da CLIReferência de comandos
status200 help [command]Mostra a ajuda de um comandoObter ajuda

Opções globais

Estas opções funcionam com todos os comandos, antes ou depois deles:

OpçãoO que faz
--api-key <key>A chave de API para este comando, no lugar da salva
--url <url>O endereço do seu Status200 para este comando
--context <name>Um contexto salvo para este comando, no lugar do atual
-o, --output <format>table, json ou wide: veja Formatos de saída
--no-colorImprime sem cores
-V, --versionImprime a versão da CLI
-h, --helpMostra a ajuda do comando

Obter ajuda

Cada comando tem sua própria ajuda, com seus argumentos, opções e valores padrão:

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

Próximos passos

AutenticaçãoContextos para cada ambiente, e qual chave um comando usa.Operações de recursosListar, ler, criar, alterar, excluir e contar registros.Formatos de saídaTabelas para pessoas, JSON para scripts.Scripts e CI/CDCódigos de saída, jq e pipelines.Referência de comandosCada comando, opção e valor padrão.