通俗版 Claude Code 文档

结构照原 docs,内容改成真能照着做的人话版。

查看原始文档 目录顺序与官方保持一致

SDK references

Migration Guide

Migration Guide 这一页讲的,就是 Migration Guide 这件事在 Claude Code 里到底怎么用。

页面信息

对应原页

Migrate to Claude Agent SDK

页面性质

第三方中文解释页

使用建议

先看人话解释,再对照原页命令和代码

这页不是官方原文,而是顺着官方文档结构做的中文解释版。命令、参数、配置名这些硬东西尽量保留,解释部分则尽量讲成人能照着做的话。

如果你碰到特别敏感的配置、权限或企业环境差异,最好顺手点上面的“查看原始文档”再核一遍。

这一页先讲明白

这页主要讲 Migration Guide:Guide for migrating the Claude Code TypeScript and Python SDKs to the Claude Agent SDK

你可以把它当成"SDK references"这块里专门管这一摊事的说明书。

你可以把"Migration Guide"理解成 SDK references 这一栏里的一把专门工具。这页不是让你背书,而是教你什么时候该把这把工具拿出来。

原文这页大多会按 Overview、What’s Changed、Migration Steps、For TypeScript/JavaScript Projects 这些环节往下讲。

翻成人话,大概就是:For TypeScript/JavaScript Projects

第一,先别一上来全开全配。先按最小一步试通,确认没跑偏,再继续往下加。

第二,命令、配置名、参数名这些硬东西尽量保留原样。人话解释是帮你听懂,不是帮你改关键字。

第三,照着原文这几个环节挨个过:Overview -> What’s Changed -> Migration Steps -> For TypeScript/JavaScript Projects。像下地先看水路、再试机器、再正式开干,一步一步最稳。

终端里敲

原页关键片段:For TypeScript/JavaScript Projects 1

真到动手的时候了,下面这条直接敲一遍,看它回什么。

npm uninstall @anthropic-ai/claude-code
终端里敲

原页关键片段:For TypeScript/JavaScript Projects 2

真到动手的时候了,下面这条直接敲一遍,看它回什么。

npm install @anthropic-ai/claude-agent-sdk
终端里敲

原页关键片段:For TypeScript/JavaScript Projects 3

真到动手的时候了,下面这条直接敲一遍,看它回什么。

// Before
import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-code";

// After
import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-agent-sdk";
终端里敲

原页关键片段:For Python Projects 1

这一段不是只让你理解意思,下面这条命令就是现在要跑的。

pip uninstall claude-code-sdk
终端里敲

原页关键片段:For Python Projects 2

这一段不是只让你理解意思,下面这条命令就是现在要跑的。

pip install claude-agent-sdk
关键片段

原页关键片段:For Python Projects 3

先看下面这块原始片段,等会儿再回头看解释会顺得多。

# Before
from claude_code_sdk import query, ClaudeCodeOptions

# After
from claude_agent_sdk import query, ClaudeAgentOptions
终端里敲

原页关键片段:Python: ClaudeCodeOptions renamed to ClaudeAgentOptions

看到这里,别光点头,下面这条命令先跑起来再说。

# BEFORE (claude-code-sdk)
from claude_code_sdk import query, ClaudeCodeOptions

options = ClaudeCodeOptions(model="claude-opus-4-7", permission_mode="acceptEdits")

# AFTER (claude-agent-sdk)
from claude_agent_sdk import query, ClaudeAgentOptions

options = ClaudeAgentOptions(model="claude-opus-4-7", permission_mode="acceptEdits")
直接对 Claude 说

原页关键片段:System prompt no longer default

最省事的做法,就是把下面这句原样说给 Claude。

// BEFORE (v0.0.x) - Used Claude Code's system prompt by default
const result = query({ prompt: "Hello" });

