Claude Code 使用文档
Claude Code 使用文档
版本:Claude Code CLI
最后更新:2026/04/25
目录
简介
Claude Code 是 Anthropic 推出的官方 CLI 工具,将 Claude AI 的能力直接集成到终端中。它可以帮你:
- 阅读、编辑、创建项目文件
- 执行和调试代码
- 分析代码库结构和依赖关系
- 运行测试和构建命令
- 进行代码审查和安全检查
- 与外部工具和服务集成
快速开始
安装
# 通过 npm 安装
npm install -g @anthropic-ai/claude-code
# 或通过包管理器(各平台不同)
# macOS: brew install claude-code
# Windows: winget install Anthropic.ClaudeCode
启动
# 在当前目录启动 Claude Code
claude
# 启动并直接进入某个目录
claude /path/to/project
首次配置
首次运行时会提示登录 Anthropic 账号并设置 API Key。支持通过浏览器 OAuth 或手动输入 API Key。
核心命令
在 Claude Code 的交互界面中,以 / 开头的命令称为 slash commands。
常用命令一览
| 命令 | 功能 |
|---|---|
/help | 显示帮助信息 |
/init | 初始化 CLAUDE.md 项目文档 |
/commit | 自动提交代码变更(生成提交信息) |
/review | 审查当前分支的变更 |
/loop [间隔] | 启动循环任务模式 |
/config | 查看和修改配置 |
/clear | 清空对话上下文 |
/cost | 查看本次会话的 token 消耗和费用 |
/exit 或 Ctrl+D | 退出 Claude Code |
/commit - 智能提交
分析工作区的变更,自动生成提交信息并完成 git commit。
/commit
/review - 代码审查
审查当前分支相对于基分支的所有变更,输出审查报告。
/review
交互模式
自然语言指令
直接输入你想做的事,Claude Code 会理解并执行:
帮我修复 src/utils.js 中的那个 bug
把 foo 函数重命名为 handleFoo
解释一下这个正则表达式的作用
上下文感知
Claude Code 会自动读取当前工作目录的结构和文件内容,因此你可以直接引用项目中的文件和函数名,无需粘贴代码。
多轮对话
支持连续多轮对话,Claude 会记住本轮会话中的上下文。如果上下文太长,可以使用 /clear 清空。
文件操作
Claude Code 可以直接读写项目文件。你只需描述需求即可。
读取文件
读取 src/app.js 的内容
Claude 会使用 Read 工具读取文件内容并展示给你。
编辑文件
在 src/app.js 的第 15 行添加错误处理
把 config.json 中的 timeout 改为 5000
Claude 会使用 Edit 工具进行精准替换编辑。
创建文件
创建一个 README.md,介绍这个项目
Claude 会使用 Write 工具创建新文件。
搜索文件
搜索项目中所有用到 axios 的地方
找到定义 User 模型的文件
Claude 会使用 Glob 和 Grep 工具搜索文件。
任务管理
使用任务系统跟踪复杂的多步骤工作。
创建任务
/TaskCreate 分析代码库依赖关系
查看任务列表
/TaskList
更新任务状态
/TaskUpdate 1 状态为已完成
任务状态
pending- 待处理in_progress- 进行中completed- 已完成deleted- 已删除
计划模式
对于复杂的实现任务,使用计划模式(Plan Mode)先制定方案,再执行。
进入计划模式
/EnterPlanMode
或输入复杂任务时 Claude 可能会自动建议进入计划模式。
计划模式流程
- 探索 - Claude 分析代码库,理解现有架构
- 设计 - 制定详细的实施步骤
- 确认 - 向你展示计划,等待确认
- 执行 - 按计划逐步实施
退出计划模式
/ExitPlanMode
计划确认后才会执行,避免 unintended changes。
循环模式
用于需要周期性执行的任务,如轮询状态、定时检查等。
启动循环
/loop 5m 检查测试状态
支持的时间格式:
30s- 30 秒5m- 5 分钟1h- 1 小时
停止循环
/CronDelete <job-id>
或使用 Ctrl+C 中断。
查看定时任务
/CronList
Skill 系统
Skills 是 Claude Code 的扩展功能模块,针对特定场景提供专业能力。
使用 Skill
/<skill-name>
内置 Skills
| Skill | 用途 |
|---|---|
init | 初始化项目文档 |
commit | 智能 git 提交 |
review | PR/分支审查 |
security-review | 安全审查 |
update-config | 修改配置 |
claude-api | Claude API/SDK 开发辅助 |
loop | 循环任务管理 |
simplify | 代码简化优化 |
fewer-permission-prompts | 权限提示优化 |
工具调用
Claude Code 可以调用多种工具完成操作。工具调用需要你的授权(根据权限设置)。
可用工具
| 工具 | 功能 |
|---|---|
Read | 读取文件内容 |
Write | 创建/覆盖文件 |
Edit | 精准编辑文件 |
Glob | 按模式搜索文件 |
Grep | 内容搜索 |
Bash | 执行 shell 命令 |
Agent | 启动子代理处理子任务 |
WebFetch | 获取网页内容 |
WebSearch | 网络搜索 |
AskUserQuestion | 向用户提问 |
NotebookEdit | 编辑 Jupyter Notebook |
权限控制
你可以在 .claude/settings.json 中配置工具权限,减少重复授权提示:
{
"permissions": {
"Read": "allow",
"Bash": "ask",
"Write": "ask"
}
}
MCP 集成
MCP(Model Context Protocol)允许 Claude Code 与外部服务和数据源集成。
配置 MCP 服务器
在项目或全局的 .claude/settings.json 中添加:
{
"mcpServers": {
"github": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<token>"
}
}
}
}
使用 MCP 工具
配置后,Claude 会自动在适当场景调用 MCP 工具,如在讨论 GitHub Issue 时使用 GitHub MCP。
配置与设置
配置文件位置
- 全局配置:
~/.claude/settings.json - 项目配置:
.claude/settings.json(当前项目) - 本地配置:
.claude/settings.local.json(不提交到 git)
常用配置项
{
"theme": "dark",
"model": "claude-sonnet-4-6",
"permissions": {
"Bash": "ask",
"Write": "ask",
"Edit": "ask"
},
"env": {
"DEBUG": "true"
},
"hooks": {
"beforeTool": "echo 'Running tool...'"
}
}
查看当前配置
/config
修改配置
/config theme light
/config model claude-opus-4-7
最佳实践
1. 使用 CLAUDE.md
在项目根目录创建 CLAUDE.md,记录项目架构、约定和重要信息。Claude Code 会自动读取它,使回答更精准。
# 项目指南
## 技术栈
- React + TypeScript
- Vite 构建工具
## 代码规范
- 使用 2 空格缩进
- 组件使用 PascalCase
2. 明确指定范围
模糊请求可能导致大范围变更。尽量明确:
- ❌ "优化一下代码"
- ✅ "优化 src/api/client.ts 中的错误处理逻辑"
3. 分步处理大任务
复杂任务建议分步骤进行,或进入计划模式。避免一次性要求过多变更。
4. 审查变更
使用 /review 或要求 Claude 展示 git diff,确认变更后再提交。
5. 善用子代理
对于独立的子任务,Claude 会自动启动子代理(Agent)并行处理,提高效率。
6. 管理上下文
- 对话过长时,使用
/clear清空 - 使用
@filename明确引用文件 - 对于不相关的主题,开启新会话
7. 安全注意
- 谨慎授权
Bash和Write操作 - 不要在对话中分享 API Key、密码等敏感信息
- 使用
.claude/settings.local.json存储本地敏感配置
快捷键
| 快捷键 | 功能 |
|---|---|
Ctrl+C | 中断当前操作 |
Ctrl+D | 退出 Claude Code |
Tab | 自动补全 |
↑/↓ | 浏览历史输入 |
常见问题
Q: Claude Code 会修改我没要求的文件吗?
A: 默认不会。Claude 只在你明确要求或任务需要时修改文件。进入计划模式后,执行前会征求确认。
Q: 如何撤销 Claude 的修改?
A: Claude 使用 git 进行编辑。可以通过 git diff 查看变更,git checkout 撤销。建议在干净的工作区使用 Claude Code。
Q: 支持哪些编程语言?
A: 支持所有主流编程语言,包括但不限于 Python、JavaScript/TypeScript、Go、Rust、Java、C/C++、Ruby 等。
Q: 可以离线使用吗?
A: 不可以。Claude Code 需要连接 Anthropic API。