wehub/luongnv89--claude-howto

Fork 0

Files

T

wehub-resource-sync 14da4d1e0e

Documentation Checks / Markdown Linting (push) Has been cancelled

Details

Documentation Checks / Check Links (push) Has been cancelled

Details

Documentation Checks / Mermaid Syntax (push) Has been cancelled

Details

Documentation Checks / Cross-reference Check (push) Has been cancelled

Details

Deploy Website to GitHub Pages / Build static site (push) Has been cancelled

Details

Documentation Checks / Summary (push) Has been cancelled

Details

Deploy Website to GitHub Pages / Deploy to GitHub Pages (push) Has been cancelled

Details

docs: make Chinese README the default

2026-07-13 10:25:46 +00:00

28 KiB

Raw Permalink Blame History

Note

本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
English · 原始项目 · 上游 README
原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。

🌐 Language / Ngôn ngữ / 语言 / Мова: English | Tiếng Việt | 中文 | Українська | 日本語

一个周末精通 Claude Code

从输入 claude，到编排 agents、hooks、skills 和 MCP servers —— 配有可视化教程、可复制粘贴的模板，以及引导式学习路径。

15 分钟快速上手 | 找到适合你的起点 | 浏览功能目录

问题所在

你安装了 Claude Code。你运行了几个提示词。然后呢？

官方文档描述的是功能 —— 却没有展示如何把它们组合起来。 你知道 slash commands（斜杠命令）存在，却不知道如何把它们与 hooks、memory 和 subagents 串联成真正能节省数小时的工作流。
没有清晰的学习路径。 应该先学 MCP 还是先学 hooks？先学 Skills 还是先学 subagents？你最后只能草草浏览一切，却什么都掌握不了。
示例过于基础。 一个 "hello world" 斜杠命令帮不了你构建生产级代码审查流水线 —— 那种能利用 memory、委派给专业 agents，并自动运行安全扫描的流水线。

你让 Claude Code 90% 的能力白白闲置 —— 而且你不知道自己不知道什么。

Claude How To 如何解决

这不是又一份功能参考文档。这是一份结构化、可视化、示例驱动的指南，教你用真实世界的模板掌握 Claude Code 的每一项功能 —— 今天就能复制到你的项目中。

	官方文档	本指南
形式	参考文档	带 Mermaid 图表的可视化教程
深度	功能描述	底层工作原理
示例	基础代码片段	可立即使用的生产级模板
结构	按功能组织	渐进式学习路径（从入门到进阶）
上手引导	自学	带时间估算的引导式路线图
自我评估	无	互动测验，帮你发现短板并制定个性化路径

你将获得：

10 个教程模块，涵盖 Claude Code 的每一项功能 —— 从 slash commands 到自定义 agent 团队
可复制粘贴的配置 —— slash commands、CLAUDE.md 模板、hook 脚本、MCP 配置、subagent 定义，以及完整 plugin 套件
Mermaid 图表展示每项功能的内部运作方式，让你理解为什么，而不只是怎么做
引导式学习路径，让你在 11-13 小时内从新手成长为高级用户
内置自我评估 —— 在 Claude Code 中直接运行 /self-assessment 或 /lesson-quiz hooks，识别知识短板

开始学习路径 ->

工作原理

1. 找到你的水平

参加自我评估测验，或在 Claude Code 中运行 /self-assessment。根据你已掌握的内容，获得个性化路线图。

2. 跟随引导路径

按顺序完成 10 个模块 —— 每个模块都建立在前一个之上。学习过程中，直接把模板复制到你的项目中。

3. 将功能组合成工作流

真正的威力在于组合功能。学会把 slash commands + memory + subagents + hooks 串联成自动化流水线，处理代码审查、部署和文档生成。

4. 检验你的理解

每完成一个模块后运行 /lesson-quiz [topic]。测验会精准指出你遗漏的内容，让你快速补齐短板。

