---
title: Utiliser la CLI
url: https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/using
description: Structure des commandes, formats de sortie, transformations GJSON, corps de requête et débogage pour la CLI ant.
---

Cette page couvre les mécanismes d'entrée et de sortie de la CLI `ant` qui s'appliquent à tous les endpoints. Pour l'installer et vous authentifier, consultez le [Démarrage rapide](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/quickstart). Pour enchaîner des commandes et versionner des ressources, consultez [Scripts et automatisation avec la CLI](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/scripting).

## Structure des commandes

Les commandes suivent un modèle `resource action`. Les ressources imbriquées utilisent des deux-points :

```text wrap
ant <resource>[:<subresource>] <action> [flags]
```

Exécutez `ant --help` pour obtenir la liste complète des ressources, ou ajoutez `--help` à n'importe quelle sous-commande pour afficher ses options.

Les ressources en bêta (notamment les agents, les sessions, les déploiements et les environnements) se trouvent sous le préfixe `beta:`. Les commandes de cet espace de noms envoient automatiquement l'en-tête `anthropic-beta` approprié pour cette ressource, vous n'avez donc pas besoin de le transmettre vous-même. Utilisez `--beta <header>` uniquement pour remplacer la valeur par défaut (par exemple, pour opter pour une version de schéma différente).

```bash
ant models list
ant messages create --model claude-opus-5-5 --max-tokens 1024 ...
ant beta:agents retrieve --agent-id agent_01...
ant beta:sessions:events list --session-id session_01...
```

### Options globales

| Option                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--profile`                           | Profil nommé à utiliser pour cette invocation (équivalent à la définition de `ANTHROPIC_PROFILE`). Consultez [Basculer entre les espaces de travail](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/authentication#switch-between-workspaces).                                                                                                                                                                                                                                                                                                     |
| `--api-key-stdin`                     | Lit la clé API depuis l'entrée standard. L'option lit l'intégralité de l'entrée standard, transmettez donc le corps de la requête avec des [options](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/using#flags).                                                                                                                                                                                                                                                                                                                                  |
| `--auth-token-stdin`                  | Lit le jeton bearer depuis l'entrée standard. L'option lit l'intégralité de l'entrée standard, transmettez donc le corps de la requête avec des [options](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/using#flags).                                                                                                                                                                                                                                                                                                                             |
| `--format`                            | Format de sortie : `auto`, `json`, `jsonl`, `yaml`, `pretty`, `raw`, `explore`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `--transform`                         | Filtre ou remodèle la réponse avec un [chemin GJSON](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/using#transform-output-with-gjson)                                                                                                                                                                                                                                                                                                                                                                                                             |
| `-r`, `--raw-output`                  | Affiche les résultats de type chaîne sans guillemets, comme `jq -r`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `--base-url`                          | Remplace l'URL de base de l'API                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `--workspace-id`                      | Facultatif. ID de l'espace de travail (`wrkspc_...`) à envoyer dans l'en-tête `anthropic-workspace-id`, pour les clés API ayant accès à plusieurs espaces de travail (équivalent à la définition de `ANTHROPIC_WORKSPACE_ID`). Consultez [Sélectionner un espace de travail](https://platform.claude.com/docs/fr/manage-claude/authentication#select-a-workspace). Les commandes de l'[Admin API](https://platform.claude.com/docs/fr/manage-claude/admin-api) acceptent leur propre `--workspace-id`, qui désigne plutôt l'espace de travail qu'elles gèrent. |
| `--debug`                             | Affiche la requête et la réponse HTTP complètes sur stderr                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `--format-error`, `--transform-error` | Identiques à `--format` et `--transform`, mais appliquées aux [réponses d'erreur](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/scripting#inspect-errors)                                                                                                                                                                                                                                                                                                                                                                                         |

## Formats de sortie

`auto` affiche le JSON de manière lisible et constitue la valeur par défaut pour les commandes qui créent ou modifient des ressources. Les commandes de liste et de récupération utilisent par défaut l'[explorateur interactif](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/using#interactive-explorer) lorsqu'elles écrivent dans un terminal, et le JSON formaté lorsque la sortie est redirigée. Remplacez l'une ou l'autre de ces valeurs par défaut avec `--format` :

```bash
ant models retrieve --model-id claude-opus-5-5 --format yaml
```

```yaml Output
type: model
id: claude-opus-5-5
display_name: Claude Opus 5.5
created_at: "2026-09-22T00:00:00Z"
...
```

Les endpoints de liste paginent automatiquement. Dans les formats par défaut, chaque élément est écrit séparément (un objet JSON compact par ligne en mode `jsonl`, un flux de documents YAML en mode `yaml`), ce qui permet un streaming propre vers `head`, `grep` et les filtres `--transform`.

### Explorateur interactif

L'explorateur est une TUI avec repli et recherche permettant de parcourir des réponses volumineuses. Les touches fléchées développent et réduisent les nœuds, `/` lance une recherche, `q` permet de quitter. Les commandes de liste et de récupération l'ouvrent par défaut lorsqu'elles sont connectées à un terminal. Passez `--format explore` pour l'ouvrir explicitement :

```bash
ant models list --format explore
```

## Transformer la sortie avec GJSON

Utilisez `--transform` pour remodeler les réponses avant de les afficher. L'expression est un [chemin GJSON](https://github.com/tidwall/gjson/blob/master/SYNTAX.md). Pour les endpoints de liste, la transformation s'exécute sur chaque élément individuellement, et non sur l'enveloppe :

```bash
ant beta:agents list \
  --transform "{id,name,model}" \
  --format jsonl
