指南

SDK 中的斜杠命令

了解如何通过 SDK 使用斜杠命令来控制 Claude Code 会话

斜杠命令提供了一种使用以 / 开头的特殊命令来控制 Claude Code 会话的方式。这些命令可以通过 SDK 发送，用于执行清除对话历史、压缩消息或获取帮助等操作。

发现可用的斜杠命令

Claude Agent SDK 在系统初始化消息中提供有关可用斜杠命令的信息。在会话启动时访问此信息：

import { query } from "@anthropic-ai/claude-agent-sdk";

for await (const message of query({
  prompt: "Hello Claude",
  options: { maxTurns: 1 }
})) {
  if (message.type === "system" && message.subtype === "init") {
    console.log("Available slash commands:", message.slash_commands);
    // 示例输出: ["/compact", "/clear", "/help"]
  }
}

发送斜杠命令

通过将斜杠命令包含在提示字符串中来发送它们，就像普通文本一样：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 发送斜杠命令
for await (const message of query({
  prompt: "/compact",
  options: { maxTurns: 1 }
})) {
  if (message.type === "result") {
    console.log("Command executed:", message.result);
  }
}

常用斜杠命令

`/compact` - 压缩对话历史

/compact 命令通过总结较早的消息来减少对话历史的大小，同时保留重要的上下文：

import { query } from "@anthropic-ai/claude-agent-sdk";

for await (const message of query({
  prompt: "/compact",
  options: { maxTurns: 1 }
})) {
  if (message.type === "system" && message.subtype === "compact_boundary") {
    console.log("Compaction completed");
    console.log("Pre-compaction tokens:", message.compact_metadata.pre_tokens);
    console.log("Trigger:", message.compact_metadata.trigger);
  }
}

`/clear` - 清除对话

/clear 命令通过清除所有先前的历史记录来开始一个全新的对话：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 清除对话并重新开始
for await (const message of query({
  prompt: "/clear",
  options: { maxTurns: 1 }
})) {
  if (message.type === "system" && message.subtype === "init") {
    console.log("Conversation cleared, new session started");
    console.log("Session ID:", message.session_id);
  }
}

创建自定义斜杠命令

除了使用内置斜杠命令外，您还可以创建自己的自定义命令，这些命令可通过 SDK 使用。自定义命令定义为特定目录中的 markdown 文件，类似于子代理的配置方式。

文件位置

自定义斜杠命令根据其作用范围存储在指定目录中：

项目命令：.claude/commands/ - 仅在当前项目中可用
个人命令：~/.claude/commands/ - 在您的所有项目中可用

文件格式

每个自定义命令是一个 markdown 文件，其中：

文件名（不含 .md 扩展名）成为命令名称
文件内容定义命令的功能
可选的 YAML frontmatter 提供配置

基本示例

创建 .claude/commands/refactor.md：

Refactor the selected code to improve readability and maintainability.
Focus on clean code principles and best practices.

这将创建 /refactor 命令，您可以通过 SDK 使用它。

带 Frontmatter

创建 .claude/commands/security-check.md：

---
allowed-tools: Read, Grep, Glob
description: Run security vulnerability scan
model: claude-opus-4-6
---

Analyze the codebase for security vulnerabilities including:
- SQL injection risks
- XSS vulnerabilities
- Exposed credentials
- Insecure configurations

在 SDK 中使用自定义命令

一旦在文件系统中定义，自定义命令将自动通过 SDK 可用：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 使用自定义命令
for await (const message of query({
  prompt: "/refactor src/auth/login.ts",
  options: { maxTurns: 3 }
})) {
  if (message.type === "assistant") {
    console.log("Refactoring suggestions:", message.message);
  }
}

// 自定义命令会出现在 slash_commands 列表中
for await (const message of query({
  prompt: "Hello",
  options: { maxTurns: 1 }
})) {
  if (message.type === "system" && message.subtype === "init") {
    // 将包含内置命令和自定义命令
    console.log("Available commands:", message.slash_commands);
    // 示例: ["/compact", "/clear", "/help", "/refactor", "/security-check"]
  }
}