// AFTER (v0.1.0) - Uses minimal system prompt by default
// To get the old behavior, explicitly request Claude Code's preset:
const result = query({
  prompt: "Hello",
  options: {
    systemPrompt: { type: "preset", preset: "claude_code" }
  }
});

// Or use a custom system prompt:
const result = query({
  prompt: "Hello",
  options: {
    systemPrompt: "You are a helpful coding assistant"
  }
});
直接对 Claude 说

原页关键片段:Settings sources default

这里不用敲命令,直接把下面这句话发给 Claude 就行,让它按"Settings sources default"这一段的意思去办。

const result = query({
  prompt: "Hello",
  options: {
    settingSources: [] // No filesystem settings loaded
  }
});

// Or load only specific sources:
const result = query({
  prompt: "Hello",
  options: {
    settingSources: ["project"] // Only project settings
  }
});

预留广告位

正文中段响应式广告 等你后面真接 AdSense,这里再放正式广告。

Documentation Index

这里不是让你背"Documentation Index"这个词,而是让你看它真干活时怎么使。

Overview

别把这段只当成标题看,它其实是在给"Overview"划边界。

What’s Changed

这里不是让你背"What’s Changed"这个词,而是让你看它真干活时怎么使。

看这段时要特别盯工具和权限边界,别为了省事一把全开。

Migration Steps

这一块主要是在说"Migration Steps"真到手上该怎么用,哪里最容易踩坑。

For TypeScript/JavaScript Projects

这里不是让你背"For TypeScript/JavaScript Projects"这个词,而是让你看它真干活时怎么使。

终端里敲

For TypeScript/JavaScript Projects 1

真到动手的时候了,下面这条直接敲一遍,看它回什么。

npm uninstall @anthropic-ai/claude-code
终端里敲

For TypeScript/JavaScript Projects 2

真到动手的时候了,下面这条直接敲一遍,看它回什么。

npm install @anthropic-ai/claude-agent-sdk
终端里敲

For TypeScript/JavaScript Projects 3

真到动手的时候了,下面这条直接敲一遍,看它回什么。

// Before
import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-code";

// After
import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-agent-sdk";
改配置

For TypeScript/JavaScript Projects 4

光知道意思还不够,这里得把规矩落进配置里,下面这块照着填。

{
  "dependencies": {
    "@anthropic-ai/claude-code": "^0.0.42"
  }
}

For Python Projects

看到这里,就把"For Python Projects"当成一件真要上手的活来看。

如果你看到环境变量或 settings.json,意思通常都是:这不是会话里临时喊一声就行,而是要把开关真正写进环境或配置。

终端里敲

For Python Projects 1

这一段不是只让你理解意思,下面这条命令就是现在要跑的。

pip uninstall claude-code-sdk
终端里敲

For Python Projects 2

这一段不是只让你理解意思,下面这条命令就是现在要跑的。

pip install claude-agent-sdk
关键片段

For Python Projects 3

先看下面这块原始片段,等会儿再回头看解释会顺得多。

# Before
from claude_code_sdk import query, ClaudeCodeOptions

# After
from claude_agent_sdk import query, ClaudeAgentOptions
终端里敲

For Python Projects 4

这一段不是只让你理解意思,下面这条命令就是现在要跑的。

# Before
from claude_code_sdk import query, ClaudeCodeOptions

options = ClaudeCodeOptions(model="claude-opus-4-7")

# After
from claude_agent_sdk import query, ClaudeAgentOptions

options = ClaudeAgentOptions(model="claude-opus-4-7")

Breaking changes

这一段主要是在把"Breaking changes"讲实,不是只摆个标题给你看。

这里还牵扯作用域,意思就是这条规则到底管当前项目、你个人,还是只管这一趟会话。

Python: ClaudeCodeOptions renamed to ClaudeAgentOptions

这一块主要是在说"Python: ClaudeCodeOptions renamed to ClaudeAgentOptions"真到手上该怎么用,哪里最容易踩坑。

终端里敲

