跳转到内容
展示 生态 文档

CLI 参考

命令速查

命令用途
opencode tui启动终端用户界面
opencode run程序化执行提示
opencode serve启动无头后端服务器
opencode web启动带 Web 界面的后端服务器
opencode attach连接到运行中的后端服务器
opencode auth管理 AI Provider 凭据
opencode models列出可用的 AI 模型
opencode session管理对话会话
opencode github管理 GitHub 代理
opencode pr获取并检出 GitHub PR
opencode export导出对话数据
opencode import导入数据
opencode stats显示使用统计
opencode init初始化项目并创建 AGENTS.md

核心交互命令

opencode tui

启动 OpenCode 终端用户界面（Terminal User Interface）。这是不带任何参数运行 opencode 时的默认行为。

语法

opencode tui [options]

示例

# 在当前目录启动 TUI
opencode tui

# 启动 TUI（默认行为）
opencode

适用场景

  • 交互式开发：通过 AI 辅助完成日常编码任务
  • 项目探索：导航和理解陌生的代码库
  • 实时协作：与 AI 共同解决复杂问题

opencode run

程序化执行提示，无需进入 TUI。适用于脚本和自动化场景。

语法

opencode run "<prompt>" [options]

示例

# 执行单个提示
opencode run "Explain how closures work in JavaScript"

# 使用特定模型
opencode run "Refactor this function" --model anthropic/claude-3.5-sonnet

# 继续上一个会话
opencode run "Continue the refactoring" --continue

适用场景

  • CI/CD 集成：自动化代码审查和建议
  • 批量处理：在脚本中处理多个提示
  • 快速查询：无需打开 TUI 即可获得即时答案

opencode serve

启动无头 OpenCode 后端服务器，提供 API 访问，无需终端界面。

语法

opencode serve [options]

示例

# 启动后端服务器
opencode serve

# 在自定义端口启动服务器
opencode serve --port 4096

适用场景

  • 远程访问：在服务器上运行 OpenCode，从客户端连接
  • 团队协作：共享单个 OpenCode 实例
  • 集成开发：构建自定义前端或工具

opencode web

启动带 Web 界面的后端服务器，允许通过浏览器访问 OpenCode。

语法

opencode web [options]

选项

选项描述
--port监听端口（默认值因情况而异）
--hostname绑定的主机名

示例

# 启动 Web 服务器
opencode web

# 在特定端口和主机名上启动
opencode web --port 4096 --hostname 0.0.0.0

# 允许外部访问
opencode web --hostname 0.0.0.0

适用场景

  • 移动访问：从平板或手机使用 OpenCode
  • 浏览器偏好：在 Web UI 而非终端中工作
  • 屏幕共享：结对编程时更易于共享

opencode attach

连接到已运行的 OpenCode 后端服务器（通过 serve 或 web 启动）。

语法

opencode attach [url] [options]

选项

选项描述
--dirTUI 启动时的工作目录
--session, -s要继续的会话 ID

示例

# 连接到远程服务器
opencode attach http://10.20.30.40:4096

# 连接并指定工作目录
opencode attach http://server:4096 --dir /path/to/project

# 连接并继续特定会话
opencode attach http://server:4096 --session abc123

适用场景

  • 远程开发：连接到运行在强大服务器上的 OpenCode
  • 会话共享：多个用户连接到同一后端
  • 重新连接：网络中断后恢复工作

认证管理

opencode auth

管理 AI Provider 的凭据和认证。

语法

opencode auth [command]

子命令

opencode auth login

为 Models.dev 支持的 AI Provider 配置 API 密钥。凭据存储在 ~/.local/share/opencode/auth.json。

示例

# 启动交互式认证
opencode auth login

# 对特定 Provider 进行认证
opencode auth login --provider anthropic

适用场景

  • 初始设置：首次使用时配置 OpenCode
  • 切换 Provider：添加新的 AI Provider 凭据
  • 密钥轮换：出于安全考虑更新 API 密钥

模型管理

opencode models

列出已配置 Provider 的所有可用模型。模型以 provider/model 格式显示。

语法

opencode models [provider]

示例

# 列出所有可用模型
opencode models

# 列出特定 Provider 的模型
opencode models anthropic

# 结合 grep 进行过滤
opencode models | grep claude

适用场景

  • 模型发现：为您的用例查找可用模型
  • Provider 比较：了解各 Provider 提供的模型
  • 配置参考：获取配置文件所需的准确模型名称

会话管理

opencode session

管理对话会话。

语法

opencode session [command]

适用场景

  • 会话历史：查看过往对话
  • 上下文切换：在不同项目间跳转
  • 会话清理：归档或删除旧会话

GitHub 集成

opencode github

管理 OpenCode 的 GitHub 代理，实现 AI 驱动的 GitHub 工作流自动化。

语法

opencode github [command]

子命令

opencode github install

为您的仓库或组织安装和配置 GitHub 代理。

示例

# 安装 GitHub 代理
opencode github install

适用场景

  • 仓库自动化：为 GitHub 工作流设置 AI 辅助
  • 团队入职：为团队启用 AI 代码审查
  • CI/CD 集成：将 OpenCode 集成到 GitHub Actions

opencode github run

运行 GitHub 代理以处理事件和自动化任务。

示例

# 运行 GitHub 代理
opencode github run

适用场景

  • 自动化审查：通过 AI 辅助处理拉取请求
  • Issue 分类：自动分析和分类 Issue
  • 持续辅助：保持代理运行以处理持续任务

opencode pr

获取并检出 GitHub 拉取请求分支，然后在该上下文中启动 OpenCode。这简化了代码审查工作流。

语法

opencode pr <number> [options]

示例

# 检出 PR #42 并启动 OpenCode
opencode pr 42

# 使用特定模型审查 PR
opencode pr 123 --model anthropic/claude-3.5-sonnet

适用场景

  • 代码审查：快速进入 PR 上下文进行审查
  • PR 辅助：获取 AI 帮助理解变更
  • 协作：在评论前与 AI 讨论 PR 变更

项目初始化

opencode init

通过创建或更新 AGENTS.md 文件来初始化项目，帮助 OpenCode 理解您的项目结构。

语法

opencode init

示例

# 初始化当前项目
opencode init

# 在 TUI 中运行
/init

适用场景

  • 新项目：为新代码库设置 OpenCode
  • 项目更新：结构变化时更新 AGENTS.md
  • 上下文优化：帮助 AI 更好地理解您的项目

数据操作

opencode export

导出对话数据。

语法

opencode export [options]

适用场景

  • 文档记录：保存对话以供参考
  • 备份：归档重要的交互记录
  • 共享：导出对话与同事分享

opencode import

导入数据到 OpenCode。

语法

opencode import [options]

适用场景

  • 迁移：在 OpenCode 实例间移动数据
  • 恢复：从备份恢复
  • 团队同步：导入共享的对话历史

opencode stats

显示使用统计信息。

语法

opencode stats

适用场景

  • 成本追踪：监控 API 使用和成本
  • 使用分析：了解您的交互模式
  • 预算管理：保持在支出限额内

全局标志

这些标志可与大多数 OpenCode 命令配合使用，以修改其行为。

标志短标志描述
--continue-c从上一个会话继续
--session-s指定要继续的会话 ID
--prompt-定义要使用的提示
--model-m指定模型（格式：provider/model）
--agent-指定要使用的代理
--port-定义监听端口
--hostname-定义监听主机名

示例

# 继续上一个会话
opencode --continue

# 使用特定模型
opencode run "Explain this code" --model anthropic/claude-3.5-sonnet

# 在自定义端口启动
opencode web --port 8080