高级功能

参数和占位符

自定义命令支持使用占位符的动态参数：

创建 .claude/commands/fix-issue.md：

---
argument-hint: [issue-number] [priority]
description: Fix a GitHub issue
---

Fix issue #$1 with priority $2.
Check the issue description and implement the necessary changes.

在 SDK 中使用：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 向自定义命令传递参数
for await (const message of query({
  prompt: "/fix-issue 123 high",
  options: { maxTurns: 5 }
})) {
  // 命令将以 $1="123" 和 $2="high" 进行处理
  if (message.type === "result") {
    console.log("Issue fixed:", message.result);
  }
}

Bash 命令执行

自定义命令可以执行 bash 命令并包含其输出：

创建 .claude/commands/git-commit.md：

---
allowed-tools: Bash(git add:*), Bash(git status:*), Bash(git commit:*)
description: Create a git commit
---

## Context

- Current status: !`git status`
- Current diff: !`git diff HEAD`

## Task

Create a git commit with appropriate message based on the changes.

文件引用

使用 @ 前缀包含文件内容：

创建 .claude/commands/review-config.md：

---
description: Review configuration files
---

Review the following configuration files for issues:
- Package config: @package.json
- TypeScript config: @tsconfig.json
- Environment config: @.env

Check for security issues, outdated dependencies, and misconfigurations.

使用命名空间进行组织

在子目录中组织命令以获得更好的结构：

.claude/commands/
├── frontend/
│   ├── component.md      # 创建 /component (project:frontend)
│   └── style-check.md     # 创建 /style-check (project:frontend)
├── backend/
│   ├── api-test.md        # 创建 /api-test (project:backend)
│   └── db-migrate.md      # 创建 /db-migrate (project:backend)
└── review.md              # 创建 /review (project)

子目录会出现在命令描述中，但不会影响命令名称本身。

实用示例

代码审查命令

创建 .claude/commands/code-review.md：

---
allowed-tools: Read, Grep, Glob, Bash(git diff:*)
description: Comprehensive code review
---

## Changed Files
!`git diff --name-only HEAD~1`

## Detailed Changes
!`git diff HEAD~1`

## Review Checklist

Review the above changes for:
1. Code quality and readability
2. Security vulnerabilities
3. Performance implications
4. Test coverage
5. Documentation completeness

Provide specific, actionable feedback organized by priority.

测试运行命令

创建 .claude/commands/test.md：

---
allowed-tools: Bash, Read, Edit
argument-hint: [test-pattern]
description: Run tests with optional pattern
---

Run tests matching pattern: $ARGUMENTS

1. Detect the test framework (Jest, pytest, etc.)
2. Run tests with the provided pattern
3. If tests fail, analyze and fix them
4. Re-run to verify fixes

通过 SDK 使用这些命令：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 运行代码审查
for await (const message of query({
  prompt: "/code-review",
  options: { maxTurns: 3 }
})) {
  // 处理审查反馈
}

// 运行特定测试
for await (const message of query({
  prompt: "/test auth",
  options: { maxTurns: 5 }
})) {
  // 处理测试结果
}

另请参阅

斜杠命令 - 完整的斜杠命令文档
SDK 中的子代理 - 类似的基于文件系统的子代理配置
TypeScript SDK 参考 - 完整的 API 文档
SDK 概述 - 通用 SDK 概念
CLI 参考 - 命令行界面

Was this page helpful?

指南

SDK 中的斜杠命令

了解如何通过 SDK 使用斜杠命令来控制 Claude Code 会话

发现可用的斜杠命令

Claude Agent SDK 在系统初始化消息中提供有关可用斜杠命令的信息。在会话启动时访问此信息：

import { query } from "@anthropic-ai/claude-agent-sdk";