```

```jsonl Output
{"id": "agent_011CYm1BLqPX...", "name": "Docs CLI Test Agent", "model": "claude-opus-5-5"}
{"id": "agent_011CYkVwfaEt...", "name": "Coffee Making Assistant", "model": "claude-opus-5-5"}
{"id": "agent_011CYixHhtUP...", "name": "Coding Assistant", "model": "claude-opus-5-5"}
```

### Extraire une valeur scalaire

Pour capturer un seul champ sous forme de chaîne sans guillemets (par exemple, l'ID d'une ressource nouvellement créée), associez `--transform` à `--raw-output`. Le résultat s'affiche sans guillemets JSON et est prêt à être assigné à une variable shell :

```bash
AGENT_ID=$(ant beta:agents create \
  --name "My Agent" \
  --model '{id: claude-opus-5-5}' \
  --transform id --raw-output)
```

<Note>
  `--raw-output` est distinct de `--format raw`. `--raw-output` supprime les guillemets JSON des résultats de type chaîne, comme `jq -r`. `--format raw` affiche les octets JSON bruts du corps de la réponse sans pagination automatique ; sur les endpoints de liste, il applique `--transform` à l'enveloppe de pagination plutôt qu'à chaque élément.
</Note>

## Transmettre des corps de requête

Le mécanisme d'entrée approprié dépend de la forme des données : utilisez des **options** pour les champs scalaires et les valeurs structurées courtes, redirigez un document vers **stdin** pour les corps imbriqués ou multilignes, et utilisez des **références `@file`** pour insérer le contenu de fichiers dans n'importe quel champ de type chaîne ou binaire.

### Options

Les champs scalaires correspondent directement à des options. Les champs structurés acceptent une syntaxe souple de type YAML (clés sans guillemets, guillemets facultatifs autour des chaînes) ou du JSON strict :

```bash
ant beta:sessions create \
  --agent '{type: agent, id: agent_011CYm1BLqPXpQRk5khsSXrs, version: 1}' \
  --environment-id env_01595EKxaaTTGwwY3kyXdtbs \
  --title "CLI docs test session"