15 分钟快速上手

深受开发者信赖

GitHub stars 来自日常使用 Claude Code 的开发者
Forks 来自将本指南适配到自身工作流的团队
持续维护 —— 与每次 Claude Code 版本同步（最新：v2.1.206，2026 年 7 月）
社区驱动 —— 贡献者分享他们的真实世界配置

不确定从哪里开始？

参加自我评估，或直接选择你的水平：

水平	你能……	从这里开始	时间
入门	启动 Claude Code 并聊天	Slash Commands	~2.5 小时
中级	使用 CLAUDE.md 和自定义命令	Skills	~3.5 小时
高级	配置 MCP servers 和 hooks	Advanced Features	~5 小时

包含全部 10 个模块的完整学习路径：

顺序	模块	水平	时间
1	Slash Commands	入门	30 分钟
2	Memory	入门+	45 分钟
3	Checkpoints	中级	45 分钟
4	CLI Basics	入门+	30 分钟
5	Skills	中级	1 小时
6	Hooks	中级	1 小时
7	MCP	中级+	1 小时
8	Subagents	中级+	1.5 小时
9	Advanced Features	高级	2-3 小时
10	Plugins	高级	2 小时

完整学习路线图 ->

15 分钟快速上手

安装说明：自 v2.1.113 起，Claude Code 以各平台原生二进制（macOS/Linux/Windows）形式分发。npm install -g @anthropic-ai/claude-code 仍然可用 —— 原生二进制会在首次使用时作为可选依赖下载。自 v2.1.116 起，下载来自 https://downloads.claude.ai/claude-code-releases —— 企业代理必须将此主机加入白名单。

# 1. Clone the guide
git clone https://github.com/luongnv89/claude-howto.git
cd claude-howto

# 2. Copy your first slash command
mkdir -p /path/to/your-project/.claude/commands
cp 01-slash-commands/optimize.md /path/to/your-project/.claude/commands/

# 3. Try it — in Claude Code, type:
# /optimize

# 4. Ready for more? Set up project memory:
cp 02-memory/project-CLAUDE.md /path/to/your-project/CLAUDE.md

# 5. Install a skill:
cp -r 03-skills/code-review-specialist ~/.claude/skills/

想要完整配置？这里是 1 小时核心配置：

