agent-sdk/slash-commands.md +0 −594 deleted
File Deleted View Diff
1> ## Documentation Index
2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
3> Use this file to discover all available pages before exploring further.
4
5# Slash Commands dans le SDK
6
7> Apprenez à utiliser les slash commands pour contrôler les sessions Claude Code via le SDK
8
9Les slash commands offrent un moyen de contrôler les sessions Claude Code avec des commandes spéciales commençant par `/`. Ces commandes peuvent être envoyées via le SDK pour effectuer des actions comme compacter le contexte, lister l'utilisation du contexte ou invoquer des commandes personnalisées. Seules les commandes qui fonctionnent sans terminal interactif peuvent être envoyées via le SDK ; le message `system/init` liste celles disponibles dans votre session.
10
11<h2 id="discovering-available-slash-commands">
12 Découvrir les Slash Commands Disponibles
13</h2>
14
15Le Claude Agent SDK fournit des informations sur les slash commands disponibles dans le message d'initialisation du système. Accédez à ces informations au démarrage de votre session :
16
17<CodeGroup>
18 ```typescript TypeScript theme={null}
19 import { query } from "@anthropic-ai/claude-agent-sdk";
20
21 for await (const message of query({
22 prompt: "Hello Claude",
23 options: { maxTurns: 1 }
24 })) {
25 if (message.type === "system" && message.subtype === "init") {
26 console.log("Available slash commands:", message.slash_commands);
27 // Includes built-in commands plus bundled skills, for example:
28 // ["clear", "compact", "context", "usage", "code-review", "verify", ...]
29 }
30 }
31 ```
32
33 ```python Python theme={null}
34 import asyncio
35 from claude_agent_sdk import query, ClaudeAgentOptions, SystemMessage
36
37
38 async def main():
39 async for message in query(prompt="Hello Claude", options=ClaudeAgentOptions(max_turns=1)):
40 if isinstance(message, SystemMessage) and message.subtype == "init":
41 print("Available slash commands:", message.data["slash_commands"])
42 # Includes built-in commands plus bundled skills, for example:
43 # ["clear", "compact", "context", "usage", "code-review", "verify", ...]
44
45
46 asyncio.run(main())
47 ```
48</CodeGroup>
49
50<h2 id="sending-slash-commands">
51 Envoyer des Slash Commands
52</h2>
53
54Envoyez des slash commands en les incluant dans votre chaîne de prompt, comme du texte ordinaire. Les commandes qui agissent sur l'historique de la conversation, telles que `/compact`, ont besoin de messages antérieurs pour fonctionner, donc les exemples ci-dessous posent d'abord une question, puis envoient la commande comme suivi à la même conversation :
55
56<CodeGroup>
57 ```typescript TypeScript theme={null}
58 import { query } from "@anthropic-ai/claude-agent-sdk";
59
60 // Build up conversation history first
61 try {
62 for await (const message of query({
63 prompt: "What does the README in this directory cover?",
64 options: { maxTurns: 2 }
65 })) {
66 if (message.type === "result" && message.subtype === "success") {
67 console.log(message.result);
68 }
69 }
70 } catch (error) {
71 // A single-shot query() throws after yielding an error result,
72 // so the follow-up query below still runs.
73 console.error(`Session ended with an error: ${error}`);
74 }
75
76 // Send a slash command as a follow-up to the same conversation
77 for await (const message of query({
78 prompt: "/compact",
79 options: { continue: true, maxTurns: 1 }
80 })) {
81 if (message.type === "result") {
82 console.log("Command executed, result subtype:", message.subtype);
83 // Example output: Command executed, result subtype: success
84 }
85 }
86 ```
87
88 ```python Python theme={null}
89 import asyncio
90 from claude_agent_sdk import query, ClaudeAgentOptions, ResultMessage
91
92
93 async def main():
94 # Build up conversation history first
95 try:
96 async for message in query(
97 prompt="What does the README in this directory cover?",
98 options=ClaudeAgentOptions(max_turns=2),
99 ):
100 if isinstance(message, ResultMessage) and message.subtype == "success":
101 print(message.result)
102 except Exception as error:
103 # A single-shot query() raises after yielding an error result,
104 # so the follow-up query below still runs.
105 print(f"Session ended with an error: {error}")
106
107 # Send a slash command as a follow-up to the same conversation
108 async for message in query(
109 prompt="/compact",
110 options=ClaudeAgentOptions(continue_conversation=True, max_turns=1),
111 ):
112 if isinstance(message, ResultMessage):
113 print("Command executed, result subtype:", message.subtype)
114 # Example output: Command executed, result subtype: success
115
116
117 asyncio.run(main())
118 ```
119</CodeGroup>
120
121<Note>
122 Une requête peut se terminer par un résultat d'erreur, par exemple lorsque la limite `maxTurns` / `max_turns` est atteinte avant la fin du travail. Le message de résultat final a alors `is_error: true` et un sous-type d'erreur tel que `error_max_turns` au lieu de `success`.
123
124 Après avoir produit ce message de résultat final, le SDK lève une erreur, car le processus CLI se termine avec un code non nul.
125
126 Enveloppez la boucle dans un `try`/`catch` en TypeScript ou `try`/`except` en Python si votre commande pourrait atteindre la limite, comme indiqué dans [Single Message Input](/fr/agent-sdk/streaming-vs-single-mode#single-message-input), ou définissez `maxTurns` suffisamment haut pour que le travail se termine. En Python, capturez `Exception` : le SDK présente les résultats d'erreur comme une simple `Exception`.
127</Note>
128
129<h2 id="common-slash-commands">
130 Commandes Slash Courantes
131</h2>
132
133<h3 id="/compact-compact-conversation-history">
134 `/compact` - Compacter l'historique de conversation
135</h3>
136
137La commande `/compact` réduit la taille de votre historique de conversation en résumant les messages plus anciens tout en préservant le contexte important. La compaction nécessite une conversation existante avec au moins deux échanges antérieurs à résumer. Cet exemple a d'abord une conversation, puis la compacte et lit le message système `compact_boundary` qui rapporte le résultat :
138
139<CodeGroup>
140 ```typescript TypeScript theme={null}
141 import { query } from "@anthropic-ai/claude-agent-sdk";
142
143 // Compaction needs existing history, so have a conversation first
144 try {
145 for await (const message of query({
146 prompt: "Explain what this project does",
147 options: { maxTurns: 2 }
148 })) {
149 if (message.type === "result" && message.subtype === "success") {
150 console.log(message.result);
151 }
152 }
153 } catch (error) {
154 // A single-shot query() throws after yielding an error result,
155 // so the follow-up query below still runs.
156 console.error(`Session ended with an error: ${error}`);
157 }
158
159 // Compact the same conversation
160 for await (const message of query({
161 prompt: "/compact",
162 options: { continue: true, maxTurns: 1 }
163 })) {
164 if (message.type === "system" && message.subtype === "compact_boundary") {
165 console.log("Compaction completed");
166 console.log("Pre-compaction tokens:", message.compact_metadata.pre_tokens);
167 console.log("Trigger:", message.compact_metadata.trigger);
168 // Example output:
169 // Compaction completed
170 // Pre-compaction tokens: 1842
171 // Trigger: manual
172 }
173 }
174 ```
175
176 ```python Python theme={null}
177 import asyncio
178 from claude_agent_sdk import query, ClaudeAgentOptions, ResultMessage, SystemMessage
179
180
181 async def main():
182 # Compaction needs existing history, so have a conversation first
183 try:
184 async for message in query(
185 prompt="Explain what this project does",
186 options=ClaudeAgentOptions(max_turns=2),
187 ):
188 if isinstance(message, ResultMessage) and message.subtype == "success":
189 print(message.result)
190 except Exception as error:
191 # A single-shot query() raises after yielding an error result,
192 # so the follow-up query below still runs.
193 print(f"Session ended with an error: {error}")
194
195 # Compact the same conversation
196 async for message in query(
197 prompt="/compact",
198 options=ClaudeAgentOptions(continue_conversation=True, max_turns=1),
199 ):
200 if isinstance(message, SystemMessage) and message.subtype == "compact_boundary":
201 print("Compaction completed")
202 print("Pre-compaction tokens:", message.data["compact_metadata"]["pre_tokens"])
203 print("Trigger:", message.data["compact_metadata"]["trigger"])
204 # Example output:
205 # Compaction completed
206 # Pre-compaction tokens: 1842
207 # Trigger: manual
208
209
210 asyncio.run(main())
211 ```
212</CodeGroup>
213
214<Note>
215 Un message `compact_boundary` n'arrive que lorsque la compaction s'est exécutée. S'il n'y a rien à résumer, `/compact` rapporte la raison au lieu de lever une exception : l'exécution se termine toujours avec un résultat `success`, aucun message `compact_boundary` n'est émis, et le texte du résultat porte le message, par exemple `Not enough messages to compact.` après un seul échange court. Un nouvel appel `query()` ponctuel démarre avec un contexte vide, donc utilisez ce modèle dans une session avec des tours antérieurs, par exemple en [mode d'entrée en continu](/fr/agent-sdk/streaming-vs-single-mode) ou lors de la reprise d'une session.
216</Note>
217
218<h3 id="/clear-reset-conversation-context">
219 `/clear` - Réinitialiser le contexte de conversation
220</h3>
221
222La commande `/clear` réinitialise la conversation à un contexte vide, de sorte que les invites suivantes commencent sans aucun historique de conversation antérieur. La conversation précédente reste sur le disque et peut être reprise en passant son ID de session à l'[option `resume`](/fr/agent-sdk/sessions#resume-by-id).
223
224Ceci est utile en [mode d'entrée en continu](/fr/agent-sdk/streaming-vs-single-mode), où vous envoyez plusieurs invites sur une seule connexion. Pour les appels `query()` ponctuels, chaque appel démarre déjà avec un contexte vide, donc envoyer `/clear` n'a aucun effet pratique ; démarrez plutôt un nouveau `query()`.
225
226<Note>
227 `/clear` dans le SDK nécessite Claude Code v2.1.117 ou version ultérieure. Dans les versions antérieures, il est omis de `slash_commands`.
228</Note>
229
230<h2 id="creating-custom-slash-commands">
231 Créer des Slash Commands Personnalisés
232</h2>
233
234En plus d'utiliser les slash commands intégrés, vous pouvez créer vos propres commandes personnalisées disponibles via le SDK. Les commandes personnalisées sont définies comme des fichiers markdown dans des répertoires spécifiques, de la même manière que les subagents sont configurés.
235
236<Note>
237 Le répertoire `.claude/commands/` est le format hérité. Le format recommandé est `.claude/skills/<name>/SKILL.md`, qui supporte la même invocation slash-command (`/name`) plus l'invocation autonome par Claude. Voir [Skills](/fr/agent-sdk/skills) pour le format actuel. Le CLI continue de supporter les deux formats, et les exemples ci-dessous restent exacts pour `.claude/commands/`.
238</Note>
239
240<h3 id="file-locations">
241 Emplacements des Fichiers
242</h3>
243
244Les slash commands personnalisés sont stockés dans des répertoires désignés selon leur portée :
245
246* **Commandes de projet** : `.claude/commands/` - Disponibles uniquement dans le projet actuel (hérité ; préférez `.claude/skills/`)
247* **Commandes personnelles** : `~/.claude/commands/` - Disponibles dans tous vos projets (hérité ; préférez `~/.claude/skills/`)
248
249<h3 id="file-format">
250 Format du Fichier
251</h3>
252
253Chaque commande personnalisée est un fichier markdown où :
254
255* Le nom du fichier (sans extension `.md`) devient le nom de la commande
256* Le contenu du fichier définit ce que la commande fait
257* Un frontmatter YAML optionnel fournit la configuration
258
259<h4 id="basic-example">
260 Exemple Basique
261</h4>
262
263Créez le répertoire `.claude/commands` dans votre projet s'il n'existe pas, puis créez `.claude/commands/refactor.md` :
264
265```markdown theme={null}
266Refactor the selected code to improve readability and maintainability.
267Focus on clean code principles and best practices.
268```
269
270Cela crée la commande `/refactor` que vous pouvez utiliser via le SDK.
271
272<h4 id="with-frontmatter">
273 Avec Frontmatter
274</h4>
275
276Créez `.claude/commands/security-check.md` :
277
278```markdown theme={null}
279allowed-tools: Read, Grep, Glob
280description: Run security vulnerability scan
281model: claude-opus-4-8
282
283Analyze the codebase for security vulnerabilities including:
284- SQL injection risks
285- XSS vulnerabilities
286- Exposed credentials
287- Insecure configurations
288```
289
290<h3 id="using-custom-commands-in-the-sdk">
291 Utiliser des Commandes Personnalisées dans le SDK
292</h3>
293
294Une fois définies dans le système de fichiers, les commandes personnalisées sont automatiquement disponibles via le SDK :
295
296<CodeGroup>
297 ```typescript TypeScript theme={null}
298 import { query } from "@anthropic-ai/claude-agent-sdk";
299
300 // Use a custom command
301 try {
302 for await (const message of query({
303 prompt: "/refactor src/auth/login.ts",
304 options: { maxTurns: 3 }
305 })) {
306 if (message.type === "assistant") {
307 console.log("Refactoring suggestions:", message.message);
308 }
309 }
310 } catch (error) {
311 // A single-shot query() throws after yielding an error result,
312 // so the second query below still runs.
313 console.error(`Session ended with an error: ${error}`);
314 }
315
316 // Custom commands appear in the slash_commands list
317 for await (const message of query({
318 prompt: "Hello",
319 options: { maxTurns: 1 }
320 })) {
321 if (message.type === "system" && message.subtype === "init") {
322 console.log("Available commands:", message.slash_commands);
323 // Includes built-in commands plus bundled skills and your custom commands, for example:
324 // ["clear", "compact", "context", "usage", "code-review", "verify", "refactor", "security-check", ...]
325 }
326 }
327 ```
328
329 ```python Python theme={null}
330 import asyncio
331 from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, SystemMessage
332
333
334 async def main():
335 # Use a custom command
336 try:
337 async for message in query(
338 prompt="/refactor src/auth/login.py", options=ClaudeAgentOptions(max_turns=3)
339 ):
340 if isinstance(message, AssistantMessage):
341 for block in message.content:
342 if hasattr(block, "text"):
343 print("Refactoring suggestions:", block.text)
344 except Exception as error:
345 # A single-shot query() raises after yielding an error result,
346 # so the second query below still runs.
347 print(f"Session ended with an error: {error}")
348
349 # Custom commands appear in the slash_commands list
350 async for message in query(prompt="Hello", options=ClaudeAgentOptions(max_turns=1)):
351 if isinstance(message, SystemMessage) and message.subtype == "init":
352 print("Available commands:", message.data["slash_commands"])
353 # Includes built-in commands plus bundled skills and your custom commands, for example:
354 # ["clear", "compact", "context", "usage", "code-review", "verify", "refactor", "security-check", ...]
355
356
357 asyncio.run(main())
358 ```
359</CodeGroup>
360
361<h3 id="advanced-features">
362 Fonctionnalités Avancées
363</h3>
364
365<h4 id="arguments-and-placeholders">
366 Arguments et Placeholders
367</h4>
368
369Les commandes personnalisées supportent les arguments dynamiques en utilisant des placeholders :
370
371Créez `.claude/commands/fix-issue.md` :
372
373```markdown theme={null}
374argument-hint: [issue-number] [priority]
375description: Fix a GitHub issue
376
377Fix issue #$0 with priority $1.
378Check the issue description and implement the necessary changes.
379```
380
381Utilisez dans le SDK :
382
383<CodeGroup>
384 ```typescript TypeScript theme={null}
385 import { query } from "@anthropic-ai/claude-agent-sdk";
386
387 // Pass arguments to custom command
388 for await (const message of query({
389 prompt: "/fix-issue 123 high",
390 options: { maxTurns: 5 }
391 })) {
392 // Command will process with $0="123" and $1="high"
393 if (message.type === "result" && message.subtype === "success") {
394 console.log("Issue fixed:", message.result);
395 }
396 }
397 ```
398
399 ```python Python theme={null}
400 import asyncio
401 from claude_agent_sdk import query, ClaudeAgentOptions, ResultMessage
402
403
404 async def main():
405 # Pass arguments to custom command
406 async for message in query(prompt="/fix-issue 123 high", options=ClaudeAgentOptions(max_turns=5)):
407 # Command will process with $0="123" and $1="high"
408 if isinstance(message, ResultMessage):
409 print("Issue fixed:", message.result)
410
411
412 asyncio.run(main())
413 ```
414</CodeGroup>
415
416<h4 id="bash-command-execution">
417 Exécution de Commandes Bash
418</h4>
419
420Les commandes personnalisées peuvent exécuter des commandes bash et inclure leur sortie :
421
422Créez `.claude/commands/git-commit.md` :
423
424```markdown theme={null}
425allowed-tools: Bash(git add *), Bash(git status *), Bash(git commit *)
426description: Create a git commit
427
428## Context
429
430- Current status: !`git status`
431- Current diff: !`git diff HEAD`
432
433## Task
434
435Create a git commit with appropriate message based on the changes.
436```
437
438<h4 id="file-references">
439 Références de Fichiers
440</h4>
441
442Incluez le contenu des fichiers en utilisant le préfixe `@` :
443
444Créez `.claude/commands/review-config.md` :
445
446```markdown theme={null}
447description: Review configuration files
448
449Review the following configuration files for issues:
450- Package config: @package.json
451- TypeScript config: @tsconfig.json
452- Environment config: @.env
453
454Check for security issues, outdated dependencies, and misconfigurations.
455```
456
457<h3 id="organization-with-namespacing">
458 Organisation avec Namespacing
459</h3>
460
461Organisez les commandes dans des sous-répertoires pour une meilleure structure :
462
463```bash theme={null}
464.claude/commands/
465├── frontend/
466│ ├── component.md # Creates /component (project:frontend)
467│ └── style-check.md # Creates /style-check (project:frontend)
468├── backend/
469│ ├── api-test.md # Creates /api-test (project:backend)
470│ └── db-migrate.md # Creates /db-migrate (project:backend)
471└── review.md # Creates /review (project)
472```
473
474Le sous-répertoire apparaît dans la description de la commande mais n'affecte pas le nom de la commande lui-même.
475
476<h3 id="practical-examples">
477 Exemples Pratiques
478</h3>
479
480<h4 id="pull-request-review-command">
481 Commande de Révision de Pull Request
482</h4>
483
484Créez `.claude/commands/review-pr.md` :
485
486```markdown theme={null}
487allowed-tools: Read, Grep, Glob, Bash(git diff *)
488description: Comprehensive code review
489
490## Changed Files
491!`git diff --name-only HEAD~1`
492
493## Detailed Changes
494!`git diff HEAD~1`
495
496## Review Checklist
497
498Review the above changes for:
4991. Code quality and readability
5002. Security vulnerabilities
5013. Performance implications
5024. Test coverage
5035. Documentation completeness
504
505Provide specific, actionable feedback organized by priority.
506```
507
508<Note>
509 Claude Code inclut les skills `code-review` et `verify` intégrés. Si vous nommez une commande personnalisée d'après l'un d'eux, par exemple `.claude/commands/code-review.md`, votre commande masque le skill intégré et `slash_commands` liste le nom une seule fois.
510</Note>
511
512<h4 id="test-runner-command">
513 Commande Test Runner
514</h4>
515
516Créez `.claude/commands/test.md` :
517
518```markdown theme={null}
519allowed-tools: Bash, Read, Edit
520argument-hint: [test-pattern]
521description: Run tests with optional pattern
522
523Run tests matching pattern: $ARGUMENTS
524
5251. Detect the test framework (Jest, pytest, etc.)
5262. Run tests with the provided pattern
5273. If tests fail, analyze and fix them
5284. Re-run to verify fixes
529```
530
531Utilisez ces commandes via le SDK :
532
533<CodeGroup>
534 ```typescript TypeScript theme={null}
535 import { query } from "@anthropic-ai/claude-agent-sdk";
536
537 // Run code review
538 try {
539 for await (const message of query({
540 prompt: "/review-pr",
541 options: { maxTurns: 3 }
542 })) {
543 // Process review feedback
544 }
545 } catch (error) {
546 // A single-shot query() throws after yielding an error result,
547 // so the second query below still runs.
548 console.error(`Session ended with an error: ${error}`);
549 }
550
551 // Run specific tests
552 for await (const message of query({
553 prompt: "/test auth",
554 options: { maxTurns: 5 }
555 })) {
556 // Handle test results
557 }
558 ```
559
560 ```python Python theme={null}
561 import asyncio
562 from claude_agent_sdk import query, ClaudeAgentOptions
563
564
565 async def main():
566 # Run code review
567 try:
568 async for message in query(prompt="/review-pr", options=ClaudeAgentOptions(max_turns=3)):
569 # Process review feedback
570 pass
571 except Exception as error:
572 # A single-shot query() raises after yielding an error result,
573 # so the second query below still runs.
574 print(f"Session ended with an error: {error}")
575
576 # Run specific tests
577 async for message in query(prompt="/test auth", options=ClaudeAgentOptions(max_turns=5)):
578 # Handle test results
579 pass
580
581
582 asyncio.run(main())
583 ```
584</CodeGroup>
585
586<h2 id="see-also">
587 Voir Aussi
588</h2>
589
590* [Slash Commands](/fr/skills) - Documentation complète des slash commands
591* [Subagents dans le SDK](/fr/agent-sdk/subagents) - Configuration similaire basée sur le système de fichiers pour les subagents
592* [Référence TypeScript SDK](/fr/agent-sdk/typescript) - Documentation complète de l'API
593* [Aperçu du SDK](/fr/agent-sdk/overview) - Concepts généraux du SDK
594* [Référence CLI](/fr/cli-reference) - Interface de ligne de commande