Claude Code 使用指南
CLAUDE.md
项目级"AI 工作守则"。一次写好,所有对话默认遵守。最低门槛、最高 ROI。
Slash Commands
把团队常用流程做成快捷指令(/commit、/pr、/review),让规范变成肌肉记忆。
Skills
更深的能力包:调试、规格驱动、TDD 等。Claude 自动按场景调用,无需记忆。
Claude Code 是 Anthropic 推出的官方命令行 AI 编程助手,直接在终端中运行,深度集成到开发工作流中。它不仅能够理解和编写代码,还能以 Agent 模式自主完成复杂的多步骤任务。
安装与初始配置
系统要求
- Node.js 18 或更高版本
- macOS、Linux 或 Windows (WSL)
- 有效的 Anthropic API Key 或通过 Claude.ai Pro/Max 订阅授权
安装步骤
bash
# 通过 npm 全局安装
npm install -g @anthropic-ai/claude-code
# 验证安装
claude --version
# 首次登录(浏览器授权)
claude首次运行时,Claude Code 会引导你完成授权流程。你可以选择通过 Claude.ai 账户登录,或直接配置 API Key:
bash
# 使用 API Key(适合企业/团队环境)
export ANTHROPIC_API_KEY=sk-ant-...
claudeCLAUDE.md 三层配置体系
CLAUDE.md 是 Claude Code 的核心配置文件,采用三层优先级体系,让你能在不同粒度上定制 AI 的行为。
配置层级说明
| 层级 | 文件位置 | 作用范围 | 优先级 |
|---|---|---|---|
| 全局配置 | ~/.claude/CLAUDE.md | 所有项目 | 最低 |
| 项目配置 | <项目根目录>/CLAUDE.md | 当前项目 | 中等 |
| 本地配置 | <项目根目录>/CLAUDE.local.md | 当前项目(不提交 Git) | 最高 |
全局配置示例
markdown
# ~/.claude/CLAUDE.md
## 我的偏好设置
- 代码注释使用中文
- 变量命名遵循 camelCase
- 每次修改代码后主动运行测试
- 解释复杂逻辑时提供类比说明
## 常用技术栈
- 前端:React + TypeScript + Tailwind CSS
- 后端:Node.js + Express / Python + FastAPI
- 数据库:PostgreSQL、Redis
## 代码风格
- 函数不超过 50 行
- 优先使用函数式编程风格
- 避免过度嵌套,最多 3 层项目配置示例
markdown
# CLAUDE.md(项目根目录)
## 项目概述
这是一个电商平台后端服务,使用 Node.js + TypeScript 构建。
## 重要约定
- 所有 API 路由在 `src/routes/` 目录下
- 业务逻辑在 `src/services/` 中,不要在控制器里写业务逻辑
- 数据库操作统一通过 `src/repositories/` 层
## 禁止事项
- 不要直接修改 `dist/` 目录下的文件
- 不要在代码中硬编码任何密钥或密码
- 提交前必须通过 `npm run lint` 和 `npm test`
## 常用命令
- 启动开发服务器:`npm run dev`
- 运行测试:`npm test`
- 构建生产版本:`npm run build`本地配置示例(不纳入版本控制)
markdown
# CLAUDE.local.md
## 本地环境信息
- 数据库连接:localhost:5432/myapp_dev
- 我的测试账号:test@example.com
## 个人偏好(仅本人)
- 每次完成任务后总结所做的更改
- 遇到不确定的地方先询问,不要擅自决定核心功能详解
Agent 模式
Agent 模式是 Claude Code 最强大的特性——它能够自主规划并执行多步骤任务,无需人工逐步干预。
bash
# 启动 Claude Code
claude
# 在交互界面中输入复杂任务
> 帮我实现用户认证功能,包括注册、登录、JWT token 管理,
> 并为每个接口编写单元测试Claude Code 会自动:
- 分析现有代码结构
- 创建必要的文件和目录
- 编写实现代码
- 运行测试验证
- 修复发现的问题
Subagents(子代理)
对于大型任务,Claude Code 可以并行启动多个子代理同时工作:
bash
# 触发并行子代理模式
> 对整个 src/ 目录进行代码审查,检查安全漏洞、性能问题和代码规范子代理特别适合:
- 大规模代码重构
- 跨多个模块的并行分析
- 同时运行多个独立任务
Hooks(钩子)
Hooks 允许你在 Claude Code 执行特定操作前后自动运行自定义脚本:
json
// ~/.claude/settings.json
{
"hooks": {
"PreToolUse": [
{
"matcher": "Bash",
"hooks": [
{
"type": "command",
"command": "echo '即将执行命令,请注意!'"
}
]
}
],
"PostToolUse": [
{
"matcher": "Write",
"hooks": [
{
"type": "command",
"command": "npm run lint --fix"
}
]
}
]
}
}Slash Commands(斜杠命令)
在交互界面中使用斜杠命令快速执行常用操作:
| 命令 | 功能 |
|---|---|
/help | 显示帮助信息 |
/clear | 清除当前对话上下文 |
/compact | 压缩对话历史以节省 token |
/cost | 查看本次会话的 token 消耗 |
/review | 对当前更改进行代码审查 |
/commit | 生成并提交 git commit |
/pr | 创建 Pull Request |
MCP Servers(模型上下文协议服务器)
MCP 服务器为 Claude Code 提供额外的工具和数据源:
json
// ~/.claude/settings.json
{
"mcpServers": {
"filesystem": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/workspace"]
},
"github": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"],
"env": {
"GITHUB_TOKEN": "ghp_..."
}
}
}
}常用工作流
功能开发工作流
bash
# 1. 进入项目目录
cd my-project
# 2. 启动 Claude Code
claude
# 3. 描述需求(越具体越好)
> 参考 src/features/auth/ 的实现方式,为用户模块添加"修改密码"功能。
> 需要:POST /api/users/change-password 接口,验证旧密码,
> 更新为新密码,并使所有已有 token 失效。记得写测试。
# 4. 审查变更
> /review
# 5. 提交代码
> /commit调试工作流
bash
# 粘贴错误信息,让 Claude Code 分析
> 运行 npm test 出现以下错误,帮我找到根本原因并修复:
> [粘贴错误堆栈]
# 或者让它直接运行并诊断
> 运行测试套件,找出所有失败的测试并逐一修复代码审查工作流
bash
# 对 git diff 进行审查
> 审查我在这个 PR 中的所有更改,重点关注:
> 1. 潜在的安全问题
> 2. 性能瓶颈
> 3. 错误处理是否完善
> 4. 代码可维护性实用技巧
提高响应质量的技巧
- 提供上下文:在 CLAUDE.md 中写清楚项目背景,避免每次重复解释
- 明确约束:说明不能改动的文件、必须遵守的规范
- 分阶段工作:大任务拆成小步骤,每步确认后再继续
- 使用
/compact:长会话中定期压缩上下文,保持响应速度
成本控制
bash
# 查看当前会话消耗
> /cost
# 使用更经济的模型(在 settings.json 中配置)json
// ~/.claude/settings.json
{
"model": "claude-haiku-4-5" // 简单任务使用更快更便宜的模型
}键盘快捷键
| 快捷键 | 功能 |
|---|---|
Esc | 中断当前操作 |
Ctrl+C | 强制退出 |
↑ / ↓ | 浏览历史命令 |
Ctrl+L | 清屏 |
Tab | 自动补全文件路径 |
最佳实践总结
- 为每个项目维护详细的
CLAUDE.md,这是提升效果最直接的方式 - 敏感信息(密钥、个人配置)放在
CLAUDE.local.md并加入.gitignore - 复杂任务先让 Claude Code 制定计划,确认后再执行
- 定期使用
/review检查累积的变更 - 善用 Hooks 自动化代码质量检查流程