for await (const message of query({
  prompt: "Hello Claude",
  options: { maxTurns: 1 }
})) {
  if (message.type === "system" && message.subtype === "init") {
    console.log("Available slash commands:", message.slash_commands);
    // 示例输出: ["/compact", "/clear", "/help"]
  }
}

发送斜杠命令

通过将斜杠命令包含在提示字符串中来发送它们，就像普通文本一样：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 发送斜杠命令
for await (const message of query({
  prompt: "/compact",
  options: { maxTurns: 1 }
})) {
  if (message.type === "result") {
    console.log("Command executed:", message.result);
  }
}

常用斜杠命令

`/compact` - 压缩对话历史

/compact 命令通过总结较早的消息来减少对话历史的大小，同时保留重要的上下文：

import { query } from "@anthropic-ai/claude-agent-sdk";

for await (const message of query({
  prompt: "/compact",
  options: { maxTurns: 1 }
})) {
  if (message.type === "system" && message.subtype === "compact_boundary") {
    console.log("Compaction completed");
    console.log("Pre-compaction tokens:", message.compact_metadata.pre_tokens);
    console.log("Trigger:", message.compact_metadata.trigger);
  }
}

`/clear` - 清除对话

/clear 命令通过清除所有先前的历史记录来开始一个全新的对话：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 清除对话并重新开始
for await (const message of query({
  prompt: "/clear",
  options: { maxTurns: 1 }
})) {
  if (message.type === "system" && message.subtype === "init") {
    console.log("Conversation cleared, new session started");
    console.log("Session ID:", message.session_id);
  }
}

创建自定义斜杠命令

文件位置

自定义斜杠命令根据其作用范围存储在指定目录中：

项目命令：.claude/commands/ - 仅在当前项目中可用
个人命令：~/.claude/commands/ - 在您的所有项目中可用

文件格式

每个自定义命令是一个 markdown 文件，其中：

文件名（不含 .md 扩展名）成为命令名称
文件内容定义命令的功能
可选的 YAML frontmatter 提供配置

基本示例

创建 .claude/commands/refactor.md：

Refactor the selected code to improve readability and maintainability.
Focus on clean code principles and best practices.

这将创建 /refactor 命令，您可以通过 SDK 使用它。

带 Frontmatter

创建 .claude/commands/security-check.md：

---
allowed-tools: Read, Grep, Glob
description: Run security vulnerability scan
model: claude-opus-4-6
---

Analyze the codebase for security vulnerabilities including:
- SQL injection risks
- XSS vulnerabilities
- Exposed credentials
- Insecure configurations

在 SDK 中使用自定义命令

一旦在文件系统中定义，自定义命令将自动通过 SDK 可用：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 使用自定义命令
for await (const message of query({
  prompt: "/refactor src/auth/login.ts",
  options: { maxTurns: 3 }
})) {
  if (message.type === "assistant") {
    console.log("Refactoring suggestions:", message.message);
  }
}

// 自定义命令会出现在 slash_commands 列表中
for await (const message of query({
  prompt: "Hello",
  options: { maxTurns: 1 }
})) {
  if (message.type === "system" && message.subtype === "init") {
    // 将包含内置命令和自定义命令
    console.log("Available commands:", message.slash_commands);
    // 示例: ["/compact", "/clear", "/help", "/refactor", "/security-check"]
  }
}

高级功能

参数和占位符

自定义命令支持使用占位符的动态参数：

创建 .claude/commands/fix-issue.md：

---
argument-hint: [issue-number] [priority]
description: Fix a GitHub issue
---

Fix issue #$1 with priority $2.
Check the issue description and implement the necessary changes.

在 SDK 中使用：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 向自定义命令传递参数
for await (const message of query({
  prompt: "/fix-issue 123 high",
  options: { maxTurns: 5 }
})) {
  // 命令将以 $1="123" 和 $2="high" 进行处理
  if (message.type === "result") {
    console.log("Issue fixed:", message.result);
  }
}

