Skip to content

Commit 3845580

Browse files
Update README.zh.md
Added research mode section with workflows and tools.
1 parent 1061ceb commit 3845580

1 file changed

Lines changed: 130 additions & 2 deletions

File tree

README.zh.md

Lines changed: 130 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
<a href="#快速开始">快速开始</a> •
3030
<a href="#为什么选择-clawcode">为什么选择 ClawCode</a> •
3131
<a href="#核心特性">核心特性</a> •
32+
<a href="#研究模式">研究模式</a> •
3233
<a href="#文档">文档</a> •
3334
<a href="#贡献">贡献</a>
3435
</p>
@@ -94,6 +95,24 @@ ClawCode 内置 **ECAP**(经验胶囊)和 **TECAP**(团队经验胶囊)
9495
/clawteam --deep_loop "设计微服务架构" # 收敛式迭代
9596
```
9697

98+
### 🔬 研究模式(`clawcode research`
99+
100+
多阶段调查研究工作流,支持工具支持的证据收集:
101+
102+
| 工作流 | 用途 |
103+
|--------|------|
104+
| `deepresearch` | 模板驱动:计划 → 研究 → 验证 → 交付 |
105+
| `peerreview` | 带验证的批判性审查 |
106+
| `lit` | 文献综述 |
107+
| `audit` | 审查 URL/仓库/产物 |
108+
109+
**研究工具:** `research_web_search`(Firecrawl/Tavily/Parallel)、`research_paper_search`(arXiv/Semantic Scholar)、`research_fetch_url``research_sandbox_exec``research_code_audit`
110+
111+
```bash
112+
clawcode research start "量子纠错" --workflow deepresearch -o ./outputs/qec
113+
clawcode research list-prompts # 查看可用模板
114+
```
115+
97116
### 🔧 44 个内置工具
98117

99118
| 类别 | 示例 |
@@ -103,6 +122,7 @@ ClawCode 内置 **ECAP**(经验胶囊)和 **TECAP**(团队经验胶囊)
103122
| 浏览器 | `browser_*`(×11 自动化工具) |
104123
| 代理 | 隔离的子代理生成 |
105124
| 集成 | MCP、Sourcegraph、桌面自动化 |
125+
| 研究 | `research_*`(网页、论文、审计) |
106126

107127

108128
### 🔄 兼容 Claude Code
@@ -111,15 +131,49 @@ ClawCode 内置 **ECAP**(经验胶囊)和 **TECAP**(团队经验胶囊)
111131

112132
## 快速开始
113133

134+
### 1. 安装
135+
114136
```bash
115137
cd clawcode
116138
python -m venv .venv
117139
.\.venv\Scripts\Activate.ps1 # Windows
118140
pip install -e ".[dev]"
119-
clawcode -c "/path/to/project"
120141
```
121142

122-
**前置要求:** Python >=3.12,至少一个 LLM 提供商的凭证。
143+
**前置要求:** Python >=3.12
144+
145+
### 2. 配置
146+
147+
在项目根目录创建 `.clawcode.json`
148+
149+
```json
150+
{
151+
"providers": {
152+
"openai": {
153+
"api_key": "sk-...",
154+
"disabled": false
155+
}
156+
},
157+
"agents": {
158+
"coder": {
159+
"model": "gpt-4o",
160+
"provider_key": "openai"
161+
}
162+
}
163+
}
164+
```
165+
166+
或使用环境变量:
167+
```bash
168+
export CLAWCODE_OPENAI__API_KEY="sk-..."
169+
```
170+
171+
### 3. 运行
172+
173+
```bash
174+
clawcode -c "/path/to/project" # 交互式 TUI
175+
clawcode -p "重构这个 API" # 非交互式
176+
```
123177

124178
## 文档
125179

@@ -131,6 +185,80 @@ clawcode -c "/path/to/project"
131185
| 斜杠命令参考 | [docs/slash-commands.md](docs/slash-commands.md) / [docs/slash-commands.zh.md](docs/slash-commands.zh.md) |
132186
| 配置指南 | [docs/clawcode-configuration.md](docs/clawcode-configuration.md) |
133187
| 性能与测试 | [docs/clawcode-performance.md](docs/clawcode-performance.md) / [docs/clawcode-performance.zh.md](docs/clawcode-performance.zh.md) |
188+
| 研究模式 | [docs/research_mode.md](docs/research_mode.md) |
189+
190+
---
191+
192+
## 研究模式
193+
194+
ClawCode 包含独立的 **research** 子命令,用于多阶段调查研究工作流,支持工具支持的证据收集。
195+
196+
### 工作流
197+
198+
| 工作流 | 命令 | 描述 |
199+
|--------|------|------|
200+
| `deepresearch` | `clawcode research start "主题" -w deepresearch` | 4阶段模板:计划 → 研究 → 验证 → 交付 |
201+
| `peerreview` | `clawcode research start "主题" -w peerreview` | 批判性审查:审查 → 验证 → 交付 |
202+
| `lit` | `clawcode research start "主题" -w lit` | 文献综述 |
203+
| `audit` | `clawcode research audit <url>` | 审查 URL/仓库/产物 |
204+
| `compare` | `clawcode research start "主题" -w compare` | 并排对比 |
205+
206+
### 研究工具
207+
208+
- `research_web_search` — 网页搜索,支持 Firecrawl/Tavily/Parallel(DuckDuckGo 降级)
209+
- `research_paper_search` — arXiv + 可选 Semantic Scholar
210+
- `research_fetch_url` — 获取并提取页面内容
211+
- `research_sandbox_exec` — 在沙箱中执行 Shell
212+
- `research_code_audit` — 对比声明与仓库代码
213+
214+
### 快速示例
215+
216+
```bash
217+
# 带 Markdown 模板阶段的深度研究
218+
clawcode research start "量子纠错" --workflow deepresearch -o ./outputs/qec
219+
220+
# 同行评审提案
221+
clawcode research start "评审:LLM 缩放定律" --workflow peerreview -o ./outputs/review
222+
223+
# 审计仓库
224+
clawcode research audit https://github.com/example/repo -o ./outputs/audit
225+
226+
# 列出可用模板
227+
clawcode research list-prompts
228+
229+
# 验证配置而不调用 LLM
230+
clawcode research start "测试" --dry-run
231+
```
232+
233+
### 配置
234+
235+
`.clawcode.json` 中添加:
236+
237+
```json
238+
{
239+
"web": {
240+
"backend": "firecrawl",
241+
"firecrawl_api_key": "YOUR_KEY",
242+
"tavily_api_key": "YOUR_KEY",
243+
"parallel_api_key": ""
244+
},
245+
"research": {
246+
"enabled": true,
247+
"s2_api_key": "YOUR_SEMANTIC_SCHOLAR_KEY",
248+
"subagents": { "max_concurrent": 3 }
249+
}
250+
}
251+
```
252+
253+
**可选的 API 密钥:**
254+
- [Firecrawl](https://firecrawl.dev) — 增强的网页搜索/提取
255+
- [Tavily](https://tavily.com) — 研究优化的搜索
256+
- [Parallel](https://parallel.ai) — 替代搜索后端
257+
- [Semantic Scholar](https://www.semanticscholar.org/product/api) — 论文更高限流
258+
259+
无需 API 密钥时,研究功能将降级到 DuckDuckGo(网页)和 arXiv(论文,无需密钥)。
260+
261+
---
134262

135263
## 测试结果
136264

0 commit comments

Comments
 (0)