每个命令都接受
--help 以查看完整的选项列表,例如 opencode run --help。部分由服务端支撑的命令接受 --standalone 以运行私有服务器,或 --server <url> 以指向指定服务器;请查看该命令的帮助以了解其支持的选项。run
发送消息并打印回复,而不打开交互界面。
$ opencode run "Explain this repository"
CI
在 CI 中,将提供商的 API 密钥作为 secret 传入,并使用独立模式,以便私有服务器接收它。例如,以下 GitHub Actions 任务会审查已检出的仓库:
name: OpenCode review
on: [pull_request]
jobs:
review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: npm install --global @opencode/cli
- run: opencode run --standalone --model anthropic/claude-sonnet-5-5 "Review this repository for correctness and summarize any issues."
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
选择模型。
$ opencode run --model anthropic/claude-sonnet-5-5 "Refactor parseToken"
继续上一个会话。
$ opencode run --continue "Now handle the expired case"
为脚本输出以换行分隔的 JSON。
$ opencode run --format json "List the TODO comments"
将文件附加到消息中。
$ opencode run --file src/server.ts --file src/client.ts "Review these for bugs"
使用指定智能体运行。
$ opencode run --agent build "Fix the failing test"
继续指定会话。
$ opencode run --session ses_4f2a1c "Check edge cases"
自动批准未被显式拒绝的权限。
$ opencode run --auto "Fix the failing test"
查看所有子命令与选项。
$ opencode run --help
mini
启动精简交互界面,而非全屏 TUI。
$ opencode mini
继续上一个会话。
$ opencode mini --continue
以指定模型和初始提示启动。
$ opencode mini --model anthropic/claude-sonnet-5-5 --prompt "Summarize this repository"
继续指定会话。
$ opencode mini --session ses_4f2a1c
查看所有子命令与选项。
$ opencode mini --help
session
管理会话。
$ opencode session list
限制列表条数并输出 JSON。
$ opencode session list --max-count 20 --format json
删除某个会话及其子会话。
$ opencode session delete ses_9c1b08
将会话数据导出为 JSON。
$ opencode session export ses_4f2a1c
导出时对敏感的对话记录与文件数据进行脱敏。
$ opencode session export ses_4f2a1c --sanitize
从 JSON 文件或 URL 导入会话数据。
$ opencode session import session.json
导入到指定目录。
$ opencode session import session.json --directory ~/code/project
查看所有子命令与选项。
$ opencode session --help
auth
管理 AI 提供商与凭据。
$ opencode auth list
以 JSON 形式列出。
$ opencode auth list --format json
登录到提供商。
$ opencode auth login anthropic
使用指定的认证方式登录。
$ opencode auth login anthropic --method key
登出已保存的账户。
$ opencode auth logout anthropic work
切换某集成的当前活动账户。
$ opencode auth switch anthropic work
导出已保存的凭据,并在另一台机器上导入。该文件包含机密信息。
$ opencode auth export anthropic > credentials.json
$ opencode auth import credentials.json
查看所有子命令与选项。
$ opencode auth --help
models
列出所有可用模型。
$ opencode models
查看所有子命令与选项。
$ opencode models --help
mcp
管理 MCP(Model Context Protocol)服务器。
$ opencode mcp list
添加远程服务器。
$ opencode mcp add context7 --url https://mcp.context7.com/mcp
将本地服务器添加到全局配置。
$ opencode mcp add everything --global -- npx -y @modelcontextprotocol/server-everything
添加带环境变量的本地服务器。
$ opencode mcp add everything --env LOG_LEVEL=debug -- npx -y @modelcontextprotocol/server-everything
添加带请求头的远程服务器。
$ opencode mcp add context7 --url https://mcp.context7.com/mcp --header CONTEXT7_API_KEY=secret
对支持 OAuth 的远程服务器进行认证。
$ opencode mcp auth sentry
移除某服务器已保存的 OAuth 凭据。
$ opencode mcp logout sentry
查看所有子命令与选项。
$ opencode mcp --help
plugin
管理插件。
$ opencode plugin list
包含内置的服务端插件。
$ opencode plugin list --builtin
安装插件并将其添加到全局配置。
$ opencode plugin add @example/opencode-tui
检查包插件是否有可用更新。
$ opencode plugin check
更新包插件。
$ opencode plugin update
从全局配置中移除插件。
$ opencode plugin remove @example/opencode-tui
查看所有子命令与选项。
$ opencode plugin --help
stats
显示可分享的使用统计。
$ opencode stats
显示最近 7 天。
$ opencode stats --days 7
显示模型使用情况。
$ opencode stats --models
显示成本与 token 明细。
$ opencode stats --cost
输出 JSON 而非报告。
$ opencode stats --json
仅显示当前项目。
$ opencode stats --project .
查看所有子命令与选项。
$ opencode stats --help
serve
启动 API 与 Web 服务器。参见 Web。
$ opencode serve
绑定到所有网络接口并使用固定端口。
$ opencode serve --hostname 0.0.0.0 --port 4096
允许来自其他 origin 的浏览器客户端。
$ opencode serve --cors https://app.example.com
查看所有子命令与选项。
$ opencode serve --help
pair
打印一次性链接,并将第一个链接生成二维码,用于将浏览器或应用登录到该服务器。链接在 5 分钟后过期,且仅可使用一次。
$ opencode pair
在链接中使用外部 URL。
$ opencode pair --url https://dev.example.com
通过 OpenTunnel 远程地址从任意位置配对。这会将服务器暴露到互联网,因此首次启用远程访问时会说明这一点并请求你接受。参见 远程访问。
$ opencode pair --remote
无需提示即接受,例如在没有终端的脚本中使用。
$ opencode pair --remote --yes
查看所有子命令与选项。
$ opencode pair --help
service
管理后台服务器。参见 Web。
$ opencode service start
将其重启。
$ opencode service restart
显示其状态。
$ opencode service status
将其停止。
$ opencode service stop
读取设置项。
$ opencode service get hostname
设置配置项。
$ opencode service set hostname 0.0.0.0
允许额外的 CORS origin。
$ opencode service set cors https://app.example.com
向服务端进程传递环境变量。
$ opencode service set env OPENCODE_LOG_LEVEL DEBUG
将设置重置为默认值。
$ opencode service unset hostname
查看所有子命令与选项。
$ opencode service --help
reload
在不重启服务端的情况下重新加载配置。运行中的会话将在下一个步骤边界以全新服务继续。
$ opencode reload
api
向运行中的服务端发起请求。
$ opencode api GET /api/session
调用操作 ID 并附带查询参数。
$ opencode api session.list --param limit=10
发送 JSON 请求体。
$ opencode api session.create --data '{"title": "New session"}'
添加请求头。
$ opencode api GET /api/session -H "accept: application/json"
查看所有子命令与选项。
$ opencode api --help
acp
通过 stdin 与 stdout 启动 Agent Client Protocol 服务器,供编辑器集成使用。它会持续运行,直到客户端关闭连接。
$ opencode acp
查看所有子命令与选项。
$ opencode acp --help
debug
提供调试与故障排查工具。
$ opencode debug agents
列出配置来源。
$ opencode debug config
将运行中后台服务器的堆快照写入磁盘并打印其路径。
$ opencode debug heap-dump
将快照写入你指定的目录。
$ opencode debug heap-dump --directory ./snapshots
显示全局路径。
$ opencode debug paths
打印单个路径。
$ opencode debug paths db
查看所有子命令与选项。
$ opencode debug --help
upgrade
将 OpenCode 升级到最新版本或指定版本。别名:
update。$ opencode upgrade
使用指定的包管理器升级到指定版本。
$ opencode upgrade 2.0.21 --method bun
查看所有子命令与选项。
$ opencode upgrade --help
uninstall
停止后台服务,移除全局缓存,并卸载 OpenCode。会话数据、配置与状态不会被删除。
$ opencode uninstall
预览将要移除的内容。
$ opencode uninstall --dry-run
查看所有子命令与选项。
$ opencode uninstall --help