Skip to content

Commit 84fe3d7

Browse files
author
Sisyphus Agent
committed
docs: add OpenCode CLI 使用文档
- 添加完整的 CLI 使用指南文档 - 包含客户端初始化、验证、会话管理等 8 个模块 - 包含改进计划和 README 文档
1 parent 7e3b51b commit 84fe3d7

File tree

10 files changed

+7595
-0
lines changed

10 files changed

+7595
-0
lines changed

docs/oho-cli-usage/01-client-initialization.md

Lines changed: 474 additions & 0 deletions
Large diffs are not rendered by default.

docs/oho-cli-usage/02-validation.md

Lines changed: 550 additions & 0 deletions
Large diffs are not rendered by default.

docs/oho-cli-usage/03-check-session.md

Lines changed: 798 additions & 0 deletions
Large diffs are not rendered by default.

docs/oho-cli-usage/04-create-workspace.md

Lines changed: 934 additions & 0 deletions
Large diffs are not rendered by default.

docs/oho-cli-usage/05-submit-task.md

Lines changed: 1147 additions & 0 deletions
Large diffs are not rendered by default.

docs/oho-cli-usage/06-send-message.md

Lines changed: 1559 additions & 0 deletions
Large diffs are not rendered by default.

docs/oho-cli-usage/07-interrupt-task.md

Lines changed: 804 additions & 0 deletions
Large diffs are not rendered by default.

docs/oho-cli-usage/08-query-status.md

Lines changed: 994 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# oho CLI 文档完善计划
2+
3+
**目标**: 补充完整命令示例、预期输出、文档结构优化
4+
5+
**完成标准**:
6+
- [ ] 每个模块包含至少 5 个完整命令示例
7+
- [ ] 每个命令都有预期输出示例
8+
- [ ] 文档结构统一(目录、章节、格式)
9+
- [ ] 添加实际运行截图(可选)
10+
- [ ] 添加常见问题解答 (FAQ)
11+
12+
---
13+
14+
## 完善进度
15+
16+
### 模块 1: 客户端初始化 ✅
17+
- [x] 认证配置 - 完整命令 + 输出
18+
- [x] 服务器连接 - 完整命令 + 输出
19+
- [x] 配置管理 - 完整命令 + 输出
20+
- [x] 连接验证 - 完整命令 + 输出
21+
- [x] 常见问题 - 5 个 FAQ
22+
23+
### 模块 2: 验证 ✅
24+
- [x] 权限请求响应 - 完整命令 + 输出
25+
- [x] 会话验证 - 完整命令 + 输出
26+
27+
### 模块 3: 检查 Session ✅
28+
- [x] 会话列表查询 - 完整命令 + 输出
29+
- [x] 详情获取 - 完整命令 + 输出
30+
- [x] 状态监控 - 完整命令 + 输出
31+
- [x] 子会话管理 - 完整命令 + 输出
32+
- [x] 过滤搜索 - 完整命令 + 输出
33+
- [x] 导出分享 - 完整命令 + 输出
34+
35+
### 模块 4: 新建工作区 ✅
36+
- [x] 创建工作区 - 完整命令 + 输出
37+
- [x] 管理项目 - 完整命令 + 输出
38+
- [x] 工作区配置 - 完整命令 + 输出
39+
40+
### 模块 5: 指定工作区提交任务 ✅
41+
- [x] 任务提交概述 - 完整命令 + 输出
42+
- [x] 向工作区发送消息 - 完整命令 + 输出
43+
- [x] 指定会话提交任务 - 完整命令 + 输出
44+
- [x] 任务参数配置 - 完整命令 + 输出
45+
- [x] 文件附件支持 - 完整命令 + 输出
46+
- [x] 异步任务提交 - 完整命令 + 输出
47+
- [x] 批量任务提交 - 完整命令 + 输出
48+
49+
### 模块 6: 指定 session_id 和模型发消息 ✅
50+
- [x] 会话 ID 管理 - 完整命令 + 输出
51+
- [x] 模型选择与配置 - 完整命令 + 输出
52+
- [x] 精确控制会话和模型 - 完整命令 + 输出
53+
- [x] 模型参数调优 - 完整命令 + 输出
54+
- [x] 会话与模型组合策略 - 完整命令 + 输出
55+
56+
### 模块 7: 中断任务 ✅
57+
- [x] 中止正在运行的会话 - 完整命令 + 输出
58+
- [x] 检查会话状态 - 完整命令 + 输出
59+
- [x] 中断后恢复 - 完整命令 + 输出
60+
- [x] 批量中断管理 - 完整命令 + 输出
61+
62+
### 模块 8: 查询任务执行情况及状态 ✅
63+
- [x] 查看会话详情 - 完整命令 + 输出
64+
- [x] 消息历史查询 - 完整命令 + 输出
65+
- [x] 待办事项追踪 - 完整命令 + 输出
66+
- [x] 任务进度监控 - 完整命令 + 输出
67+
- [x] 会话总结与导出 - 完整命令 + 输出
68+
69+
---
70+
71+
## 待补充内容
72+
73+
### 通用改进
74+
- [ ] 统一代码块格式(bash、json)
75+
- [ ] 添加命令说明注释
76+
- [ ] 补充错误输出示例
77+
- [ ] 添加性能提示
78+
- [ ] 补充最佳实践
79+
80+
### 实际输出验证
81+
- [ ] 模块 1: 验证 `oho config get` 实际输出
82+
- [ ] 模块 2: 验证 `oho session permissions` 实际输出
83+
- [ ] 模块 3: 验证 `oho session list` 实际输出
84+
- [ ] 模块 4: 验证 `oho session create` 实际输出
85+
- [ ] 模块 5: 验证 `oho message add` 实际输出
86+
- [ ] 模块 6: 验证 `oho config providers` 实际输出
87+
- [ ] 模块 7: 验证 `oho session abort` 实际输出
88+
- [ ] 模块 8: 验证 `oho session todo` 实际输出
89+
90+
---
91+
92+
## 执行策略
93+
94+
1. **分模块完善**: 每次 Heartbeat 完善 1-2 个模块
95+
2. **实际验证**: 使用 oho CLI 实际运行命令,记录真实输出
96+
3. **持续改进**: 根据用户反馈调整文档内容
97+
4. **版本追踪**: 记录文档更新历史和 oho CLI 版本
98+
99+
---
100+
101+
**下次执行**: 补充模块 1-2 的实际输出验证
102+
**负责人**: nanobot 🐈
103+
**优先级**: HIGH

