Skip to content

Commit 5ec92fb

Browse files
committed
fix: sync Claude Code command and agent docs
1 parent 591da57 commit 5ec92fb

8 files changed

Lines changed: 82 additions & 61 deletions

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,7 @@ Week 9 :OpenClaw 多Agent + Docker部署 + 安全
232232

233233
- Claude Code:09-Agent-SDK、10-综合实战
234234
- OpenClaw:08-多Agent、09-Docker部署、10-安全
235+
- 长期 Skill 治理:可参考 [SkillClaw](https://github.com/AMAP-ML/SkillClaw)(skill 演化、去重、合并、共享;论文 [arXiv:2604.08377](https://arxiv.org/abs/2604.08377)
235236

236237
---
237238

@@ -309,7 +310,7 @@ Week 9 :OpenClaw 多Agent + Docker部署 + 安全
309310
- OC-11 常见问题:安装/连接/模型/记忆/性能/中国用户专区
310311

311312
**Claude Code 教程补充**
312-
- 08-Agent-SDK 新增 3.5 节:Task 工具与子代理编排(子代理类型、DAG 依赖、上下文注入
313+
- 08-Agent-SDK 新增 3.5 节:子代理编排(历史稿使用 Task 工具表述;当前版本已校准为 Agent 工具
313314
- 02-基础使用 /permissions 节新增权限模式切换(plan/acceptEdits/bypassPermissions)和 allowedTools 配置
314315
- 04-MCP集成新增 MCP Apps 交互式界面、工具懒加载 ToolSearch(上下文减少 95%)、远程 MCP 服务器
315316
- README 联系方式新增 X(Twitter) 和微信公众号信息
@@ -339,7 +340,7 @@ Week 9 :OpenClaw 多Agent + Docker部署 + 安全
339340
- 回复 Issue #2:SQLite MCP 包名验证与替代方案
340341

341342
**已完成(原待办项)**
342-
- ✅ 08-Agent-SDK 新增 3.5 节:Task 工具与子代理编排(CLI 内置 Subagent 系统
343+
- ✅ 08-Agent-SDK 新增 3.5 节:子代理编排(当前版本使用 Agent 工具表述
343344
- ✅ 02-基础使用 /permissions 节新增权限模式切换、allowedTools 配置说明
344345
- ✅ 04-MCP集成 新增 MCP Apps、工具懒加载(v2.1.52+)、远程 MCP 服务器说明
345346

docs/claude-code/02-基础使用完整指南.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -900,27 +900,27 @@ ses_ghi789 Yesterday other-project API design
900900

901901
#### /export - 导出对话
902902

903-
**作用**把对话导出为文件
903+
**作用**把当前对话导出为纯文本文件
904904

905905
```bash
906-
# 默认导出(Markdown格式)
906+
# 打开导出对话框:复制到剪贴板或保存到文件
907907
You: /export
908908

909-
# 导出到剪贴板
910-
You: /export --clipboard
911-
912-
# 指定格式
913-
You: /export --format json
914-
You: /export --format html
909+
# 直接保存到指定文件
910+
You: /export ./notes/auth-session.txt
915911
```
916912

917-
**格式对比**
913+
> **版本校准(2026-04)**:官方命令参考当前写法是 `/export [filename]`,用途是导出当前对话为 **plain text**。会话内的 `/export --format json``/export --format html` 不是当前支持的 slash 参数;在 Claude Code 2.1.92 / 2.1.107 这类版本里输入这些参数,通常仍会按普通文件名/文本导出处理。
914+
915+
**需要结构化输出时**
916+
917+
```bash
918+
# 非交互 print 模式支持 JSON / stream-json 输出
919+
claude -p "总结当前项目结构" --output-format json
920+
claude -p "检查代码并输出流式事件" --output-format stream-json --verbose
921+
```
918922

919-
| 格式 | 适合场景 |
920-
|------|----------|
921-
| Markdown | 阅读、文档 |
922-
| JSON | 程序处理 |
923-
| HTML | 网页展示 |
923+
`--output-format` 是 CLI print 模式参数,不是会话内 `/export` 的格式参数。
924924

925925
---
926926

@@ -1054,20 +1054,20 @@ You: /security-review
10541054
10551055
---
10561056
1057-
#### /todos - 查看待办事项
1057+
#### 待办追踪(没有 /todos slash 命令)
10581058
1059-
**作用**:列出Claude在对话中追踪的TODO项目
1059+
**作用**:Claude 会在复杂多步骤任务中用内部 `TodoWrite` 工具追踪待办,但当前官方命令参考没有 `/todos` 这个用户可输入的 slash 命令。
10601060
10611061
```bash
1062-
You: /todos
1062+
# 想查看当前工作项时,直接用自然语言询问
1063+
You: 总结一下当前任务进度和剩余待办
10631064
1064-
# 显示待办列表
1065-
Current TODOs:
1066-
1. [ ] Add unit tests for auth module
1067-
2. [ ] Fix database connection pool
1068-
3. [x] Update README documentation
1065+
# 管理后台运行任务时,用 /tasks
1066+
You: /tasks
10691067
```
10701068
1069+
> **不要混淆**`TodoWrite` 是 Claude/Agent SDK 的内部工具事件,不等于一个 `/todos` slash 命令。`/tasks` 管的是后台任务/后台 Bash,不是普通待办列表。
1070+
10711071
---
10721072

10731073
#### /agents - 管理子代理
@@ -1532,10 +1532,10 @@ You: 换一种方式,用工厂模式重构
15321532
**分享会话给团队**
15331533

15341534
```bash
1535-
# 导出对话
1536-
You: /export --format html shared/auth-discussion.html
1535+
# 导出纯文本对话
1536+
You: /export shared/auth-discussion.txt
15371537

1538-
# 团队成员可以在浏览器打开查看
1538+
# 需要网页展示时,再用 Markdown/静态站点工具转换展示
15391539
```
15401540

15411541
**创建可复用的 legacy Slash 命令**
@@ -1934,7 +1934,7 @@ npm update -g @anthropic-ai/claude-code
19341934
| `/memory` | 编辑记忆 |
19351935
| `/permissions` | 管理权限 |
19361936
| `/security-review` | 安全审查 |
1937-
| `/todos` | 查看待办 |
1937+
| `/tasks` | 后台任务管理 |
19381938
| `/rewind` | 回退功能 |
19391939
| `/plan` | 规划模式 |
19401940
| `/mcp` | 管理MCP |

docs/claude-code/03-Commands系统完整指南.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,8 @@ You: /hello
473473
> **本节说明**:内置命令的详细用法已在「02-基础使用完整指南」第四部分讲解过,这里提供速查表方便查阅。
474474
>
475475
> **详细教程**:请回顾「02-基础使用完整指南.md」→ 第四部分:Slash命令大全
476+
>
477+
> **版本校准(2026-04)**:当前官方 Commands Reference 没有 `/todos`。Claude 的待办追踪是内部 `TodoWrite` 工具 / SDK 事件;后台任务管理使用 `/tasks`
476478
477479
### 内置命令速查表
478480

@@ -494,7 +496,7 @@ You: /hello
494496
| | `/permissions` | 管理权限设置 | 安全控制 | |
495497
| | `/add-dir` | 添加工作目录 | 跨目录操作 ||
496498
| **开发辅助** | `/security-review` | 安全审查 | 检查当前 diff 的安全问题 | |
497-
| | `/todos` | 查看待办事项 | 任务追踪 | |
499+
| | `/tasks` | 后台任务管理 | 查看后台 Bash / agent 任务 | |
498500
| | `/rewind` | 回退检查点 | 撤销修改 ||
499501
| **诊断工具** | `/doctor` | 系统健康检查 | 排查问题 | |
500502
| | `/status` | 完整状态信息 | 环境确认 | |
@@ -1926,7 +1928,7 @@ allowed-tools:
19261928
| | `/permissions` | 管理权限 |
19271929
| | `/add-dir` | 添加目录 |
19281930
| **开发** | `/security-review` | 安全审查 |
1929-
| | `/todos` | 查看待办 |
1931+
| | `/tasks` | 后台任务管理 |
19301932
| | `/rewind` | 回退功能 |
19311933
| **诊断** | `/doctor` | 系统诊断 |
19321934
| | `/status` | 完整状态 |

docs/claude-code/05-Hooks系统完整指南.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1702,11 +1702,11 @@ claude -w
17021702

17031703
### 3.8 SubagentStart 和 SubagentStop(子代理生命周期)🆕
17041704

1705-
> **v2.1.49+ 新增**:这两个Hook类型用于监控和管理子代理(Subagent/Task)的生命周期。
1705+
> **v2.1.49+ 新增**:这两个Hook类型用于监控和管理子代理(Subagent/Agent)的生命周期。
17061706
17071707
#### SubagentStart(子代理启动时触发)
17081708

1709-
**触发时机**:Claude Code 启动子代理(通过 Task 工具)时自动触发
1709+
**触发时机**:Claude Code 启动子代理(通过 Agent 工具;旧资料可能写作 Task)时自动触发
17101710

17111711
**典型用途**
17121712
- 记录子代理启动日志

docs/claude-code/06-Subagent子代理完整指南.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@
4141

4242
| 术语 | 英文全称 | 通俗解释 |
4343
|------|----------|----------|
44-
| **Subagent** | Sub-agent | 子代理,Claude Code 通过 Task 工具启动的专业化 AI 代理 |
44+
| **Subagent** | Sub-agent | 子代理,Claude Code 通过 Agent 工具启动的专业化 AI 代理 |
4545
| **VoltAgent** | - | 社区维护的 awesome-claude-code-subagents 开源项目 |
4646
| **Agent Definition** | - | `.md` 格式的代理定义文件,描述代理的角色、能力和行为规范 |
47-
| **Task 工具** | Task Tool | Claude Code 内置工具,用于启动子代理执行独立任务 |
47+
| **Agent 工具** | Agent Tool | Claude Code 内置工具,用于启动子代理执行独立任务;旧资料可能写作 Task |
4848
| **并行调用** | Parallel Invocation | 同时启动多个子代理处理不同任务,提高效率 |
4949

5050
---
@@ -62,15 +62,15 @@
6262

6363
官方 Subagents 的最小闭环不是“先去装一个第三方代理包”,而是:
6464

65-
1. **知道 Claude Code 可以用 Task 工具委派子任务**
65+
1. **知道 Claude Code 可以用 Agent 工具委派子任务**
6666
2. **知道项目级 / 用户级子代理定义文件放在哪里**
6767
3. **知道如何在当前项目里启用和查看它们**
6868

6969
### 你需要记住的 3 个入口
7070

7171
| 入口 | 作用 | 什么时候用 |
7272
|------|------|-----------|
73-
| **Task 工具** | 把一个子任务委派给独立上下文窗口 | 日常并行处理 |
73+
| **Agent 工具** | 把一个子任务委派给独立上下文窗口 | 日常并行处理 |
7474
| **`.claude/agents/`** | 项目级子代理定义目录 | 当前仓库专用代理 |
7575
| **`~/.claude/agents/`** | 用户级子代理定义目录 | 跨项目复用代理 |
7676

docs/claude-code/07-Skills定制完整指南.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2222,6 +2222,7 @@ if __name__ == "__main__":
22222222
2. 参考公众号写作助手的SKILL.md架构设计更复杂的Skill
22232223
3. 与团队分享你的Skill,收集反馈持续优化
22242224
4. 深入理解Hot Reloading和渐进式披露机制
2225+
5. 如果团队已经积累了大量 Skills,可以进一步研究 [SkillClaw](https://github.com/AMAP-ML/SkillClaw):它关注跨用户、长期使用轨迹驱动的 skill 去重、合并、提质和共享,论文见 [arXiv:2604.08377](https://arxiv.org/abs/2604.08377)
22252226

22262227
---
22272228

docs/claude-code/09-Agent-SDK完整指南.md

Lines changed: 41 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -741,12 +741,27 @@ Subagents方式(主管+多员工):
741741
**使用Subagents的方式**
742742

743743
```python
744-
# 允许Task工具,Agent会自动创建子代理
744+
from claude_agent_sdk import ClaudeAgentOptions, AgentDefinition
745+
746+
# 当前 SDK 通过 Agent 工具创建子代理
745747
options = ClaudeAgentOptions(
746-
allowed_tools=['Task', 'TaskOutput', 'Read', 'Write', 'Edit'],
748+
allowed_tools=['Read', 'Grep', 'Glob', 'Edit', 'Write', 'Agent'],
749+
agents={
750+
'api-refactorer': AgentDefinition(
751+
description='负责 API 目录重构,适合处理 src/api 下的模块迁移任务。',
752+
prompt='你是 API 重构专家。只处理分配给你的目录,返回修改摘要和风险点。',
753+
tools=['Read', 'Grep', 'Glob', 'Edit', 'Write'],
754+
model='sonnet',
755+
),
756+
'model-typist': AgentDefinition(
757+
description='负责数据模型和 TypeScript 类型补全。',
758+
prompt='你是 TypeScript 类型建模专家。优先保持兼容性,避免无关重构。',
759+
tools=['Read', 'Grep', 'Glob', 'Edit', 'Write'],
760+
),
761+
},
747762
max_turns=50,
748763
system_prompt="""你是一个项目重构专家。
749-
当遇到大型任务时,请使用Task工具创建子代理来并行处理
764+
当遇到大型任务时,优先使用已定义的子代理并行处理
750765
每个子代理应该专注于一个独立的模块或目录。"""
751766
)
752767

@@ -761,22 +776,23 @@ async for message in query(prompt=prompt, options=options):
761776
# 处理消息...
762777
```
763778

764-
### 3.5 Task 工具与子代理编排(CLI 内置)
779+
> **版本校准(2026-04)**:官方 Agent SDK 文档当前要求在 `allowed_tools` / `allowedTools` 中包含 `Agent`,因为子代理通过 **Agent tool** 调用。旧资料里可能会看到 `Task`,官方文档说明该工具名在 Claude Code v2.1.63 从 `Task` 改为 `Agent`;为兼容旧 SDK,观测 `tool_use` 事件时可以同时识别 `Task``Agent`,但新教程示例应写 `Agent`
765780
766-
> **补充说明**:上面 3.4 节讲的是 SDK 中如何编程创建子代理。这里介绍 Claude Code CLI 中**内置的 Task 工具**——你在交互模式下就能直接使用的多 Agent 编排系统。
781+
### 3.5 Agent 工具与子代理编排
767782

768-
Claude Code CLI 内置了强大的 **Task 工具**,无需写代码就能让 Claude 自动创建子代理:
783+
在 SDK 中,推荐用 `agents` 参数定义子代理,再把 `Agent` 加入主 Agent 的 `allowed_tools`。在 Claude Code CLI 交互模式中,普通用户通常不直接手写底层工具调用,而是通过 `/agents` 管理 agent 配置,或在自然语言里明确要求“使用某个 agent”。
769784

770-
**核心参数**
785+
**AgentDefinition 核心字段**
771786

772787
| 参数 | 说明 |
773788
|------|------|
774-
| `subagent_type` | 子代理类型(Explore、Bash、code-reviewer 等) |
775-
| `prompt` | 分配给子代理的任务描述 |
776-
| `isolation` | 设为 `"worktree"` 可在独立工作树中运行 |
777-
| `run_in_background` | 设为 `true` 在后台运行 |
778-
| `resume` | 传入之前的 agent ID 可恢复中断的子代理 |
779-
| `model` | 可指定 sonnet/opus/haiku,不指定则继承父级 |
789+
| `description` | 告诉 Claude 什么时候应该使用这个子代理 |
790+
| `prompt` | 子代理自己的系统提示词 / 行为规范 |
791+
| `tools` | 子代理可用工具;省略时继承父级可用工具 |
792+
| `model` | 可用 `sonnet` / `opus` / `haiku` / `inherit` 或完整模型 ID |
793+
| `background` | 是否作为非阻塞后台任务运行 |
794+
| `maxTurns` | 子代理最大 agentic turn 数 |
795+
| `skills` | 明确注入给该子代理的技能列表 |
780796

781797
**常用子代理类型**
782798

@@ -788,9 +804,9 @@ Claude Code CLI 内置了强大的 **Task 工具**,无需写代码就能让 Cl
788804
| `general-purpose` | 通用多步骤任务 | 全部工具 |
789805
| `Plan` | 设计实现方案 | 全部(不含写入) |
790806

791-
**任务依赖(DAG 系统)**
807+
**并行编排方式**
792808

793-
Task 工具支持有向无环图(DAG)依赖关系——任务 C 可以等待任务 A 和任务 B 完成后再执行:
809+
主 Agent 可以一次启动多个适合的子代理。子代理各自拥有独立上下文,只把最终结果返回给父级;如果后续步骤依赖前置结论,把依赖关系写进父级 prompt,让父级在收到结果后再继续分配下一步。
794810

795811
```
796812
任务A: 构建API ──┐
@@ -804,7 +820,7 @@ Task 工具支持有向无环图(DAG)依赖关系——任务 C 可以等待
804820

805821
1. **Skills 注入**:在定义中指定 skills 字段,完整技能内容直接注入子代理
806822
2. **Memory 持久化**:子代理可拥有持久记忆目录,跨会话积累知识
807-
3. **工具访问控制**:通过 `allowedTools` / `disallowedTools` 精细控制子代理能力
823+
3. **工具访问控制**:通过 `tools` / `disallowedTools` 精细控制子代理能力
808824

809825
> 💡 **提示**:子代理不能再创建子代理(只有一层嵌套),最多可同时运行 10 个并行子代理。
810826
@@ -1352,7 +1368,7 @@ review_options = ClaudeAgentOptions(
13521368

13531369
# 完全权限Agent - 可以做任何事
13541370
full_options = ClaudeAgentOptions(
1355-
allowed_tools=['Read', 'Write', 'Edit', 'Bash', 'Glob', 'Grep', 'Task'],
1371+
allowed_tools=['Read', 'Write', 'Edit', 'Bash', 'Glob', 'Grep', 'Agent'],
13561372
permission_mode='acceptEdits'
13571373
)
13581374
```
@@ -1589,13 +1605,13 @@ options = ClaudeAgentOptions(
15891605

15901606
### Q4: 子代理和主代理怎么通信?
15911607

1592-
****通过Task和TaskOutput工具
1608+
****通过 `Agent` 工具调用与最终结果回传
15931609

1594-
1. 主Agent用Task工具创建子代理,指定任务
1610+
1. 主 Agent 通过 `Agent` 工具创建/调用子代理,指定任务
15951611
2. 子代理执行任务并返回结果
1596-
3. 主Agent用TaskOutput工具获取结果
1612+
3. 主 Agent 收到子代理最终消息,作为后续汇总或下一步决策的输入
15971613

1598-
子代理完成后,结果会自动返回给主Agent
1614+
子代理运行在独立上下文里,父级不会自动继承它读过的所有文件和中间工具结果;需要保留的信息应让子代理在最终回复里明确写出来
15991615

16001616
---
16011617

@@ -1650,16 +1666,16 @@ async for message in query(prompt="...", options=options):
16501666

16511667
****
16521668

1653-
1. **使用后台运行的子代理**Task工具支持`run_in_background`
1669+
1. **使用后台运行的子代理**`AgentDefinition` 中设置 `background=True`
16541670
2. **设置合理的超时**
16551671
3. **使用异步并行**
16561672

16571673
```python
16581674
prompt = """请使用子代理并行处理:
1659-
- 子代理1:分析src目录(run_in_background: true)
1660-
- 子代理2:分析tests目录(run_in_background: true)
1675+
- 子代理1:分析src目录
1676+
- 子代理2:分析tests目录
16611677
1662-
启动后等待所有子代理完成再汇总"""
1678+
如果这些子代理被配置为 background=True,请持续跟踪它们的最终结果后再汇总"""
16631679
```
16641680

16651681
---

docs/openclaw/01-OpenClaw项目介绍.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -869,6 +869,7 @@ OpenClaw 的设计哲学很明确:**它是一个个人助手,不是企业平
869869
| CLI Reference | docs.openclaw.ai/cli | 官方 CLI 参考 |
870870
| Discord 社区 | discord.gg/clawd | 实时问答 |
871871
| DeepWiki | deepwiki.com/openclaw/openclaw | AI 生成的代码文档 |
872+
| SkillClaw | https://github.com/AMAP-ML/SkillClaw | 长期 skill 库治理与集体演化框架,适合研究多用户、多设备场景下的 skill 去重、合并、提质和共享;论文见 https://arxiv.org/abs/2604.08377 |
872873
| 本系列教程 | 你正在读的这个 | 中文完整指南 |
873874

874875
## 快速体验

0 commit comments

Comments
 (0)