# Vue d'ensemble de la CLI

La CLI de Status200, `status200`, gère votre projet Status200 depuis un terminal ou un script. Elle liste, lit, crée, modifie, supprime et compte les moniteurs, incidents, alertes, pages de statut et les autres enregistrements que l'API de Status200 propose, avec une clé API de votre projet.

:::cards
- [Comment fonctionne la CLI](#comment-fonctionne-la-cli): Une commande, une requête à l'API, une réponse.
- [Installer la CLI](#installer-la-cli): Une commande npm, et la version à choisir.
- [Lancer vos premières commandes](#lancer-vos-premières-commandes): Enregistrez votre clé API, puis listez vos incidents.
- [Les commandes en un coup d'œil](#les-commandes-en-un-coup-dœil): Chaque commande, et la page qui l'explique.
:::

## Comment fonctionne la CLI

Chaque commande envoie une requête à l'API REST de Status200 et affiche la réponse. La CLI prend la clé API et l'adresse de votre Status200 dans des options, des variables d'environnement ou un contexte enregistré par `status200 login`. La clé décide de ce qu'une commande peut lire et modifier, exactement comme pour l'API.

```mermaid title="Une commande, une requête"
flowchart TB
    T["Votre terminal<br/>ou une tâche de CI"] -->|"status200 incident list"| C["CLI status200"]
    K["La clé API et l'URL :<br/>options, environnement<br/>ou un contexte<br/>enregistré"] --> C
    C -->|"POST /api/incident/get-list"| A["API REST de Status200"]
    A -->|"les enregistrements<br/>que la clé peut lire,<br/>en JSON"| C
    C -->|"un tableau dans<br/>un terminal,<br/>du JSON dans un pipe"| T
```

Les commandes des enregistrements sont livrées avec la CLI : chaque type d'enregistrement que l'API de Status200 ouvre aux outils en a une, les mêmes enregistrements pour lesquels le [serveur MCP](/docs/ai/mcp-server) a des outils. Lancez `status200 resources` pour les lister.

## Avant de commencer

- **Node.js et npm**, dans une version LTS actuelle, pour installer la CLI.
- **Une clé API de votre projet.** Créez-en une dans **Paramètres du projet → Avancé → Clés API** avec **Créer : Clé API** : voir [Créer une clé API](/docs/api-reference/api-reference#créer-une-clé-api).
- **Sur Status200 Cloud, l'offre Growth ou supérieure.** Les clés API d'un projet ne fonctionnent qu'avec elle : voir [Clés API et SCIM sous leur offre](/docs/api-reference/api-reference#clés-api-et-scim-sous-leur-offre).

## Installer la CLI

Installez le paquet `@status200/cli` depuis npm. Il ajoute la commande `status200`, et `--version` affiche la version installée :

```bash
npm install -g @status200/cli
status200 --version
```

La CLI sort en même temps que Status200 et porte le même numéro de version. Sur un Status200 auto-hébergé, installez la CLI de la version de votre Status200, afin que ses commandes correspondent aux enregistrements de votre serveur :

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

## Lancer vos premières commandes

:::steps
### Enregistrer votre clé API

Connectez-vous avec la clé et l'adresse de votre Status200. La CLI les enregistre comme un contexte nommé `default` et l'utilise désormais :

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

Elle répond `Logged in successfully. Context "default" is now active.` Sur un Status200 auto-hébergé, utilisez son adresse à la place de `https://status200.ru`.

### Lister vos incidents

```bash
status200 incident list
```

Les dix incidents les plus récents s'affichent sous forme de tableau. `login` enregistre la clé sans la vérifier : c'est donc cette commande qui montre la première que la clé fonctionne. Si elle est refusée, voir [Dépannage](/docs/cli/authentication#dépannage).

### Voir ce que vous pouvez gérer d'autre

```bash
status200 resources
```

La liste montre chaque type d'enregistrement avec lequel vous pouvez travailler, et sa commande, comme `monitor`, `status-page` ou `on-call-policy`.
:::

## Les commandes en un coup d'œil

| Commande | Ce qu'elle fait | En savoir plus |
| --- | --- | --- |
| `status200 login <api-key> <instance-url>` | Enregistre une clé API et une adresse comme contexte | [Authentification](/docs/cli/authentication#se-connecter) |
| `status200 context list`, `use`, `current`, `delete` | Liste, change, affiche et supprime les contextes enregistrés | [Authentification](/docs/cli/authentication#contextes) |
| `status200 whoami` | Affiche l'URL et la clé API que la prochaine commande utilisera | [Authentification](/docs/cli/authentication#vérifier-ce-que-la-cli-va-utiliser) |
| `status200 deploy` | Enregistre un déploiement, ou un autre changement, pour les graphiques et Status200 AI | [Déploiements et changements](/docs/telemetry/change-events) |
| `status200 <resource> list`, `get`, `create`, `update`, `delete`, `count` | Travaille avec un type d'enregistrement | [Opérations sur les ressources](/docs/cli/resource-operations) |
| `status200 resources` | Liste les types d'enregistrements, avec leurs commandes | [Référence des commandes](/docs/cli/command-reference#status200-resources) |
| `status200 version` | Affiche la version de la CLI | [Référence des commandes](/docs/cli/command-reference#status200-version) |
| `status200 help [command]` | Affiche l'aide d'une commande | [Obtenir de l'aide](#obtenir-de-laide) |

## Options globales

Ces options fonctionnent avec chaque commande, avant ou après elle :

| Option | Ce qu'elle fait |
| --- | --- |
| `--api-key <key>` | La clé API pour cette commande, à la place de celle enregistrée |
| `--url <url>` | L'adresse de votre Status200 pour cette commande |
| `--context <name>` | Un contexte enregistré pour cette commande, à la place du contexte actuel |
| `-o, --output <format>` | `table`, `json` ou `wide` : voir [Formats de sortie](/docs/cli/output-formats) |
| `--no-color` | Affiche sans couleurs |
| `-V, --version` | Affiche la version de la CLI |
| `-h, --help` | Affiche l'aide de la commande |

## Obtenir de l'aide

Chaque commande a sa propre aide, avec ses arguments, ses options et ses valeurs par défaut :

```bash
status200 --help
status200 help incident
status200 incident list --help
```

## Étapes suivantes

:::cards
- [Authentification](/docs/cli/authentication): Des contextes pour chaque environnement, et la clé qu'une commande utilise.
- [Opérations sur les ressources](/docs/cli/resource-operations): Lister, lire, créer, modifier, supprimer et compter des enregistrements.
- [Formats de sortie](/docs/cli/output-formats): Des tableaux pour les humains, du JSON pour les scripts.
- [Scripts et CI/CD](/docs/cli/scripting): Codes de sortie, jq et pipelines.
- [Référence des commandes](/docs/cli/command-reference): Chaque commande, option et valeur par défaut.
:::