官方资料核对 · 本地示例说明 · 2026-10-20
Claude Code 使用指南
从安装、模型、命令到配置、认证、权限、扩展和工程实践,按当前官方资料更新,并区分在线功能与本机版本。
01 / 19
理解 Claude Code 的工作方式
Claude Code 是具备项目读写和工具执行能力的编码代理。
- 先确认位置:代码和工具在哪里运行,再核对账号、模型与权限。
- 入口差异:终端、IDE、桌面、网页和远程入口,不共享所有本机环境变量、认证后端和运行能力。
| 部分 | 负责什么 | 不要误解 |
|---|---|---|
| 模型 | 理解任务、推理和生成工具调用 | 不能单靠换模型突破文件权限。 |
| 上下文 | 对话、项目说明、工具结果与载入文件 | 更多内容不总是更好,过期规则可能干扰任务。 |
| 工具与扩展 | 文件、命令、MCP、Skills、Hooks 等 | 已安装扩展不代表已授权写入外部系统。 |
| 执行环境 | 本机、WSL、云端或组织托管环境 | 同一账号不代表环境依赖与设置完全相同。 |
当前模型入口
- 可用别名:本次官方文档包含
best、fable、sonnet、opus、haiku等;指向随提供商、账号和时间变化。 default:清除覆盖,回到账号的运行时默认值。- 需要复现:固定有权限的完整模型 ID,不沿用旧 Opus / Sonnet 版本号作为全局默认建议。
02 / 19
五条日常工作原则
- 描述结果与验收,给足项目背景和约束;复杂缺陷提供原始日志与复现,不要求模型盲猜。
- 存在设计分歧时先计划,明确的小修改直接实施;不要让计划流程替代交付。
- 围绕当前任务选择必要上下文;AGENTS.md 与 CLAUDE.md 的加载方式不同,不假设完全互通。
- 依据当前文件运行适用验证;问题根因、可能风险和未测试路径分别说明。
- 授权与范围明确后持续完成,遇到阻塞报告证据与解除条件;不要自动扩展到推送、发布或发消息。
依据:官方实践
03 / 19
近期变化与版本边界
核对与边界官方发行说明本次检索顶部为 2.1.304,2026-10-19;本机为 2.1.283,未执行升级。发布记录、当前在线文档和本地已安装能力不应混为一谈。
| 变化 | 适用边界与动作 |
|---|---|
| 2.1.304 自动模式设置 | 新增 /auto-mode-setup 引导,并扩展到更多提供商环境;本机旧版本是否已提供不能只凭文档推断。 |
| 2.1.304 自定义端点的工具搜索 | 自定义 ANTHROPIC_BASE_URL 后的工具搜索默认行为变化;网关 400/422 会无工具搜索重试,仍需核对网关兼容。 |
| ≥2.1.285 allowedProviders | 管理员可约束允许的 API 提供商;需要和组织登录策略区分,本机 2.1.283 不能宣称已支持。 |
| ≥2.1.257 权限模式来源限制 | auto / bypassPermissions 不从项目和 local settings 生效;改用用户/托管设置或受支持 CLI 选项。 |
| 设置文档拆分 | settings 讲文件与优先级;全部字段移至 settings-reference,包含作用域、默认与例子。 |
| Console 与多种认证 | 当前支持 Console 无 Key 登录、组织网关与其他认证路径;并非只有订阅与静态 API Key 两种。 |
04 / 19
安装、更新与首次验证
- 安装渠道:原生安装、Homebrew 等渠道各有更新机制。先检查路径与版本,排除多个安装相互遮蔽。
- Windows:原生 Windows 可用 PowerShell;需要 Linux 沙箱能力时再查 WSL 方案,不要求所有用户都使用 WSL。
# macOS / Linux / WSL 的官方原生安装入口示例
curl -fsSL https://claude.ai/install.sh | bash
# 或按官方 Homebrew 渠道(与上面二选一)
# brew install --cask claude-code
claude --version
claude --help
claude
# 会话内 /status 检查账号、模型和设置来源
- Homebrew:使用对应 cask 的
brew upgrade;不由 Claude 原生自动更新机制更新。 - 版本渠道:
stable与latest不同,先确认自己的安装来源。 - 首次任务:先确认仓库和验证入口,再做小范围修改。本页展示命令,不代替读者执行安装或登录。
05 / 19
命令速查
开始与继续会话
| 命令 | 用途 | 注意 |
|---|---|---|
| claude | 终端交互 | 首次可能进入登录与项目信任流程。 |
| claude -c / claude -r | 继续最近 / 恢复指定会话 | 共享目录、设置和服务可能已变化。 |
脚本与结构化输出
| 命令 | 用途 | 注意 |
|---|---|---|
| claude -p "任务" | 非交互输出 | 按权限设置执行;不是天然只读模式。 |
| claude -p --output-format json "任务" | JSON 输出 | 与 stream-json 事件流区分,自动化还需处理退出状态。 |
| claude -p --json-schema <schema> "任务" | 结构化结果 | 当前支持形式以 --help 为准;结构合法不代表业务正确。 |
模型、权限与工作树
| 命令 | 用途 | 注意 |
|---|---|---|
| claude --model <id-or-alias> | 单次模型选择 | 受组织可用/禁用模型控制。 |
| claude --permission-mode <mode> | 单次权限模式 | 仅可选择当前版本与组织允许的模式。 |
| claude --worktree [name] | 独立 Git 工作树会话 | 不是完整备份,不自动赋予提交/推送授权。 |
认证、扩展与诊断
| 命令 | 用途 | 注意 |
|---|---|---|
| claude auth status | 认证状态 | 认证路径有别,不打印 token 进行比对。 |
| claude mcp / claude plugin | 管理 MCP / 插件 | 安装、信任与外部账号连接分别核对。 |
| claude doctor | 只读终端诊断 | 与会话内可能修复配置的 /doctor 区分。 |
| claude import codex --dry-run | 预览跨工具配置导入 | 转换并非 100% 语义一致;审核后再决定是否实施。 |
会话内高频命令
查询状态与调整配置
| 命令 | 用途 |
|---|---|
| /help | 当前可用命令与说明。 |
| /status | 账号、模型、Setting sources;不会显示每个键具体获胜来源。 |
| /model / /effort | 模型与思考档;部分选择可能保存为后续默认,注意界面提示。 |
| /config / /permissions | 个人配置菜单 / 权限来源与规则。 |
计划、上下文与工具
| 命令 | 用途 |
|---|---|
| /plan | 需要先审设计时进入计划。 |
| /compact / /clear | 总结上下文 / 清理当前对话状态;不退款。 |
| /context / /usage | 观察上下文与用量,区分总预算。 |
| /mcp / /agents | 检查 MCP / 代理配置;环境不同可能有额外入口。 |
06 / 19
输入与快捷键
| 操作 | 常用入口 | 核对点 |
|---|---|---|
| 停止当前生成 | Esc | 停止本回合与删除会话/文件不同。 |
| 切换权限/计划模式 | Shift+Tab 或对应界面入口 | 可循环的模式取决于设置、账号与版本。 |
| 展开过程输出 | Ctrl+O | 可能展示工具结果和内部路径,分享前检查。 |
| 多行输入 | 终端支持的 Shift+Enter 或输入设置 | 不同终端、IDE 的按键可能被宿主拦截。 |
| 引用文件/路径 | @ 路径或界面选择 | 引用帮助定位,不保证文件一直最新或全部加载。 |
自定义按键、Vim 模式和终端冲突查当前官方交互文档。不能把某个桌面或 IDE 的键位写成所有入口通用。
依据:交互模式与快捷键
07 / 19
按需要选择扩展
| 需要 | 选择 | 边界 |
|---|---|---|
| 稳定项目约束 | CLAUDE.md / .claude/rules | 是上下文说明,不是执行隔离。 |
| 可复用流程与资源 | Skills | 校验目录、frontmatter 和触发;技能中的命令要在目标环境可用。 |
| 外部系统数据与工具 | MCP | 确认服务、认证、权限与错误处理。 |
| 独立上下文调查 | Subagents | 任务边界清楚、主代理最终核对;多代理不是成本捷径。 |
| 事件触发自动化 | Hooks | 实际会运行代码,按来源、权限与失败语义检查。 |
| 组合分发 | Plugins | 目录、安装、启用与登录是不同步骤。 |
08 / 19
技能、Hooks、MCP 与子代理
Skills
- 项目技能:
.claude/skills/<name>/SKILL.md。 - 个人与插件技能:个人目录为
~/.claude/skills/,插件也可提供技能。 - 编写与移植:写清触发条件和输入/输出,长资源按需读取;跨代理移植时核对工具、权限和路径。
Hooks
- 触发方式:在对应设置层的
hooks中配置,由事件触发。 - 先查语义:匹配器、同步/异步、超时、JSON 输出及非零退出的含义;不是每种 Hook 都能阻止动作。
- 避免重复负担:不要每次编辑都跑全量检查,也要防止停止后重复触发。
MCP
- 作用域:用户、本地项目和共享
.mcp.json分别管理。 - 连接方式:HTTP 与 stdio 的认证不同;模型 API Key 和 MCP OAuth 也不是同一认证。
- 检查与登录:先用
claude mcp list检查服务;支持的服务再用claude mcp login <name>登录。
Subagents
- 角色配置:按当前代理文档定义角色说明、工具、模型和权限。
- 交接证据:委派明确的调查、实现或审阅任务,不能只接收一句“完成”。
- 版本边界:嵌套、后台执行及额度上限按当前版本核实,不沿用旧教程的固定数字。
09 / 19
订阅、账单与上下文
| 查看对象 | 应该看什么 | 常见误区 |
|---|---|---|
| 订阅用量 | /usage 与账号实际窗口、模型和套餐 | 不能按固定消息条数估算所有任务。 |
| API / Console / 云提供商费用 | 相应组织或云平台的使用量与计费 | 不是登录了 Pro 就免 API 账单。 |
| 上下文 | /context、工具结果与压缩状态 | /compact 和 /clear 不重置已使用额度。 |
| 缓存/并行/后台任务 | 实际模型、请求和缓存规则 | 后台运行或子代理不等于更便宜。 |
- 先减少浪费:控制无关文件和重复结果,明确范围,选合适模型并完成验收。
- 预算参数:
--max-budget-usd、最大轮数等,按本机帮助与 costs 文档确认适用模式。 - 边界:不能将这些参数当成所有入口统一的绝对账单上限。
10 / 19
图片、Artifacts 与电脑操作
- 入口差异:网页/桌面的 Artifacts、浏览器或电脑操作,与终端 Claude Code 的内置编码能力不同。
- 操作前:确认工具是否可用、执行的账号和机器,以及获准的操作范围。
- 产物格式:图片输入用于理解,不自动等于可编辑的 Figma / SVG。
- 分别验收:检查产物格式、交互行为和截图;截图通过不能代替功能测试。
浏览器任务参见 电脑与浏览器操作专题。
11 / 19
八类任务怎么交付
理解问题与实施改动
| 场景 | 目标与证据 |
|---|---|
| 理解陌生仓库 | 入口、模块关系、构建/测试命令及依据文件。 |
| 定位线上错误 | 原始日志、版本/映射、活动源码;根因与推测分开。 |
| 修复缺陷 | 保留复现或可追溯证据,再做最小改动及对应验证。 |
| 新增功能 | 用户行为、范围、不变量、失败场景和验收。 |
审阅、文档与自动化
| 场景 | 目标与证据 |
|---|---|
| 重构 | 保持行为的约束、已有测试与 diff 影响。 |
| 审查 PR | 基线、变更范围、具体触发条件与可行动结论。 |
| 编写文档/配置 | 版本、官方来源、语法/链接与运行验证边界。 |
| 自动化/CI | 明确权限、退出状态、输出结构和失败处理,不暴露密钥。 |
先把任务做成可审查结果,再执行已授权的交付。分析请求不等于修改授权,实施请求也不自动包含推送、发布或对外发消息。
12 / 19
上下文、规则与记忆
- 团队规则:项目级
CLAUDE.md保存稳定的构建、验证和行为约束;.claude/rules/用于分拆规则。 - 个人偏好:与团队规则分开管理。
- 加载范围:
CLAUDE.local.md、导入语法和子目录加载按官方 Memory 文档核对;不需要一开始把所有文件全部塞进上下文。
| 载体 | 用途 | 边界 |
|---|---|---|
| CLAUDE.md / rules | 显式项目约束 | 需要与当前代码保持一致,不是隐藏权限控制。 |
| Auto memory | 从交互中保存可复用经验 | 记录可能过时,跨环境路径和推断仍须核实。 |
| 会话压缩 | 把历史整理成可继续工作的摘要 | 保留目标、约束、证据和未完成项,不能保证无损。 |
| 新会话/恢复 | 隔离新目标或继续旧任务 | 新会话不重置账单;恢复旧会话也可能消耗明显的上下文。 |
13 / 19
权限规则、模式与沙箱
工具权限与 OS 沙箱分开看。
- 选择模式:Manual、自动审批、接受编辑、Plan、绕过权限等支持情况,查本机
--permission-mode和官方文档。 - Auto mode:使用判断器减少提示,并非无条件批准。
| 配置 | 作用 | 重要限制 |
|---|---|---|
| permissions.allow / ask / deny | 对具体工具及输入建立规则 | 匹配拒绝规则优先于允许;应给准确范围。 |
| permissions.defaultMode | 默认交互权限模式 | auto / bypassPermissions 当前不从项目和 local 文件启用。 |
| permissions.additionalDirectories | 额外工作目录 | 不表示所有命令或外部系统都可任意写入。 |
| sandbox.* | 支持平台的命令隔离与网络规则 | 本地权限规则不等价于阻止所有 Bash 或外部工具读取秘密。 |
| 托管设置 | 组织要求 | 用户文件与 --settings 不能绕过组织约束。 |
权限规则有自己的路径语法
//path:文件系统绝对路径。~/path:相对用户家目录。/path:相对设置来源。./path:相对当前目录。- 规则差异:allow 与 deny 的路径扩展还有差异,按目标规则类型查文档。
{
"permissions": {
"allow": ["Bash(npm run lint)", "Bash(npm run test *)"],
"deny": ["Read(./.env)", "Read(./.env.*)"]
}
}
此例限制匹配的文件工具调用;不能单独保证这些内容无法经命令、MCP 或其他渠道读到。需要隔离时落实对应平台沙箱与服务权限,而非只给模型一句“不要读”。
14 / 19
设置文件与登录方式
配置层:与 Codex 的 TOML 不同
| 位置 | 作用域 |
|---|---|
| ~/.claude/settings.json | 个人在本机项目中的默认设置。 |
| .claude/settings.json | 随项目共享的团队配置。 |
| .claude/settings.local.json | 本人的项目覆盖;若手动创建需确认已忽略,不进入 Git。 |
| managed-settings / MDM / 服务器托管设置 | 组织策略;按其实际部署来源和规则强制执行。 |
| ~/.claude.json | 客户端维护的登录/状态/MCP 与全局配置;不要当 settings.json 的等价替代品。 |
| .mcp.json / .claude/agents / .claude/skills | 共享 MCP / 代理 / 技能,各自按作用域加载。 |
普通设置优先级:从上到下逐级降低。
- 托管设置
- CLI
--settings - 项目 local 设置
- 共享项目设置
- 用户设置
- 环境变量:覆盖关系按字段决定,不作为统一的一层。例如 shell 的
ANTHROPIC_MODEL与默认模型变量不同。 - 数组例外:通常合并,但
fallbackModel、modelPicker、availableModels、modelSettings有专门规则。
- 格式:严格 JSON:不写注释,不留尾随逗号。
- 查看来源:
/config只展示部分选项;/status的 Setting sources 展示加载来源,不是每个键的最终获胜来源。 - 生效方式:多数文件设置可热重载;
model、effort等用对应命令切换,并非改文件后全部立即生效。
关键配置分组
| 类别 | 字段/入口 | 联动 |
|---|---|---|
| 模型 | model、effortLevel、modelSettings、availableModels / deniedModels | 模型、思考档、组织约束分别控制;别名会变化。 |
| 认证 | apiKeyHelper、env;forceLoginMethod / forceLoginOrgUUID | 凭据、环境和组织策略各有范围;强制账号组织不等于云提供商组织校验。 |
| 权限 | permissions.*、sandbox.* | 规则与隔离分开;高权限模式有来源限制。 |
| 扩展 | hooks、enabledPlugins、MCP 配置 | 安装/启用/信任/连接分开核对。 |
| 显示与历史 | outputStyle、清理/遥测等相应键 | 以 settings-reference 的作用域、默认、示例为准,不抄旧字段全集。 |
登录不止两种:先确定收费与凭据归属
| 认证方式 | 配置/入口 | 边界 |
|---|---|---|
| claude.ai 订阅或团队账号 | 首次启动或 /login | 跟随对应账号计划与组织权限。 |
| Claude Console | 可选无 API Key 登录或 legacy 创建 Key | Console 组织与计费独立;某些条件下不提供无 Key 方式。 |
| API Key / Auth Token / apiKeyHelper | 环境变量或 helper,按优先级与管理员要求 | 终端/包装 CLI 的入口适用,不应假设桌面和云端也读取这些变量/helper。 |
| Bedrock / Google Agent Platform(Vertex)/ Foundry | 云平台凭据和开关 | 使用各自云权限与计费。 |
| 企业 Claude apps gateway | 企业 SSO 与网关配置 | 不是仅改 ANTHROPIC_BASE_URL 就自动成为官方 SSO 网关。 |
| Profile / 工作负载身份 | 组织提供的 profile 或 federation | 支持面与凭据顺序查认证文档,不手改凭据 JSON 来伪造登录。 |
- macOS:通常用 Keychain;写入失败时,部分登录可回退到受限权限凭据文件。Console 创建 Key 的场景还有额外限制。
- Linux / Windows:各有对应凭据存储路径。
- 分享前检查:不要把认证文件、
setup-token输出或真实密钥贴进配置示例。
15 / 19
与 Codex 等工具协作
- 协作分工:一个实施,一个基于同一基线独立审阅,以源码和验证结果决定结论。
- 移植范围:Skills 目录有可复用部分;Hook 事件、权限字段、项目说明和提供商协议需分别检查。
- 先用
claude import codex --dry-run预览当前工具支持的转换。 - 检查来源和目标文件,再决定是否实施;本页没有执行导入。
Codex 提供商与认证的完整关系见 config.toml 配置专题。
依据:CLI import
16 / 19
常见误区与排错顺序
- 版本先确认:文档新增项可能未在本机版本出现;别名解析和账号权限不能从产品名称推出。
- 设置不生效先看 /status 来源与 doctor,不先删除整个 ~/.claude 或重新登录。
- 不要把设了 ANTHROPIC_BASE_URL 解释成已切换凭据、套餐或协议;网关认证和上游认证可能不同。
- 不要认为 .claude/settings.local.json 永远自动被 Git 忽略;手工创建后应实际检查。
- /clear、/compact、低档模型与后台代理都不承诺固定省费比例或重置额度。
- 恢复、回滚与删除任务前看清影响;代码回滚、对话回滚和外部服务副作用并不相同。
17 / 19
可改写的任务模板
目标:<用户可观察的行为或产物>
范围:<相关模块、允许写入位置、必须保持的不变量>
依据:<当前版本、日志、复现与官方来源>
验收:<必要检查及通过条件>
执行:在授权范围完成工作;存在实质分歧先说明,普通实施细节自行决定。
交付:结果、文件位置、验证证据、推断与未验证范围;不自动扩大为发布操作。
- 代码审查:写明“只审查,不修改被审对象”,并给出比较基线。
- 生产缺陷:增加数据来源和版本。
- 配置排错:补充认证方式、目标端点与启动入口,不只给一张缺少环境说明的截图。
19 / 19
官方资料与验证范围
- 核对日期:2026-10-20;官方发布版本与本机版本分开记录。
- 已核对:官方资料与本机
--help,没有升级软件、修改个人设置或登录第三方服务。 - 仍需实测:API / 网关、平台差异与账号权限,需在目标环境验收。