docs/oho-cli-usage/README.md

Lines changed: 232 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,232 @@
1+
# oho CLI 操作指南
2+
3+
> **完整教程**: 从入门到精通
4+
> **适用版本**: oho CLI v1.0+
5+
> **最后更新**: 2026-03-03
6+
> **状态**: 🟡 进行中(持续完善中)
7+
8+
---
9+
10+
## 📚 教程目录
11+
12+
本教程共 8 个模块,涵盖 oho CLI 的核心功能:
13+
14+
| 模块 | 主题 | 文件 | 状态 |
15+
|------|------|------|------|
16+
| 1 | 客户端初始化 | [01-client-initialization.md](./01-client-initialization.md) | ✅ 已完成 |
17+
| 2 | 验证 | [02-validation.md](./02-validation.md) | ✅ 已完成 |
18+
| 3 | 检查 Session | [03-check-session.md](./03-check-session.md) | ✅ 已完成 |
19+
| 4 | 新建工作区 | [04-create-workspace.md](./04-create-workspace.md) | ✅ 已完成 |
20+
| 5 | 指定工作区提交任务 | [05-submit-task.md](./05-submit-task.md) | ✅ 已完成 |
21+
| 6 | 指定 session_id 和模型发消息 | [06-send-message.md](./06-send-message.md) | ✅ 已完成 |
22+
| 7 | 中断任务 | [07-interrupt-task.md](./07-interrupt-task.md) | ✅ 已完成 |
23+
| 8 | 查询任务执行情况及状态 | [08-query-status.md](./08-query-status.md) | ✅ 已完成 |
24+
25+
**总体进度**: 8/8 模块创建完成 (100%) 🎉
26+
**完善进度**: 🟡 持续完善中(补充实际输出示例、命令验证)
27+
28+
---
29+
30+
## 🔧 持续完善计划
31+
32+
**当前任务**: 补充完整命令示例、预期输出、文档结构优化
33+
34+
**完善内容**:
35+
- [🔧] 完整命令示例 (持续补充)
36+
- [🔧] 预期输出示例 (持续补充)
37+
- [🔧] 文档结构优化 (持续改进)
38+
- [🔧] 实际运行验证 (持续进行)
39+
40+
**完善计划文档**: [IMPROVEMENT_PLAN.md](./IMPROVEMENT_PLAN.md)
41+
42+
**下次执行**: 补充模块 1-2 的实际输出验证
43+
44+
---
45+
46+
## 🚀 快速开始
47+
48+
### 前置要求
49+
50+
- ✅ 已安装 oho CLI (`/usr/local/bin/oho`)
51+
- ✅ OpenCode Server 正在运行
52+
- ✅ 已配置服务器密码
53+
54+
### 5 分钟上手
55+
56+
```bash
57+
# 1. 设置认证
58+
export OPENCODE_SERVER_PASSWORD="your_password"
59+
60+
# 2. 验证连接
61+
oho config get
62+
63+
# 3. 创建会话
64+
SESSION=$(oho session create --json | jq -r '.id')
65+
66+
# 4. 发送消息
67+
oho message add -s "$SESSION" "Hello, World!"
68+
69+
# 5. 查看响应
70+
oho message list -s "$SESSION"
71+
```
72+
73+
---
74+
75+
## 📖 模块详情
76+
77+
### 模块 1: 客户端初始化
78+
79+
**内容**:
80+
- 认证配置 (`oho auth set`)
81+
- 服务器连接参数 (`--host`, `--port`, `--password`)
82+
- 配置管理 (`oho config get/set`)
83+
- 连接验证方法
84+
- 常见问题排查
85+
86+
**适用场景**:
87+
- 首次使用 oho CLI
88+
- 切换服务器环境
89+
- 配置问题诊断
90+
91+
**阅读时间**: 10 分钟
92+
93+
👉 [开始学习](./01-client-initialization.md)
94+
95+
---
96+
97+
### 模块 2: 验证
98+
99+
**计划内容**:
100+
- 身份验证流程
101+
- 权限检查
102+
- Token 管理
103+
- 错误处理
104+
105+
**状态**: ⏳ 待编写
106+
107+
---
108+
109+
### 模块 3: 检查 Session
110+
111+
**计划内容**:
112+
- 查询会话列表 (`oho session list`)
113+
- 获取会话详情 (`oho session get`)
114+
- 查看会话状态 (`oho session status`)
115+
- 子会话管理 (`oho session children`)
116+
117+
**状态**: ⏳ 待编写
118+
119+
---
120+
121+
### 模块 4: 新建工作区
122+
123+
**计划内容**:
124+
- 创建工作区
125+
- 工作区配置
126+
- 工作区切换
127+
- 工作区清理
128+
129+
**状态**: ⏳ 待编写
130+
131+
---
132+
133+
### 模块 5: 指定工作区提交任务
134+
135+
**计划内容**:
136+
- 任务提交方式
137+
- 任务参数配置
138+
- 任务优先级
139+
- 批量任务处理
140+
141+
**状态**: ⏳ 待编写
142+
143+
---
144+
145+
### 模块 6: 指定 session_id 和模型发消息
146+
147+
**计划内容**:
148+
- 发送消息 (`oho message add`)
149+
- 指定模型参数
150+
- 文件上传 (`--file`)
151+
- 异步消息 (`oho message prompt-async`)
152+
153+
**状态**: ⏳ 待编写
154+
155+
---
156+
157+
### 模块 7: 中断任务
158+
159+
**计划内容**:
160+
- 中止任务 (`oho session abort`)
161+
- 任务恢复
162+
- 超时处理
163+
- 优雅中断
164+
165+
**状态**: ⏳ 待编写
166+
167+
---
168+
169+
### 模块 8: 查询任务执行情况及状态
170+
171+
**计划内容**:
172+
- 任务状态查询
173+
- 执行日志查看
174+
- 结果导出
175+
- 性能分析
176+
177+
**状态**: ⏳ 待编写
178+
179+
---
180+
181+
## 🛠️ 常用命令速查
182+
183+
### 会话管理
184+
```bash
185+
oho session create # 创建会话
186+
oho session list # 列出会话
187+
oho session get -s <id> # 获取详情
188+
oho session delete -s <id> # 删除会话
189+
```
190+
191+
### 消息管理
192+
```bash
193+
oho message add -s <id> "msg" # 发送消息
194+
oho message list -s <id> # 查看消息
195+
oho message command -s <id> /help # 执行命令
196+
```
197+
198+
### 配置管理
199+
```bash
200+
oho config get # 查看配置
201+
oho config set --model <name> # 设置模型
202+
oho config providers # 列出模型
203+
```
204+
205+
### 认证管理
206+
```bash
207+
oho auth set # 设置密码
208+
```
209+
210+
---
211+
212+
## 📝 更新日志
213+
214+
### 2026-03-02
215+
- ✅ 创建教程目录结构
216+
- ✅ 完成模块 1: 客户端初始化
217+
- ⏳ 计划编写模块 2-8
218+
219+
---
220+
221+
## 🤝 贡献
222+
223+
欢迎提交 Issue 和 Pull Request 改进文档!
224+
225+
**反馈渠道**:
226+
- GitHub Issues
227+
- Telegram 群组
228+
- 邮件列表
229+
230+
---
231+
232+
*文档由 nanobot 🐈 生成和维护*

0 commit comments

Comments
 (0)