# Slash commands (15 min)
cp 01-slash-commands/*.md .claude/commands/

# Project memory (15 min)
cp 02-memory/project-CLAUDE.md ./CLAUDE.md

# Install a skill (15 min)
cp -r 03-skills/code-review-specialist ~/.claude/skills/

# Weekend goal: add hooks, subagents, MCP, and plugins
# Follow the learning path for guided setup

查看完整安装参考

你能用它构建什么？

用例	你将组合的功能
自动化代码审查	Slash Commands + Subagents + Memory + MCP
团队上手引导	Memory + Slash Commands + Plugins
CI/CD 自动化	CLI Reference + Hooks + Background Tasks
文档生成	Skills + Subagents + Plugins
安全审计	Subagents + Skills + Hooks（只读模式）
DevOps 流水线	Plugins + MCP + Hooks + Background Tasks
复杂重构	Checkpoints + Planning Mode + Hooks

FAQ

这是免费的吗？ 是的。采用 MIT 许可证，永久免费。可用于个人项目、工作、团队——除需包含许可证声明外，无任何限制。

项目是否在维护？ 是的，在积极维护。本指南会随每次 Claude Code 发布同步更新。当前版本：v2.1.206（2026 年 7 月），兼容 Claude Code 2.1+。

与官方文档有何不同？ 官方文档是功能参考。本指南是教程，配有图示、可用于生产的模板，以及渐进式学习路径。二者相辅相成——从这里入门学习，需要具体细节时再查阅官方文档。

学完需要多久？ 完整路径约需 11–13 小时。但 15 分钟内就能获得即时价值——复制一个斜杠命令模板并试用即可。

能与 Claude Sonnet / Haiku / Opus 一起使用吗？ 可以。所有模板均适用于 Claude Sonnet 5、Claude Sonnet 4.6、Claude Opus 4.8 和 Claude Haiku 4.5。

可以参与贡献吗？ 当然可以。请参阅 CONTRIBUTING.md 了解指南。我们欢迎新示例、错误修复、文档改进和社区模板。

可以离线阅读吗？ 可以。运行 uv run scripts/build_epub.py 即可生成包含全部内容及渲染图示的 EPUB 电子书。

今天就开始精通 Claude Code

你已经安装了 Claude Code。你与 10 倍生产力之间，只差知道如何使用它。本指南为你提供结构化路径、可视化说明，以及可复制粘贴的模板，助你达成目标。

MIT 许可证。永久免费。克隆它、Fork 它、把它变成你的。

开始学习路径 -> | 浏览功能目录 | 15 分钟快速上手

快速导航 — 全部功能

Feature	Description	Folder
功能目录	含安装命令的完整参考	CATALOG.md
Slash Commands	用户主动调用的快捷方式	01-slash-commands/
Memory	持久化上下文	02-memory/
Skills	可复用能力	03-skills/
Subagents	专用 AI 助手	04-subagents/
MCP Protocol	外部工具访问	05-mcp/
Hooks	事件驱动自动化	06-hooks/
Plugins	捆绑功能	07-plugins/
Checkpoints	会话快照与回退	08-checkpoints/
高级功能	规划、思考、后台任务	09-advanced-features/
CLI 参考	命令、标志与选项	10-cli/
博客文章	真实使用示例	Blog Posts)

功能对比

Feature	Invocation	Persistence	Best For
Slash Commands	Manual (`/cmd`)	Session only	Quick shortcuts
Memory	Auto-loaded	Cross-session	Long-term learning
Skills	Auto-invoked	Filesystem	Automated workflows
Subagents	Auto-delegated	Isolated context	Task distribution
MCP Protocol	Auto-queried	Real-time	Live data access
Hooks	Event-triggered	Configured	Automation & validation
Plugins	One command	All features	Complete solutions
Checkpoints	Manual/Auto	Session-based	Safe experimentation
Planning Mode	Manual/Auto	Plan phase	Complex implementations
Background Tasks	Manual	Task duration	Long-running operations
CLI Reference	Terminal commands	Session/Script	Automation & scripting

安装快速参考

# Slash Commands
cp 01-slash-commands/*.md .claude/commands/

# Memory
cp 02-memory/project-CLAUDE.md ./CLAUDE.md

# Skills
cp -r 03-skills/code-review-specialist ~/.claude/skills/

# Subagents
cp 04-subagents/*.md .claude/agents/

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

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

# Plugins
/plugin install pr-review

# Checkpoints (auto-enabled, configure in settings)
# See 08-checkpoints/README.md

# Advanced Features (configure in settings)
# See 09-advanced-features/config-examples.json

# CLI Reference (no installation needed)
# See 10-cli/README.md for usage examples

01. Slash Commands

位置：01-slash-commands/

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

示例：

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

安装：

cp 01-slash-commands/*.md /path/to/project/.claude/commands/

用法：

/optimize
/pr
/generate-api-docs

了解更多：Discovering Claude Code Slash Commands

02. Memory

位置：02-memory/

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

示例：

project-CLAUDE.md - 团队级项目标准
directory-api-CLAUDE.md - 目录级规则
personal-CLAUDE.md - 个人偏好

安装：

# Project memory
cp 02-memory/project-CLAUDE.md /path/to/project/CLAUDE.md

# Directory memory
cp 02-memory/directory-api-CLAUDE.md /path/to/project/src/api/CLAUDE.md

# Personal memory
cp 02-memory/personal-CLAUDE.md ~/.claude/CLAUDE.md

用法：由 Claude 自动加载

03. Skills

位置：03-skills/

是什么：带说明与脚本、可复用且自动调用的能力

示例：

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

安装：

# Personal skills
cp -r 03-skills/code-review-specialist ~/.claude/skills/

# Project skills
cp -r 03-skills/code-review-specialist /path/to/project/.claude/skills/

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

04. Subagents

位置：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 Protocol

位置：05-mcp/

是什么：用于访问外部工具与 API 的 Model Context Protocol（模型上下文协议）

示例：

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

安装：

# Set environment variables
export GITHUB_TOKEN="your_token"
export DATABASE_URL="postgresql://..."

# Add MCP server via CLI
claude mcp add github -- npx -y @modelcontextprotocol/server-github

# Or add to project .mcp.json manually (see 05-mcp/ for examples)

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

06. Hooks

位置：06-hooks/

是什么：响应 Claude Code 事件时自动执行的事件驱动 Shell 命令

示例：

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：

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

用法：Hooks 会在事件发生时自动执行

Hook 类型（5 种类型，29 个事件）：

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

07. 插件

位置：07-plugins/

说明：内置的命令、agents、MCP 和 hooks 集合

示例：

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

安装：

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

用法：使用内置的 slash commands 和功能

08. 检查点与回退

位置：08-checkpoints/

说明：保存对话状态并回退到先前节点，以探索不同方案

关键概念：

Checkpoint（检查点）：对话状态快照
Rewind（回退）：返回到先前的检查点
Branch Point（分支点）：从同一检查点探索多种方案

用法：

# Checkpoints are created automatically with every user prompt
# To rewind, press Esc twice or use:
/rewind

# Then choose from five options:
# 1. Restore code and conversation
# 2. Restore conversation
# 3. Restore code
# 4. Summarize from here
# 5. Never mind

使用场景：

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

09. 高级功能

位置：09-advanced-features/

说明：面向复杂工作流与自动化的进阶能力

包含：

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

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

10. CLI 参考

位置：10-cli/

说明：Claude Code 的完整命令行界面参考

快速示例：

# Interactive mode
claude "explain this project"

# Print mode (non-interactive)
claude -p "review this code"

# Process file content
cat error.log | claude -p "explain this error"

# JSON output for scripts
claude -p --output-format json "list functions"

# Resume session
claude -r "feature-auth" "continue implementation"

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

示例工作流

完整代码审查工作流

# Uses: Slash Commands + Subagents + Memory + MCP

User: /review-pr

Claude:
1. Loads project memory (coding standards)
2. Fetches PR via GitHub MCP
3. Delegates to code-reviewer subagent
4. Delegates to test-engineer subagent
5. Synthesizes findings
6. Provides comprehensive review

自动化文档

# Uses: Skills + Subagents + Memory

User: "Generate API documentation for the auth module"

Claude:
1. Loads project memory (doc standards)
2. Detects doc generation request
3. Auto-invokes doc-generator skill
4. Delegates to api-documenter subagent
5. Creates comprehensive docs with examples

DevOps 部署

# Uses: Plugins + MCP + Hooks

User: /deploy production

Claude:
1. Runs pre-deploy hook (validates environment)
2. Delegates to deployment-specialist subagent
3. Executes deployment via Kubernetes MCP
4. Monitors progress
5. Runs post-deploy hook (health checks)
6. Reports status

目录结构

├── 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-specialist/
│   │   ├── 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 (this file)

最佳实践

建议做法

从 slash commands 入手，保持简单
逐步添加功能
使用 memory 记录团队规范
先在本地测试配置
记录自定义实现
对项目配置进行版本控制
与团队共享 plugins

避免做法

不要创建冗余功能
不要硬编码凭据
不要跳过文档
不要过度复杂化简单任务
不要忽视安全最佳实践
不要提交敏感数据

故障排除

功能未加载

检查文件位置和命名
验证 YAML frontmatter 语法
检查文件权限
检查 Claude Code 版本兼容性

MCP 连接失败

验证环境变量
检查 MCP server 安装
测试凭据
检查网络连接

Subagent 未委派任务

检查 tool 权限
验证 agent 描述是否清晰
评估任务复杂度
独立测试 agent

测试

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

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

# Install development dependencies
uv pip install -r requirements-dev.txt

# Run all unit tests
pytest scripts/tests/ -v

# Run tests with coverage report
pytest scripts/tests/ -v --cov=scripts --cov-report=html

# Run code quality checks
ruff check scripts/
ruff format --check scripts/

# Run security scan
bandit -c pyproject.toml -r scripts/ --exclude scripts/tests/

# Run type checking
mypy scripts/ --ignore-missing-imports

每次推送到 main/develop 以及向 main 提交的每个 PR 都会自动运行测试。详见 TESTING.md。

EPUB 生成

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

uv run scripts/build_epub.py

这将创建 claude-howto-guide.epub，其中包含全部内容，包括已渲染的 Mermaid 图表。

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

参与贡献

发现问题或想贡献示例？我们非常欢迎你的帮助！

请阅读 CONTRIBUTING.md 了解详细指南，内容包括：

贡献类型（示例、文档、功能、缺陷、反馈）
如何搭建开发环境
目录结构及如何添加内容
写作规范与最佳实践
提交与 PR 流程

我们的社区准则：

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

报告安全问题

如果你发现安全漏洞，请负责任地报告：

使用 GitHub 私密漏洞报告：https://github.com/luongnv89/claude-howto/security/advisories
或阅读 .github/SECURITY_REPORTING.md 获取详细说明
请勿为安全漏洞公开提 Issue

快速入门：

Fork 并克隆仓库
创建描述清晰的分支（add/feature-name、fix/bug、docs/improvement）
按照指南进行修改
提交描述清晰的 Pull Request

需要帮助？ 提交 Issue 或 Discussion，我们会引导你完成流程。

其他资源

Claude Code 文档
MCP 协议规范
Skills 仓库 - 即用型 Skills 合集
Anthropic Cookbook
Boris Cherny 的 Claude Code 工作流 - Claude Code 的创建者分享了他体系化的工作流：并行 Agent、共享 CLAUDE.md、Plan 模式、斜杠命令、子 Agent，以及用于自主长时间运行会话的验证钩子。

参与贡献

我们欢迎贡献！请参阅我们的贡献指南了解如何开始。

许可证

MIT License - 详见 LICENSE。可自由使用、修改和分发。唯一要求是保留许可证声明。

最后更新：2026 年 7 月 11 日 Claude Code 版本：2.1.206 来源：

https://code.claude.com/docs/en/overview
https://code.claude.com/docs/en/changelog
https://code.claude.com/docs/en/permission-modes
https://platform.claude.com/docs/en/about-claude/models/overview
https://github.com/anthropics/claude-code/releases
https://github.com/anthropics/claude-code/releases/tag/v2.1.154 兼容模型：Claude Sonnet 5、Claude Sonnet 4.6、Claude Opus 4.8、Claude Haiku 4.5

28 KiB Raw Permalink Blame History Unescape Escape

一个周末精通 Claude Code

目录

问题所在

Claude How To 如何解决

你将获得：

工作原理

1. 找到你的水平

2. 跟随引导路径

3. 将功能组合成工作流

4. 检验你的理解

深受开发者信赖

不确定从哪里开始？

15 分钟快速上手

你能用它构建什么？

FAQ

今天就开始精通 Claude Code

完整代码审查工作流

自动化文档

DevOps 部署

建议做法

避免做法

功能未加载

MCP 连接失败

Subagent 未委派任务

报告安全问题

参与贡献

许可证

28 KiB

Raw Permalink Blame History