Claude_Code_使用手册
Claude Code 使用手册本手册面向 Claude Code CLI 用户涵盖常用命令、Skill 使用技巧及最佳实践。目录快速入门基本常用命令Skill 使用技巧高级功能配置与个性化常见问题一、快速入门1.1 安装 Claude Codenpminstall-ganthropic-ai/claude-code1.2 启动方式# 方式1在项目目录中启动cdyour-project claude# 方式2直接指定项目路径claude /path/to/project1.3 基本交互操作快捷键/命令说明发送消息Enter提交当前输入多行输入直接粘贴或连续输入Claude Code 支持多行文本粘贴退出/exit或CtrlC退出会话查看帮助/help显示所有可用命令注意Claude Code CLI 基于终端不支持ShiftEnter换行。如需输入多行内容可直接粘贴完整文本或先在外部编辑器写好再粘贴。二、基本常用命令2.1 内置命令命令说明示例/status查看当前模型和配置状态/status/help显示帮助信息/help/clear清除当前对话历史/clear/compact压缩对话历史以节省上下文/compact/exit退出 Claude Code/exit2.2 文件操作命令命令/操作说明示例文件名引用指定文件src/main.py文件夹/引用整个文件夹src/#行号引用文件特定行src/main.py#10-20查看文件让 Claude 读取文件内容查看 src/main.py 的内容修改文件让 Claude 编辑文件修改 src/main.py添加注释2.3 代码操作命令操作说明示例解释代码解释当前代码逻辑解释这段代码的作用重构代码改进代码结构和质量重构这个函数使其更易读添加注释为代码添加文档注释为这段代码添加详细注释生成测试创建单元测试为 UserService 类生成单元测试查找错误分析和修复 Bug这段代码有什么问题2.4 终端命令执行Claude Code 可以直接在终端执行命令运行 npm install 执行 git status 查看当前目录下的所有文件2.5 Git 相关操作操作示例查看 Git 状态查看 git 状态提交代码提交当前更改消息是修复登录bug查看提交历史查看最近的提交记录创建分支创建新分支 feature/login三、Skill 使用技巧3.1 什么是 SkillSkill 是存储在.cursor/skills/或~/.cursor/skills/下的 Markdown 文件用于教 AI 如何完成特定任务。3.2 Skill 目录结构skill-name/ ├── SKILL.md # 必填主说明文档 ├── reference.md # 可选详细参考文档 ├── examples.md # 可选使用示例 └── scripts/ # 可选配套脚本 └── helper.py3.3 创建自定义 Skill步骤 1创建目录mkdir-p~/.cursor/skills/my-skill步骤 2编写 SKILL.md--- name: my-skill description: 简要描述这个 Skill 的作用和触发时机 --- # My Skill ## 使用步骤 1. 第一步说明 2. 第二步说明 3. 第三步说明 ## 示例 提供具体的使用示例...步骤 3关键编写要点要点说明示例name小写字母、数字、连字符最多64字符code-review,generate-testsdescription第三人称说明做什么和何时用生成单元测试当用户要求测试代码时使用精简只写 AI 不知道的信息避免解释基础概念长度SKILL.md 建议不超过 500 行细节放 reference.md路径使用正斜杠scripts/helper.py3.4 常用内置 Skill 参考create-rule创建规则用途创建项目规则文件.mdc统一 AI 行为触发当用户想添加编码规范、项目约定时使用示例帮我在项目里加一条 TypeScript 的编码规则 创建一个 React 组件规范生成的规则文件结构--- description: TypeScript 编码规范 globs: **/*.ts alwaysApply: false --- # TypeScript 规范 - 使用严格类型 - 避免 any 类型 - 函数需要返回类型注解create-skill创建 Skill用途帮助用户编写新的 Skill触发当用户想创建自定义 Skill 时使用示例新建一个用于代码审查的 skill 帮我创建一个生成 API 文档的 skillupdate-cursor-settings更新设置用途修改 Cursor 编辑器设置触发当用户想改字体、主题、快捷键等设置时示例把编辑器字体调大 开启保存时自动格式化 把主题改成深色3.5 Skill 最佳实践渐进式说明核心内容放在 SKILL.md详细说明放在 reference.md示例放在 examples.md描述要具体✅ 好分析 Excel 数据并生成报表当用户处理 .xlsx 文件时使用❌ 差帮助处理文档使用模板## 工作流程 复制此清单并跟踪进度 - [ ] 步骤 1分析需求 - [ ] 步骤 2设计方案 - [ ] 步骤 3实现功能 - [ ] 步骤 4验证结果避免反模式❌ Windows 风格路径scripts\helper.py✅ 正斜杠路径scripts/helper.py❌ 太多选项你可以用 A或 B或 C...✅ 提供默认使用 A特殊情况用 B四、高级功能4.1 多文件编辑同时修改 src/user.ts 和 src/auth.ts添加登录验证4.2 代码搜索与分析搜索项目中所有使用 User 类的地方 分析项目结构并生成架构图 找出所有未使用的函数4.3 批量操作为 src/components/ 下的所有组件添加 PropTypes 把项目中所有 var 改成 const 或 let4.4 智能补全基于已有的 UserService帮我写 ArticleService 参考现有的样式为新页面写 CSS五、配置与个性化5.1 配置文件位置平台路径WindowsC:\Users\用户名\.claude\settings.jsonmacOS~/.claude/settings.jsonLinux~/.claude/settings.json5.2 常用配置项{env:{ANTHROPIC_AUTH_TOKEN:your-api-key,ANTHROPIC_BASE_URL:https://api.anthropic.com,ANTHROPIC_DEFAULT_MODEL:claude-sonnet-4-20250514},preferences:{auto_execute_commands:false,confirm_destructive_operations:true}}5.3 配置 GLM 模型Z.AI{env:{ANTHROPIC_AUTH_TOKEN:your-zai-api-key,ANTHROPIC_BASE_URL:https://api.z.ai/api/anthropic,ANTHROPIC_DEFAULT_HAIKU_MODEL:glm-5,ANTHROPIC_DEFAULT_SONNET_MODEL:glm-5,ANTHROPIC_DEFAULT_OPUS_MODEL:glm-5}}六、常见问题Q1: Claude Code 启动失败解决# 检查 Node.js 版本需要 18node--version# 重新安装npmuninstall-ganthropic-ai/claude-codenpminstall-ganthropic-ai/claude-codeQ2: API Key 无效解决检查settings.json中的ANTHROPIC_AUTH_TOKEN确认 API Key 有余额验证网络连接Q3: 如何切换模型解决# 查看当前模型/status# 在配置文件中修改默认模型# 或使用环境变量exportANTHROPIC_DEFAULT_MODELclaude-opus-4-20250514Q4: 对话历史太长解决/compact # 压缩历史 /clear # 清除历史Q5: Skill 没有生效解决检查 Skill 文件位置是否正确确认 SKILL.md 格式正确包含 YAML frontmatter验证 description 是否清晰具体重启 Claude Code参考资源Claude Code 官方文档Cursor 官方文档Z.AI 开发文档手册生成于 Claude Code
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2430201.html
如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!