# oc-docs

**Repository Path**: gabrielslls/oc-docs

## Basic Information

- **Project Name**: oc-docs
- **Description**: A comprehensive, source-code-driven command reference manual for OpenCode TUI.
- **Primary Language**: Shell
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-24
- **Last Updated**: 2026-04-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenCode TUI 命令文档

> 基于OpenCode TUI源代码分析的完整命令参考手册

## 📖 项目简介

本项目对OpenCode TUI的命令进行完整文档化，基于**实际源代码分析**，而非可能过时的官方文档。

### 为什么做这个项目？

OpenCode TUI有丰富的命令（斜杠命令70+个，工具命令30+个），但官方文档更新不及时。本项目通过分析源代码，为每个命令提供准确、详细的说明。

### 项目特点

- ✅ **准确可靠** - 直接分析源代码模板
- ✅ **详细完整** - 包含工作流程、使用场景、决策树
- ✅ **持续更新** - 提供更新指南，可随时从源码同步
- ✅ **实用导向** - 按使用频率分类，提供实际示例

## 📚 文档体系

本项目提供三个层次的文档：

### 1. 🎯 简洁版（日常使用）

**文件**：`OPENCODE_COMMANDS_SIMPLE.md`

**用途**：快速查找命令

**特点**：
- 简洁明了
- 按使用频率分类
- 适合日常参考

```bash
# 查看简洁版
cat OPENCODE_COMMANDS_SIMPLE.md
```

### 2. 📖 详细版（深入学习）

**文件**：`COMMANDS_DETAILED.md`

**用途**：理解命令原理

**特点**：
- 每个命令的完整工作流程
- 6个阶段的详细说明
- 实际使用示例和决策树

```bash
# 查看详细版
cat COMMANDS_DETAILED.md
```

### 3. 🤖 详细参考（更新用）

**目录**：`commands/all-commands/`

**用途**：更新文档时参考

**包含**：
- Ctrl+P命令完整列表
- 斜杠命令完整列表
- oh-my-opencode命令模板

## 🚀 快速开始

### 查看简洁命令列表

```bash
cat OPENCODE_COMMANDS_SIMPLE.md
```

### 学习详细用法

```bash
cat COMMANDS_DETAILED.md
```

### 搜索特定命令

```bash
# 搜索特定命令
grep -A 20 "## /refactor" COMMANDS_DETAILED.md

# 搜索所有斜杠命令
grep "^## /" COMMANDS_DETAILED.md

# 搜索Ctrl+P命令
grep -i "session\|prompt\|toggle" OPENCODE_COMMANDS_SIMPLE.md
```

## 📋 命令速查

### 🎯 最高频使用（每天）

