Documentation Index
Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Starting June 15, 2026, Agent SDK and
claude -p usage on subscription plans will draw from a new monthly Agent SDK credit, separate from your interactive usage limits. See Use the Claude Agent SDK with your Claude plan for details.-p avec votre prompt et toute option CLI :
claude -p). Pour les packages SDK Python et TypeScript avec sorties structurées, callbacks d’approbation d’outils et objets de message natifs, consultez la documentation complète de l’Agent SDK.
Utilisation basique
Ajoutez le flag-p (ou --print) à n’importe quelle commande claude pour l’exécuter de manière non-interactive. Toutes les options CLI fonctionnent avec -p, notamment :
--continuepour continuer les conversations--allowedToolspour approuver automatiquement les outils--output-formatpour obtenir une sortie structurée
Démarrer plus rapidement avec le mode bare
Ajoutez--bare pour réduire le temps de démarrage en ignorant la découverte automatique des hooks, skills, plugins, serveurs MCP, mémoire automatique et CLAUDE.md. Sans cela, claude -p charge le même contexte qu’une session interactive, y compris tout ce qui est configuré dans le répertoire de travail ou ~/.claude.
Le mode bare est utile pour CI et les scripts où vous avez besoin du même résultat sur chaque machine. Un hook dans le ~/.claude d’un coéquipier ou un serveur MCP dans le .mcp.json du projet ne s’exécutera pas, car le mode bare ne les lit jamais. Seuls les flags que vous passez explicitement prennent effet.
Cet exemple exécute une tâche de résumé ponctuelle en mode bare et pré-approuve l’outil Read pour que l’appel se termine sans invite de permission :
| Pour charger | Utilisez |
|---|---|
| Ajouts de prompt système | --append-system-prompt, --append-system-prompt-file |
| Paramètres | --settings <file-or-json> |
| Serveurs MCP | --mcp-config <file-or-json> |
| Agents personnalisés | --agents <json> |
| Un plugin | --plugin-dir <path>, --plugin-url <url> |
ANTHROPIC_API_KEY ou d’un apiKeyHelper dans le JSON passé à --settings. Bedrock, Vertex et Foundry utilisent leurs identifiants de fournisseur habituels.
--bare est le mode recommandé pour les appels scriptés et SDK, et deviendra le mode par défaut pour -p dans une version future.Exemples
Ces exemples mettent en évidence les modèles CLI courants. Pour CI et autres appels scriptés, ajoutez--bare pour qu’ils ne reprennent pas ce qui se trouve configuré localement.
Transmettre des données via Claude
Le mode non-interactif lit stdin, vous pouvez donc transmettre des données et rediriger la réponse comme n’importe quel autre outil en ligne de commande. Cet exemple transmet un journal de compilation à Claude et écrit l’explication dans un fichier :--output-format json, la charge utile de réponse inclut total_cost_usd et une ventilation des coûts par modèle, afin que les appelants scriptés puissent suivre les dépenses par invocation sans consulter le tableau de bord d’utilisation.
À partir de Claude Code v2.1.128, stdin transmis est limité à 10 Mo. Si vous dépassez la limite, Claude Code se ferme avec une erreur claire et un statut non nul. Pour travailler avec des entrées plus grandes, écrivez le contenu dans un fichier et référencez le chemin du fichier dans votre prompt au lieu de le transmettre.
Ajouter Claude à un script de compilation
Vous pouvez envelopper un appel non-interactif dans un script pour utiliser Claude comme linter ou examinateur spécifique au projet. Ce scriptpackage.json transmet le diff par rapport à main à Claude et lui demande de signaler les fautes de frappe. Transmettre le diff signifie que Claude n’a pas besoin de permission Bash pour le lire, et les guillemets échappés gardent le script portable vers Windows :
Obtenir une sortie structurée
Utilisez--output-format pour contrôler la façon dont les réponses sont retournées :
text(par défaut) : sortie en texte brutjson: JSON structuré avec résultat, ID de session et métadonnéesstream-json: JSON délimité par des sauts de ligne pour le streaming en temps réel
result :
--output-format json avec --json-schema et une définition JSON Schema. La réponse inclut les métadonnées sur la requête (ID de session, utilisation, etc.) avec la sortie structurée dans le champ structured_output.
Cet exemple extrait les noms de fonctions et les retourne sous forme de tableau de chaînes :
Réponses en streaming
Utilisez--output-format stream-json avec --verbose et --include-partial-messages pour recevoir les tokens au fur et à mesure qu’ils sont générés. Chaque ligne est un objet JSON représentant un événement :
-r affiche les chaînes brutes (sans guillemets) et -j joint sans sauts de ligne pour que les tokens se diffusent en continu :
system/api_retry avant de réessayer. Vous pouvez l’utiliser pour afficher la progression des tentatives ou implémenter une logique de backoff personnalisée.
| Champ | Type | Description |
|---|---|---|
type | "system" | type de message |
subtype | "api_retry" | identifie ceci comme un événement de tentative |
attempt | entier | numéro de tentative actuel, commençant à 1 |
max_retries | entier | nombre total de tentatives autorisées |
retry_delay_ms | entier | millisecondes jusqu’à la prochaine tentative |
error_status | entier ou null | code de statut HTTP, ou null pour les erreurs de connexion sans réponse HTTP |
error | chaîne | catégorie d’erreur : authentication_failed, oauth_org_not_allowed, billing_error, rate_limit, invalid_request, server_error, max_output_tokens, ou unknown |
uuid | chaîne | identifiant d’événement unique |
session_id | chaîne | session à laquelle appartient l’événement |
system/init rapporte les métadonnées de session, y compris le modèle, les outils, les serveurs MCP et les plugins chargés. C’est le premier événement du flux sauf si CLAUDE_CODE_SYNC_PLUGIN_INSTALL est défini, auquel cas les événements plugin_install le précèdent. Utilisez les champs de plugin pour échouer CI quand un plugin n’a pas pu être chargé :
| Champ | Type | Description |
|---|---|---|
plugins | tableau | plugins qui se sont chargés avec succès, chacun avec name et path |
plugin_errors | tableau | erreurs de chargement de plugin, chacune avec plugin, type et message. Inclut les versions de dépendance non satisfaites et les défaillances de chargement --plugin-dir telles qu’un chemin manquant ou une archive invalide. Les plugins affectés sont rétrogradés et absents de plugins. La clé est omise quand il n’y a pas d’erreurs |
CLAUDE_CODE_SYNC_PLUGIN_INSTALL est défini, Claude Code émet des événements system/plugin_install pendant que les plugins de marketplace s’installent avant le premier tour. Utilisez-les pour afficher la progression de l’installation dans votre propre interface utilisateur.
| Champ | Type | Description |
|---|---|---|
type | "system" | type de message |
subtype | "plugin_install" | identifie ceci comme un événement d’installation de plugin |
status | "started", "installed", "failed", ou "completed" | started et completed encadrent l’installation globale ; installed et failed rapportent les marketplaces individuelles |
name | chaîne, optionnel | nom de la marketplace, présent sur installed et failed |
error | chaîne, optionnel | message d’échec, présent sur failed |
uuid | chaîne | identifiant d’événement unique |
session_id | chaîne | session à laquelle appartient l’événement |
Approuver automatiquement les outils
Utilisez--allowedTools pour permettre à Claude d’utiliser certains outils sans demander. Cet exemple exécute une suite de tests et corrige les défaillances, permettant à Claude d’exécuter des commandes Bash et de lire/modifier des fichiers sans demander la permission :
dontAsk refuse tout ce qui n’est pas dans vos règles permissions.allow ou l’ensemble de commandes en lecture seule, ce qui est utile pour les exécutions CI verrouillées. acceptEdits permet à Claude d’écrire des fichiers sans demander et approuve également automatiquement les commandes de système de fichiers courants telles que mkdir, touch, mv et cp. Les autres commandes shell et requêtes réseau ont toujours besoin d’une entrée --allowedTools ou d’une règle permissions.allow, sinon l’exécution s’arrête quand l’une d’elles est tentée :
Créer un commit
Cet exemple examine les modifications mises en scène et crée un commit avec un message approprié :--allowedTools utilise la syntaxe des règles de permission. L’espace * à la fin active la correspondance de préfixe, donc Bash(git diff *) autorise n’importe quelle commande commençant par git diff. L’espace avant * est important : sans lui, Bash(git diff*) correspondrait également à git diff-index.
Les skills invoquées par l’utilisateur comme
/commit et les commandes intégrées ne sont disponibles qu’en mode interactif. En mode -p, décrivez plutôt la tâche que vous souhaitez accomplir.Personnaliser le prompt système
Utilisez--append-system-prompt pour ajouter des instructions tout en conservant le comportement par défaut de Claude Code. Cet exemple envoie un diff de PR à Claude et lui demande de vérifier les vulnérabilités de sécurité :
--system-prompt pour remplacer complètement le prompt par défaut.
Continuer les conversations
Utilisez--continue pour continuer la conversation la plus récente, ou --resume avec un ID de session pour continuer une conversation spécifique. Cet exemple exécute un examen, puis envoie des prompts de suivi :
Étapes suivantes
- Démarrage rapide de l’Agent SDK : créez votre premier agent avec Python ou TypeScript
- Référence CLI : tous les flags et options CLI
- GitHub Actions : utilisez l’Agent SDK dans les workflows GitHub
- GitLab CI/CD : utilisez l’Agent SDK dans les pipelines GitLab