# 斜杠命令
cp 01-slash-commands/*.md .claude/commands/

# 记忆
cp 02-memory/project-CLAUDE.md ./CLAUDE.md

# 技能
cp -r 03-skills/code-review ~/.claude/skills/

# 子代理
cp 04-subagents/*.md .claude/agents/

# MCP
export GITHUB_TOKEN="token"
claude mcp add github -- npx -y @modelcontextprotocol/server-github

# 钩子
mkdir -p ~/.claude/hooks
cp 06-hooks/*.sh ~/.claude/hooks/
chmod +x ~/.claude/hooks/*.sh

# 插件
/plugin install pr-review

# 检查点（自动启用，需在设置中配置）
# 参见 08-checkpoints/README.md

# 高级功能（需在设置中配置）
# 参见 09-advanced-features/config-examples.json

# CLI 参考（无需安装）
# 参见 10-cli/README.md 以获取使用示例

位置：01-slash-commands/

是什么：以 Markdown 文件形式存储的用户调用的快捷方式

示例：

• optimize.md - 代码优化分析
• pr.md - 拉取请求准备
• generate-api-docs.md - API 文档生成器

安装：

cp 01-slash-commands/*.md /项目路径/.claude/commands/

使用：

/optimize
/pr
/generate-api-docs

了解更多：探索 Claude Code 斜杠命令

位置：02-memory/

是什么：跨会话的持久上下文

示例：

• project-CLAUDE.md - 团队范围的项目标准
• directory-api-CLAUDE.md - 目录特定规则
• personal-CLAUDE.md - 个人偏好

安装：

# 项目记忆
cp 02-memory/project-CLAUDE.md /项目路径/CLAUDE.md

# 目录记忆
cp 02-memory/directory-api-CLAUDE.md /项目路径/src/api/CLAUDE.md

# 个人记忆
cp 02-memory/personal-CLAUDE.md ~/.claude/CLAUDE.md

使用方法：由Claude自动加载

位置：03-skills/

内容：可复用、自动调用的功能模块，包含说明和脚本

示例：

• code-review/ - 带脚本的全面代码审查
• brand-voice/ - 品牌语音一致性检查器
• doc-generator/ - API文档生成器

安装：

# 个人技能
cp -r 03-skills/code-review ~/.claude/skills/

# 项目技能
cp -r 03-skills/code-review /path/to/project/.claude/skills/

使用方法：在相关场景下自动调用

位置：04-subagents/

内容：具有独立上下文和自定义提示的专用AI助手

示例：

• code-reviewer.md - 全面的代码质量分析
• test-engineer.md - 测试策略与覆盖率
• documentation-writer.md - 技术文档
• secure-reviewer.md - 专注于安全的只读审查
• implementation-agent.md - 功能的完整实现

安装：

cp 04-subagents/*.md /path/to/project/.claude/agents/

使用方法：由主代理自动委派任务

位置：05-mcp/

内容：用于访问外部工具和API的模型上下文协议

示例：

• github-mcp.json - GitHub集成
• database-mcp.json - 数据库查询
• filesystem-mcp.json - 文件操作
• multi-mcp.json - 多个MCP服务器

安装：

# 设置环境变量
export GITHUB_TOKEN="your_token"
export DATABASE_URL="postgresql://..."

# 通过命令行添加MCP服务器
claude mcp add github -- npx -y @modelcontextprotocol/server-github

# 或者手动将MCP配置添加到项目中的.mcp.json文件（详见05-mcp/中的示例）

使用方法：配置完成后，MCP工具会自动对Claude可用

位置：06-hooks/

内容：基于事件驱动的Shell命令，可在Claude Code事件发生时自动执行

示例：

• format-code.sh - 写代码前自动格式化
• pre-commit.sh - 提交前运行测试
• security-scan.sh - 扫描安全漏洞
• log-bash.sh - 记录所有Bash命令
• validate-prompt.sh - 验证用户提示
• notify-team.sh - 在特定事件发生时发送通知

安装：

mkdir -p ~/.claude/hooks
cp 06-hooks/*.sh ~/.claude/hooks/
chmod +x ~/.claude/hooks/*.sh

在~/.claude/settings.json中配置钩子：

{
  "hooks": {
    "PreToolUse": [{
      "matcher": "Write",
      "hooks": ["~/.claude/hooks/format-code.sh"]
    }],
    "PostToolUse": [{
      "matcher": "Write",
      "hooks": ["~/.claude/hooks/security-scan.sh"]
    }]
  }
}

使用方法：钩子会在相应事件触发时自动执行

钩子类型（4种类型，共25个事件）：

• 工具钩子：PreToolUse、PostToolUse、PostToolUseFailure、PermissionRequest
• 会话钩子：SessionStart、SessionEnd、Stop、StopFailure、SubagentStart、SubagentStop
• 任务钩子：UserPromptSubmit、TaskCompleted、TaskCreated、TeammateIdle
• 生命周期钩子：ConfigChange、CwdChanged、FileChanged、PreCompact、PostCompact、WorktreeCreate、WorktreeRemove、Notification、InstructionsLoaded、Elicitation、ElicitationResult

位置：07-plugins/

内容：捆绑的命令、代理、MCP和钩子集合

示例：

• pr-review/ - 完整的PR审查工作流
• devops-automation/ - 部署与监控
• documentation/ - 文档生成

安装：

/plugin install pr-review
/plugin install devops-automation
/plugin install documentation

使用方法：使用捆绑的斜杠命令和功能

位置：08-checkpoints/

内容：保存对话状态并回溯到先前的节点，以探索不同的方案

核心概念：

• 检查点：对话状态的快照
• 回溯：返回到之前的检查点
• 分支点：从同一检查点探索多种方案

使用方法：

# 每次用户输入提示时都会自动创建检查点
# 要回溯，按两次Esc键，或使用：
/rewind

# 然后选择以下五个选项：
# 1. 恢复代码和对话
# 2. 恢复对话
# 3. 恢复代码
# 4. 从此处总结
# 5. 算了

应用场景：

• 尝试不同的实现方案
• 从错误中恢复
• 安全地进行实验
• 对比不同解决方案
• 对不同设计进行A/B测试

位置：09-advanced-features/

内容：用于复杂工作流和自动化处理的高级能力

包括：

• 规划模式 — 在编码前制定详细的实施计划
• 扩展思考 — 针对复杂问题进行深入推理（可通过Alt+T/Option+T切换）
• 后台任务 — 运行长时间操作而不阻塞
• 权限模式 — default、acceptEdits、plan、dontAsk、bypassPermissions
• 无头模式 — 在CI/CD中运行Claude Code：claude -p "Run tests and generate report"
• 会话管理 — /resume、/rename、/fork、claude -c、claude -r
• 配置 — 在~/.claude/settings.json中自定义行为

完整的配置示例请参阅config-examples.json。

位置：10-cli/

内容：Claude Code的完整命令行界面参考

快速示例：

# 交互模式
claude "explain this project"

# 打印模式（非交互式）
claude -p "review this code"

# 处理文件内容
cat error.log | claude -p "explain this error"

# 为脚本输出JSON
claude -p --output-format json "list functions"

# 恢复会话
claude -r "feature-auth" "continue implementation"

应用场景：CI/CD流水线集成、脚本自动化、批处理、多会话工作流、自定义代理配置

完整代码审查工作流

# 使用：斜杠命令 + 子代理 + 记忆 + MCP

用户：/review-pr

Claude：
1. 加载项目记忆（编码标准）
2. 通过GitHub MCP获取PR
3. 委托给code-reviewer子代理
4. 委托给test-engineer子代理
5. 综合分析结果
6. 提供全面的审查报告

自动化文档生成

# 用途：技能 + 子代理 + 内存

用户：“为 auth 模块生成 API 文档”

Claude：
1. 加载项目内存（文档标准）
2. 检测到文档生成请求
3. 自动调用文档生成技能
4. 委托给 API 文档编写子代理
5. 创建包含示例的全面文档

DevOps 部署

# 用途：插件 + MCP + 钩子

用户：/deploy production

Claude：
1. 运行部署前钩子（验证环境）
2. 委托给部署专家子代理
3. 通过 Kubernetes MCP 执行部署
4. 监控进度
5. 运行部署后钩子（健康检查）
6. 报告状态

├── 01-slash-commands/
│   ├── optimize.md
│   ├── pr.md
│   ├── generate-api-docs.md
│   └── README.md
├── 02-memory/
│   ├── project-CLAUDE.md
│   ├── directory-api-CLAUDE.md
│   ├── personal-CLAUDE.md
│   └── README.md
├── 03-skills/
│   ├── code-review/
│   │   ├── SKILL.md
│   │   ├── scripts/
│   │   └── templates/
│   ├── brand-voice/
│   │   ├── SKILL.md
│   │   └── templates/
│   ├── doc-generator/
│   │   ├── SKILL.md
│   │   └── generate-docs.py
│   └── README.md
├── 04-subagents/
│   ├── code-reviewer.md
│   ├── test-engineer.md
│   ├── documentation-writer.md
│   ├── secure-reviewer.md
│   ├── implementation-agent.md
│   └── README.md
├── 05-mcp/
│   ├── github-mcp.json
│   ├── database-mcp.json
│   ├── filesystem-mcp.json
│   ├── multi-mcp.json
│   └── README.md
├── 06-hooks/
│   ├── format-code.sh
│   ├── pre-commit.sh
│   ├── security-scan.sh
│   ├── log-bash.sh
│   ├── validate-prompt.sh
│   ├── notify-team.sh
│   └── README.md
├── 07-plugins/
│   ├── pr-review/
│   ├── devops-automation/
│   ├── documentation/
│   └── README.md
├── 08-checkpoints/
│   ├── checkpoint-examples.md
│   └── README.md
├── 09-advanced-features/
│   ├── config-examples.json
│   ├── planning-mode-examples.md
│   └── README.md
├── 10-cli/
│   └── README.md
└── README.md (此文件)

应该做的

• 从简单的斜杠命令开始
• 循序渐进地添加功能
• 使用内存存储团队标准
• 先在本地测试配置
• 记录自定义实现
• 对项目配置进行版本控制
• 与团队共享插件

不应该做的

• 不要创建重复的功能
• 不要硬编码凭据
• 不要跳过文档
• 不要让简单任务过于复杂
• 不要忽视安全最佳实践
• 不要提交敏感数据

功能未加载

1. 检查文件位置和命名
2. 验证 YAML 前置元数据语法
3. 检查文件权限
4. 查看 Claude Code 版本兼容性

MCP 连接失败

1. 验证环境变量
2. 检查 MCP 服务器安装
3. 测试凭据
4. 检查网络连接

子代理未委托

1. 检查工具权限
2. 验证代理描述是否清晰
3. 回顾任务复杂度
4. 独立测试代理

该项目包含全面的自动化测试：

• 单元测试：使用 pytest 的 Python 测试（Python 3.10、3.11、3.12）
• 代码质量：使用 Ruff 进行 lint 和格式化
• 安全性：使用 Bandit 进行漏洞扫描
• 类型检查：使用 mypy 进行静态类型分析
• 构建验证：EPUB 生成测试
• 覆盖率跟踪：集成 Codecov

# 安装开发依赖
uv pip install -r requirements-dev.txt

# 运行所有单元测试
pytest scripts/tests/ -v

# 运行带覆盖率报告的测试
pytest scripts/tests/ -v --cov=scripts --cov-report=html

# 运行代码质量检查
ruff check scripts/
ruff format --check scripts/

# 运行安全扫描
bandit -c pyproject.toml -r scripts/ --exclude scripts/tests/

# 运行类型检查
mypy scripts/ --ignore-missing-imports

每次向 main 或 develop 分支推送以及向 main 分支提交 PR 时，都会自动运行测试。详细信息请参阅 TESTING.md。

想离线阅读本指南吗？可以生成 EPUB 电子书：

uv run scripts/build_epub.py

这将创建包含所有内容（包括渲染后的 Mermaid 图）的 claude-howto-guide.epub 文件。

更多选项请参阅 scripts/README.md。

发现了一个问题或想贡献一个示例吗？我们非常欢迎您的帮助！

请阅读 CONTRIBUTING.md，了解以下详细指南：

• 贡献类型（示例、文档、功能、缺陷、反馈）
• 如何设置开发环境
• 目录结构及如何添加内容
• 编写指南和最佳实践
• 提交和 PR 流程

我们的社区规范：

• CODE_OF_CONDUCT.md - 我们如何对待彼此
• SECURITY.md - 安全政策和漏洞报告

报告安全问题

如果您发现了安全漏洞，请以负责任的方式报告：

1. 使用 GitHub 私有漏洞报告：https://github.com/luongnv89/claude-howto/security/advisories
2. 或者阅读 .github/SECURITY_REPORTING.md 获取详细说明
3. 切勿公开提交安全漏洞相关的问题

快速入门：

1. 分叉并克隆仓库
2. 创建描述性的分支（add/feature-name、fix/bug、docs/improvement）
3. 按照指南进行更改
4. 提交带有清晰描述的拉取请求

需要帮助吗？ 开启一个问题或讨论，我们会指导您完成整个流程。

• Claude Code 文档
• MCP 协议规范
• 技能库 - 包含大量即用型技能
• Anthropic 烹饪书
• Boris Cherny 的 Claude Code 工作流 - Claude Code 的创造者分享了他的系统化工作流：并行代理、共享 CLAUDE.md、计划模式、斜杠命令、子代理以及用于自主长期运行会话的验证钩子。