Bash 命令执行

自定义命令可以执行 bash 命令并包含其输出：

创建 .claude/commands/git-commit.md：

---
allowed-tools: Bash(git add:*), Bash(git status:*), Bash(git commit:*)
description: Create a git commit
---

## Context

- Current status: !`git status`
- Current diff: !`git diff HEAD`

## Task

Create a git commit with appropriate message based on the changes.

文件引用

使用 @ 前缀包含文件内容：

创建 .claude/commands/review-config.md：

---
description: Review configuration files
---

Review the following configuration files for issues:
- Package config: @package.json
- TypeScript config: @tsconfig.json
- Environment config: @.env

Check for security issues, outdated dependencies, and misconfigurations.

使用命名空间进行组织

在子目录中组织命令以获得更好的结构：

.claude/commands/
├── frontend/
│   ├── component.md      # 创建 /component (project:frontend)
│   └── style-check.md     # 创建 /style-check (project:frontend)
├── backend/
│   ├── api-test.md        # 创建 /api-test (project:backend)
│   └── db-migrate.md      # 创建 /db-migrate (project:backend)
└── review.md              # 创建 /review (project)

子目录会出现在命令描述中，但不会影响命令名称本身。

实用示例

代码审查命令

创建 .claude/commands/code-review.md：

---
allowed-tools: Read, Grep, Glob, Bash(git diff:*)
description: Comprehensive code review
---

## Changed Files
!`git diff --name-only HEAD~1`

## Detailed Changes
!`git diff HEAD~1`

## Review Checklist

Review the above changes for:
1. Code quality and readability
2. Security vulnerabilities
3. Performance implications
4. Test coverage
5. Documentation completeness

Provide specific, actionable feedback organized by priority.

测试运行命令

创建 .claude/commands/test.md：

---
allowed-tools: Bash, Read, Edit
argument-hint: [test-pattern]
description: Run tests with optional pattern
---

Run tests matching pattern: $ARGUMENTS

1. Detect the test framework (Jest, pytest, etc.)
2. Run tests with the provided pattern
3. If tests fail, analyze and fix them
4. Re-run to verify fixes

通过 SDK 使用这些命令：

import { query } from "@anthropic-ai/claude-agent-sdk";

// 运行代码审查
for await (const message of query({
  prompt: "/code-review",
  options: { maxTurns: 3 }
})) {
  // 处理审查反馈
}

// 运行特定测试
for await (const message of query({
  prompt: "/test auth",
  options: { maxTurns: 5 }
})) {
  // 处理测试结果
}

另请参阅

斜杠命令 - 完整的斜杠命令文档
SDK 中的子代理 - 类似的基于文件系统的子代理配置
TypeScript SDK 参考 - 完整的 API 文档
SDK 概述 - 通用 SDK 概念
CLI 参考 - 命令行界面

Was this page helpful?

发现可用的斜杠命令

发送斜杠命令

常用斜杠命令

/compact - 压缩对话历史

/clear - 清除对话

创建自定义斜杠命令

文件位置

文件格式

基本示例

带 Frontmatter

在 SDK 中使用自定义命令

高级功能

参数和占位符

Bash 命令执行

文件引用

使用命名空间进行组织

实用示例

代码审查命令

测试运行命令

另请参阅

发现可用的斜杠命令

发送斜杠命令

常用斜杠命令

/compact - 压缩对话历史

/clear - 清除对话

创建自定义斜杠命令

文件位置

文件格式

基本示例

带 Frontmatter

在 SDK 中使用自定义命令

高级功能

参数和占位符

Bash 命令执行

文件引用

使用命名空间进行组织

实用示例

代码审查命令

测试运行命令

另请参阅

`/compact` - 压缩对话历史

`/clear` - 清除对话

`/compact` - 压缩对话历史

`/clear` - 清除对话