# Visão geral da CLI

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.

:::cards
- [Como a CLI funciona](#como-a-cli-funciona): Um comando, uma requisição à API, uma resposta.
- [Instalar a CLI](#instalar-a-cli): Um comando npm, e a versão a escolher.
- [Executar seus primeiros comandos](#executar-seus-primeiros-comandos): Salve sua chave de API e depois liste seus incidentes.
- [Os comandos em resumo](#os-comandos-em-resumo): Cada 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.

```mermaid title="Um comando, uma requisição"
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
```

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](/docs/ai/mcp-server) 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](/docs/api-reference/api-reference#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](/docs/api-reference/api-reference#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

:::steps
### 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`.

### 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](/docs/cli/authentication#solução-de-problemas).

### 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

| Comando | O que faz | Saiba mais |
| --- | --- | --- |
| `status200 login <api-key> <instance-url>` | Salva uma chave de API e um endereço como contexto | [Autenticação](/docs/cli/authentication#fazer-login) |
| `status200 context list`, `use`, `current`, `delete` | Lista, troca, mostra e exclui contextos salvos | [Autenticação](/docs/cli/authentication#contextos) |
| `status200 whoami` | Mostra a URL e a chave de API que o próximo comando vai usar | [Autenticação](/docs/cli/authentication#verificar-o-que-a-cli-vai-usar) |
| `status200 deploy` | Registra um deploy, ou outra alteração, para os gráficos e a Status200 AI | [Deploys e alterações](/docs/telemetry/change-events) |
| `status200 <resource> list`, `get`, `create`, `update`, `delete`, `count` | Trabalha com um tipo de registro | [Operações de recursos](/docs/cli/resource-operations) |
| `status200 resources` | Lista os tipos de registro, com seus comandos | [Referência de comandos](/docs/cli/command-reference#status200-resources) |
| `status200 version` | Imprime a versão da CLI | [Referência de comandos](/docs/cli/command-reference#status200-version) |
| `status200 help [command]` | Mostra a ajuda de um comando | [Obter ajuda](#obter-ajuda) |

## Opções globais

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

| Opção | O 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](/docs/cli/output-formats) |
| `--no-color` | Imprime sem cores |
| `-V, --version` | Imprime a versão da CLI |
| `-h, --help` | Mostra 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

:::cards
- [Autenticação](/docs/cli/authentication): Contextos para cada ambiente, e qual chave um comando usa.
- [Operações de recursos](/docs/cli/resource-operations): Listar, ler, criar, alterar, excluir e contar registros.
- [Formatos de saída](/docs/cli/output-formats): Tabelas para pessoas, JSON para scripts.
- [Scripts e CI/CD](/docs/cli/scripting): Códigos de saída, jq e pipelines.
- [Referência de comandos](/docs/cli/command-reference): Cada comando, opção e valor padrão.
:::