```

Les options répétables construisent des tableaux. Chaque `--tool` ou `--event` ajoute un élément :

```bash
ant beta:agents create \
  --name "Research Agent" \
  --model '{id: claude-opus-5-5}' \
  --tool '{type: agent_toolset_20260401}' \
  --tool '{type: custom, name: search_docs, input_schema: {type: object, properties: {query: {type: string}}}}'
```

### Stdin

Redirigez un document JSON ou YAML vers stdin pour fournir le corps complet de la requête. Les champs provenant de stdin sont fusionnés avec les options, les options étant prioritaires. Ici, `version` est le jeton de verrouillage optimiste renvoyé par un `retrieve` antérieur, et `$AGENT_ID` a été capturé comme dans [Extraire une valeur scalaire](https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/using#extract-a-scalar) :

```bash
echo '{"description": "Updated test agent.", "version": 1}' | \
  ant beta:agents update --agent-id "$AGENT_ID"
```

Les heredocs fonctionnent de la même manière et sont pratiques pour le YAML multiligne. Mettez le délimiteur entre guillemets (comme dans `<<'YAML'`) pour désactiver l'expansion des variables dans le corps.

```bash
ant beta:agents create <<'YAML'
name: Research Agent
model: claude-opus-5-5
system: |
  You are a research assistant. Cite sources for every claim.
tools:
  - type: agent_toolset_20260401
YAML
```

### Références de fichiers

Les options qui acceptent un chemin de fichier, comme `--file` sur la commande de téléversement, acceptent un chemin simple :

```bash
ant files upload --file ./report.pdf
```

Pour insérer le contenu d'un fichier dans un champ de type chaîne, préfixez le chemin avec `@` :

```bash
ant beta:agents create \
  --name "Researcher" --model '{id: claude-opus-5-5}' \
  --system @./prompts/researcher.txt
```

Dans les valeurs d'options structurées, mettez le chemin entre guillemets. Pour envoyer un PDF à l'API Messages :

```bash
ant messages create \
  --model claude-opus-5-5 \
  --max-tokens 1024 \
  --message '{role: user, content: [
    {type: document, source: {type: base64, media_type: application/pdf, data: "@./scan.pdf"}},
    {type: text, text: "Extract the text from this scanned document."}
  ]}'
```

La CLI détecte le type de fichier et encode automatiquement les fichiers binaires en base64. Pour forcer un encodage spécifique, utilisez `@file://` pour le texte brut ou `@data://` pour le base64. Échappez un `@` initial littéral avec une barre oblique inverse (`\@username`).

## Débogage

Ajoutez `--debug` à n'importe quelle commande pour afficher la requête et la réponse HTTP exactes (en-têtes et corps) sur stderr. Les clés API sont masquées.

```bash
ant --debug beta:agents list
```

```text Output wrap
GET /v1/agents?beta=true HTTP/1.1
Host: api.anthropic.com
Anthropic-Beta: managed-agents-2026-04-01
Anthropic-Version: 2026-10-21
Authorization: Bearer <REDACTED>
...
```

## Ressources disponibles

Chaque ressource de l'API exposée par la CLI est documentée dans la [référence de l'API](https://platform.claude.com/docs/fr/api/cli/messages/create). Pour obtenir une liste locale, exécutez `ant --help`, et ajoutez `--help` à n'importe quelle sous-commande pour afficher ses options et paramètres.

## Étapes suivantes

<CardGroup cols={3}>
  <Card title="Scripts et automatisation avec la CLI" icon="code" href="https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/scripting">
    Versionnement des ressources de l'API, modèles de scripts et utilisation depuis Claude Code
  </Card>

  <Card title="Référence de l'API" icon="book" href="https://platform.claude.com/docs/fr/api/cli/messages/create">
    Paramètres spécifiques aux endpoints, champs de requête et schémas de réponse
  </Card>

  <Card title="Options d'authentification de la CLI" icon="lock" href="https://platform.claude.com/docs/fr/cli-sdks-libraries/cli/authentication">
    Clés API, hôtes sans interface, espaces de travail multiples et profils nommés
  </Card>
</CardGroup>