Python: ClaudeCodeOptions renamed to ClaudeAgentOptions

看到这里,别光点头,下面这条命令先跑起来再说。

# BEFORE (claude-code-sdk)
from claude_code_sdk import query, ClaudeCodeOptions

options = ClaudeCodeOptions(model="claude-opus-4-7", permission_mode="acceptEdits")

# AFTER (claude-agent-sdk)
from claude_agent_sdk import query, ClaudeAgentOptions

options = ClaudeAgentOptions(model="claude-opus-4-7", permission_mode="acceptEdits")

System prompt no longer default

这一段主要是在把"System prompt no longer default"讲实,不是只摆个标题给你看。

直接对 Claude 说

System prompt no longer default

最省事的做法,就是把下面这句原样说给 Claude。

// BEFORE (v0.0.x) - Used Claude Code's system prompt by default
const result = query({ prompt: "Hello" });

// AFTER (v0.1.0) - Uses minimal system prompt by default
// To get the old behavior, explicitly request Claude Code's preset:
const result = query({
  prompt: "Hello",
  options: {
    systemPrompt: { type: "preset", preset: "claude_code" }
  }
});

// Or use a custom system prompt:
const result = query({
  prompt: "Hello",
  options: {
    systemPrompt: "You are a helpful coding assistant"
  }
});

Settings sources default

这里主要是在交代"Settings sources default"这一块会碰到哪些事。

这里还牵扯作用域,意思就是这条规则到底管当前项目、你个人,还是只管这一趟会话。

直接对 Claude 说

Settings sources default

这里不用敲命令,直接把下面这句话发给 Claude 就行,让它按"Settings sources default"这一段的意思去办。

const result = query({
  prompt: "Hello",
  options: {
    settingSources: [] // No filesystem settings loaded
  }
});

// Or load only specific sources:
const result = query({
  prompt: "Hello",
  options: {
    settingSources: ["project"] // Only project settings
  }
});

Why the Rename?

这段看着像个标题,其实是在说"Why the Rename?"管到哪儿。

看这段时要特别盯工具和权限边界,别为了省事一把全开。

Getting Help

这一段更像在讲判断条件,什么时候该上,什么时候先别急。把触发条件看清,比背标题更重要。

这里还牵扯作用域,意思就是这条规则到底管当前项目、你个人,还是只管这一趟会话。

Next Steps

这里不是让你背"Next Steps"这个词,而是让你看它真干活时怎么使。

看这段时要特别盯工具和权限边界,别为了省事一把全开。

照着做一遍

如果你不想来回翻,就先照这几步顺着做。

每做完一步就看一下结果,再决定要不要继续往下。

终端里敲

第 1 步:For TypeScript/JavaScript Projects 1

真到动手的时候了,下面这条直接敲一遍,看它回什么。

npm uninstall @anthropic-ai/claude-code
终端里敲

第 2 步:For TypeScript/JavaScript Projects 2

真到动手的时候了,下面这条直接敲一遍,看它回什么。

npm install @anthropic-ai/claude-agent-sdk
终端里敲

第 3 步:For TypeScript/JavaScript Projects 3

真到动手的时候了,下面这条直接敲一遍,看它回什么。

// Before
import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-code";

// After
import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-agent-sdk";
终端里敲

第 4 步:For Python Projects 1

这一段不是只让你理解意思,下面这条命令就是现在要跑的。

pip uninstall claude-code-sdk

一眼看懂这一页

先把这页到底在讲什么看明白,再去碰具体命令和配置,最不容易绕晕。

Migration Guide
   |
   v
这是 SDK references 里的一摊要紧活
   |
   v
先弄懂,再下手

文末提醒

这站会按官方 docs 的导航和内容变化继续重生成,原站加页、删页、改页时,这里会跟着更新。

人话解释会尽量顺着原页往下讲,但命令、参数名、配置名这些硬东西还是保留原样,免得你抄过去跑不起来。