| 命令 | 用途 | 文档章节 |
|------|------|----------|
| `/start-work` | 启动结构化工作会话 | [查看](./COMMANDS_DETAILED.md#start-work) |
| `/refactor` | 智能代码重构 | [查看](./COMMANDS_DETAILED.md#refactor) |

### 📝 经常使用

| 命令 | 用途 | 文档章节 |
|------|------|----------|
| `/ralph-loop` | 持续开发循环 | [查看](./COMMANDS_DETAILED.md#ralph-loop) |
| `/init-deep` | 初始化知识库 | [查看](./COMMANDS_DETAILED.md#init-deep) |

### 🔧 偶尔使用

| 命令 | 用途 | 文档章节 |
|------|------|----------|
| `/ulw-loop` | UltraWork循环 | [查看](./COMMANDS_DETAILED.md#ulw-loop) |
| `/handoff` | 会话交接 | [查看](./COMMANDS_DETAILED.md#handoff) |
| `/cancel-ralph` | 取消循环 | [查看](./COMMANDS_DETAILED.md#cancel-ralph) |
| `/stop-continuation` | 停止继续 | [查看](./COMMANDS_DETAILED.md#stop-continuation) |

## 📁 项目结构

```
opencode-docs/
├── README.md                      # 本文件
├── OPENCODE_COMMANDS_SIMPLE.md   # 简洁版（推荐日常使用）
├── COMMANDS_DETAILED.md           # 详细版（推荐深入学习）
├── quick-reference.md             # 快速参考
├── LICENSE                       # MIT许可证
├── .gitignore                    # Git忽略配置
└── commands/
    └── all-commands/             # 详细参考（供更新使用）
        ├── CTRLP-COMMANDS.md      # Ctrl+P命令详细版
        ├── SLASH-COMMANDS.md      # 斜杠命令详细版
        └── README.md              # 工具命令参考
```

## 🔄 更新文档

本项目致力于保持与OpenCode TUI源代码同步。你可以使用内置的自动化工具进行更新。

### 使用自动化脚本更新

我们提供了一个 `extract.sh` 脚本，可以自动从源代码中提取最新的命令定义。

#### 1. 准备工作
确保本地有 OpenCode TUI 的源代码：
```bash
git clone https://github.com/opencode-ai/opencode.git /tmp/opencode-repo
```

#### 2. 运行提取脚本
在本项目根目录下运行：
```bash
chmod +x extract.sh
./extract.sh /tmp/opencode-repo
```

#### 3. 审查并合并
脚本会将原始提取结果存放在 `commands/all-commands/` 目录下。请手动审查这些变更并更新对应的 Markdown 文档。

### 手动参考位置

| 命令类型 | 位置 |
|----------|------|
| 斜杠命令(TUI) | `/tmp/opencode-repo/packages/opencode/src/cli/cmd/tui/` |
| Ctrl+P命令 | 同上各个组件的 `title:` 定义 |
| 工具命令(SDK) | `~/.cache/opencode/node_modules/@opencode-ai/sdk/dist/v2/gen/` |
| 内置命令(oh-my-opencode) | `~/.cache/opencode/node_modules/oh-my-opencode/dist/` |
| 命令模板 | `~/.cache/opencode/node_modules/oh-my-opencode/dist/features/builtin-commands/templates/` |

## 📊 命令统计

### 斜杠命令（20个）

**来源1 - TUI组件（12个）：**
- 会话管理：`/share`, `/rename`, `/timeline`, `/fork`, `/compact`, `/unshare`, `/undo`, `/redo`, `/copy`, `/export`
- 显示控制：`/timestamps`, `/thinking`

**来源2 - oh-my-opencode插件（8个）：**
- 工作流程：`/start-work`, `/refactor`, `/ralph-loop`, `/ulw-loop`, `/init-deep`
- 辅助命令：`/handoff`, `/cancel-ralph`, `/stop-continuation`

### Ctrl+P命令（60+个）

分类：
- 会话路由命令（30+个）
- 应用路由命令（20+个）
- 提示符组件命令（9个）

### 内置工具（25+个）

分类：
- 文件操作（7个）
- LSP工具（6个）
- 会话管理（4个）
- 后台任务（3个）
- Web搜索（3个）
- 其他（5+个）

### 代理（7个）
- explore, librarian, oracle, hephaestus, metis, momus, multimodal-looker

### 技能（5个）
- playwright, dev-browser, frontend-ui-ux, git-master, agent-browser

### 分类（8个）
- visual-engineering, ultrabrain, deep, artistry, quick, unspecified-low, unspecified-high, writing

## 🛠️ 使用建议

### 选择命令的决策树

```
我有一个任务要完成
  ↓
是简单任务吗？
  ├── 是 → 直接工作，或用 /start-work 组织
  └── 否，需要重构？
        ├── 是 → /refactor [重构目标]
        └── 否，需要持续迭代？
              ├── 是 → /ralph-loop [任务]
              └── 否，需要强大模型？
                    ├── 是 → /ulw-loop [任务]
                    └── 否 → /start-work 开始工作
```

### 按使用频率排序

**每天使用**：
1. `/start-work` - 几乎每次开始工作都用
2. `/refactor` - 重构代码时常用

**经常使用**：
3. `/ralph-loop` - 复杂任务时使用
4. `/init-deep` - 项目结构变更时使用

**偶尔使用**：
5. `/ulw-loop` - 极复杂任务时使用
6. `/handoff` - 会话太长时使用
7. `/cancel-ralph` - 需要取消循环时
8. `/stop-continuation` - 需要完全控制时

## 📦 版本信息

- **当前版本**：v1.1.0
- **上次更新**：2026-03-07
- **基于版本**：OpenCode TUI v1.2.20
- **oh-my-opencode**：最新版

## 📄 许可证

本项目采用 MIT License - 详见 LICENSE 文件

## 🤝 贡献

我们非常欢迎社区贡献！请参阅 [CONTRIBUTING.md](./CONTRIBUTING.md) 了解如何参与。

你可以通过以下方式贡献：
- 报告文档中的错误或过时信息
- 提交 Pull Request 完善命令说明
- 补充实际应用案例和决策树
- 改进自动化提取脚本

## 📞 联系与支持

- **GitHub 项目主页**：[oc-docs](https://github.com/gabrielslls/oc-docs)
- **问题反馈**：请提交 GitHub Issues
- **数据来源**：基于 OpenCode TUI 及 oh-my-opencode 源代码分析

---

**使用建议**：

1. **新手**：先看`OPENCODE_COMMANDS_SIMPLE.md`，再深入`COMMANDS_DETAILED.md`
2. **日常使用**：`OPENCODE_COMMANDS_SIMPLE.md`足够
3. **深入学习**：`COMMANDS_DETAILED.md`包含所有细节
4. **更新文档**：参考`commands/all-commands/`和`COMMANDS_DETAILED.md`中的更新指南

---

*本项目基于OpenCode TUI源代码分析生成，旨在提供准确、实用的命令参考。*