Claude 代理 SDK

Claude 代理 SDK 使您能够以编程方式利用 Claude Code 的能力构建 AI 代理。您可以创建能够理解代码库、编辑文件、运行命令并执行复杂工作流的自主代理。

更多信息请参阅官方文档。

开始使用

安装 Claude 代理 SDK：

npm install @anthropic-ai/claude-agent-sdk

从 Claude Code SDK 迁移

Claude Code SDK 现已更名为 Claude 代理 SDK。有关重大变更的详细信息，请参阅迁移指南。

报告错误

我们欢迎您提出反馈。请通过提交 GitHub 问题 来报告错误或请求新功能。

加入 Discord 社区

加入 Claude 开发者 Discord，与其他使用 Claude 代理 SDK 进行开发的开发者交流。在这里您可以获得帮助、分享反馈，并与社区成员讨论您的项目。

数据收集、使用和保留

当您使用 Claude 代理 SDK 时，我们会收集反馈信息，其中包括使用数据（例如代码接受或拒绝）、相关对话数据以及通过 /bug 命令提交的用户反馈。

我们如何使用您的数据

请参阅我们的数据使用政策。

隐私保护措施

我们已实施多项保护措施来 safeguard您的数据，包括对敏感信息设定有限的保留期限、限制对用户会话数据的访问，以及明确禁止将反馈用于模型训练。

有关完整详情，请查阅我们的商业服务条款和隐私政策。

许可证与条款

本 SDK 的使用受 Anthropic 的商业服务条款约束，包括在您将其用于支持向您自己的客户和最终用户提供产品和服务时，除非特定组件或依赖项受其 LICENSE 文件中注明的其他许可证所覆盖。

Claude Agent SDK (TypeScript) 快速上手指南

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• Node.js: 版本 18 或更高 (Node.js 18+)
• 包管理器: npm、yarn 或 pnpm
• API 密钥: 您需要拥有 Anthropic API 密钥才能使用此 SDK

安装步骤

使用 npm 安装 Claude Agent SDK：

npm install @anthropic-ai/claude-agent-sdk

提示：如果您在国内遇到下载速度慢的问题，可以配置淘宝镜像源加速安装：

npm config set registry https://registry.npmmirror.com
npm install @anthropic-ai/claude-agent-sdk

基本使用

安装完成后，您可以创建一个简单的 AI Agent 来执行代码库理解、文件编辑或命令运行等任务。以下是一个最基础的使用示例：

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

async function main() {
  // 初始化 Agent
  const agent = new Agent({
    apiKey: process.env.ANTHROPIC_API_KEY,
  });

  // 定义任务：例如让 Agent 分析当前目录的代码结构
  const result = await agent.run("Analyze the codebase structure in the current directory");

  console.log(result.output);
}

main().catch(console.error);

使用说明：

1. 确保已设置环境变量 ANTHROPIC_API_KEY。
2. 上述示例展示了如何初始化 SDK 并运行一个简单的自然语言指令。
3. 该 SDK 支持更复杂的自主工作流，包括多步命令执行和文件操作，详细用法请参考官方文档。