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 no SDK
6
7> Aprenda como usar slash commands para controlar sessões do Claude Code através do SDK
8
9Slash commands fornecem uma maneira de controlar sessões do Claude Code com comandos especiais que começam com `/`. Esses comandos podem ser enviados através do SDK para executar ações como compactar contexto, listar uso de contexto ou invocar comandos personalizados. Apenas comandos que funcionam sem um terminal interativo são despachados através do SDK; a mensagem `system/init` lista os disponíveis em sua sessão.
10
11<h2 id="discovering-available-slash-commands">
12 Descobrindo Slash Commands Disponíveis
13</h2>
14
15O Claude Agent SDK fornece informações sobre slash commands disponíveis na mensagem de inicialização do sistema. Acesse essas informações quando sua sessão começar:
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 // Inclui comandos integrados mais skills agrupados, por exemplo:
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 # Inclui comandos integrados mais skills agrupados, por exemplo:
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 Enviando Slash Commands
52</h2>
53
54Envie slash commands incluindo-os em sua string de prompt, assim como texto regular. Comandos que atuam no histórico de conversas, como `/compact`, precisam de mensagens anteriores para funcionar, então os exemplos abaixo fazem uma pergunta primeiro e depois enviam o comando como um acompanhamento para a mesma conversa:
55
56<CodeGroup>
57 ```typescript TypeScript theme={null}
58 import { query } from "@anthropic-ai/claude-agent-sdk";
59
60 // Construir histórico de conversa primeiro
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 // Uma query() de um único disparo lança após produzir um resultado de erro,
72 // então a query de acompanhamento abaixo ainda é executada.
73 console.error(`Session ended with an error: ${error}`);
74 }
75
76 // Enviar um slash command como acompanhamento para a mesma conversa
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 // Exemplo de saída: 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 # Construir histórico de conversa primeiro
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 # Uma query() de um único disparo lança após produzir um resultado de erro,
104 # então a query de acompanhamento abaixo ainda é executada.
105 print(f"Session ended with an error: {error}")
106
107 # Enviar um slash command como acompanhamento para a mesma conversa
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 # Exemplo de saída: Command executed, result subtype: success
115
116
117 asyncio.run(main())
118 ```
119</CodeGroup>
120
121<Note>
122 Uma query pode terminar com um resultado de erro, por exemplo quando o limite `maxTurns` / `max_turns` é atingido antes do trabalho ser concluído. A mensagem de resultado final então tem `is_error: true` e um subtipo de erro como `error_max_turns` em vez de `success`.
123
124 Após produzir essa mensagem de resultado final, o SDK lança um erro, porque o processo CLI sai com um código diferente de zero.
125
126 Envolva o loop em um `try`/`catch` em TypeScript ou `try`/`except` em Python se seu comando puder atingir o limite, como mostrado em [Single Message Input](/pt/agent-sdk/streaming-vs-single-mode#single-message-input), ou defina `maxTurns` alto o suficiente para o trabalho ser concluído. Em Python, capture `Exception`: o SDK apresenta resultados de erro como uma `Exception` simples.
127</Note>
128
129<h2 id="common-slash-commands">
130 Slash Commands Comuns
131</h2>
132
133<h3 id="/compact-compact-conversation-history">
134 `/compact` - Compactar histórico de conversa
135</h3>
136
137O comando `/compact` reduz o tamanho do seu histórico de conversa resumindo mensagens antigas enquanto preserva contexto importante. A compactação precisa de uma conversa existente com pelo menos duas trocas anteriores para resumir. Este exemplo tem uma conversa primeiro, depois a compacta e lê a mensagem do sistema `compact_boundary` que relata o resultado:
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 Uma mensagem `compact_boundary` só chega quando a compactação foi executada. Sem nada para resumir, `/compact` relata o motivo em vez de gerar um erro: a execução ainda termina com um resultado `success`, nenhuma mensagem `compact_boundary` é emitida, e o texto do resultado carrega a mensagem, por exemplo `Not enough messages to compact.` após uma única troca curta. Uma chamada `query()` única e nova começa com contexto vazio, então use este padrão em uma sessão com turnos anteriores, por exemplo no [modo de entrada em streaming](/pt/agent-sdk/streaming-vs-single-mode) ou ao retomar uma sessão.
216</Note>
217
218<h3 id="/clear-reset-conversation-context">
219 `/clear` - Redefinir contexto de conversa
220</h3>
221
222O comando `/clear` redefine a conversa para um contexto vazio, para que os prompts subsequentes comecem sem nenhum histórico de conversa anterior. A conversa anterior permanece no disco e pode ser retomada passando seu ID de sessão para a [opção `resume`](/pt/agent-sdk/sessions#resume-by-id).
223
224Isso é útil no [modo de entrada em streaming](/pt/agent-sdk/streaming-vs-single-mode), onde você envia múltiplos prompts em uma única conexão. Para chamadas `query()` únicas, cada chamada já começa com contexto vazio, então enviar `/clear` não tem efeito prático; inicie uma nova `query()` em vez disso.
225
226<Note>
227 `/clear` no SDK requer Claude Code v2.1.117 ou posterior. Em versões anteriores, ele é omitido de `slash_commands`.
228</Note>
229
230<h2 id="creating-custom-slash-commands">
231 Criando Slash Commands Personalizados
232</h2>
233
234Além de usar slash commands integrados, você pode criar seus próprios comandos personalizados que estão disponíveis através do SDK. Comandos personalizados são definidos como arquivos markdown em diretórios específicos, similar a como subagentes são configurados.
235
236<Note>
237 O diretório `.claude/commands/` é o formato legado. O formato recomendado é `.claude/skills/<name>/SKILL.md`, que suporta a mesma invocação de slash command (`/name`) mais invocação autônoma pelo Claude. Veja [Skills](/pt/agent-sdk/skills) para o formato atual. O CLI continua suportando ambos os formatos, e os exemplos abaixo permanecem precisos para `.claude/commands/`.
238</Note>
239
240<h3 id="file-locations">
241 Localizações de Arquivo
242</h3>
243
244Slash commands personalizados são armazenados em diretórios designados baseado em seu escopo:
245
246* **Comandos de projeto**: `.claude/commands/` - Disponíveis apenas no projeto atual (legado; prefira `.claude/skills/`)
247* **Comandos pessoais**: `~/.claude/commands/` - Disponíveis em todos seus projetos (legado; prefira `~/.claude/skills/`)
248
249<h3 id="file-format">
250 Formato de Arquivo
251</h3>
252
253Cada comando personalizado é um arquivo markdown onde:
254
255* O nome do arquivo (sem extensão `.md`) se torna o nome do comando
256* O conteúdo do arquivo define o que o comando faz
257* Frontmatter YAML opcional fornece configuração
258
259<h4 id="basic-example">
260 Exemplo Básico
261</h4>
262
263Crie o diretório `.claude/commands` em seu projeto se ele não existir, então crie `.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
270Isso cria o comando `/refactor` que você pode usar através do SDK.
271
272<h4 id="with-frontmatter">
273 Com Frontmatter
274</h4>
275
276Crie `.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 Usando Slash Commands Personalizados no SDK
292</h3>
293
294Uma vez definidos no sistema de arquivos, comandos personalizados estão automaticamente disponíveis através do 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 Recursos Avançados
363</h3>
364
365<h4 id="arguments-and-placeholders">
366 Argumentos e Placeholders
367</h4>
368
369Comandos personalizados suportam argumentos dinâmicos usando placeholders:
370
371Crie `.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
381Use no 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 Execução de Comando Bash
418</h4>
419
420Comandos personalizados podem executar comandos bash e incluir sua saída:
421
422Crie `.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 Referências de Arquivo
440</h4>
441
442Inclua conteúdos de arquivo usando o prefixo `@`:
443
444Crie `.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 Organização com Namespacing
459</h3>
460
461Organize comandos em subdiretórios para melhor estrutura:
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
474O subdiretório aparece na descrição do comando mas não afeta o nome do comando em si.
475
476<h3 id="practical-examples">
477 Exemplos Práticos
478</h3>
479
480<h4 id="pull-request-review-command">
481 Comando de Revisão de Pull Request
482</h4>
483
484Crie `.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 inclui skills `code-review` e `verify` agrupados. Se você nomear um comando personalizado após um deles, por exemplo `.claude/commands/code-review.md`, seu comando sobrescreve o skill agrupado e `slash_commands` lista o nome uma vez.
510</Note>
511
512<h4 id="test-runner-command">
513 Comando Test Runner
514</h4>
515
516Crie `.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
531Use esses comandos através do 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 Veja Também
588</h2>
589
590* [Slash Commands](/pt/skills) - Documentação completa de slash commands
591* [Subagentes no SDK](/pt/agent-sdk/subagents) - Configuração similar baseada em sistema de arquivos para subagentes
592* [Referência TypeScript SDK](/pt/agent-sdk/typescript) - Documentação completa da API
593* [Visão geral do SDK](/pt/agent-sdk/overview) - Conceitos gerais do SDK
594* [Referência CLI](/pt/cli-reference) - Interface de linha de comando