CLI

OpenCode CLI 选项和命令。

默认情况下，OpenCode CLI 在不带任何参数运行时会启动 TUI。

opencode

但它也接受本页所记录的命令。这允许你以编程方式与 OpenCode 进行交互。

opencode run "解释 JavaScript 中闭包的工作原理"

tui

启动 OpenCode 终端用户界面 (TUI)。

opencode [project]

标志

标志	简写	描述
`--continue`	`-c`	继续上一个会话
`--session`	`-s`	要继续的会话 ID
`--prompt`		要使用的提示词
`--model`	`-m`	以 provider/model 格式指定要使用的模型
`--agent`		要使用的智能体
`--port`		监听端口
`--hostname`		监听主机名

命令

OpenCode CLI 还有以下命令。

agent

管理 OpenCode 的智能体。

opencode agent [command]

attach

将终端附加到已通过 serve 或 web 命令启动的 OpenCode 后端服务器。

opencode attach [url]

这允许将 TUI 与远程 OpenCode 后端配合使用。例如：

# 启动后端服务器以供 Web/移动端访问
opencode web --port 4096 --hostname 0.0.0.0

# 在另一个终端中，将 TUI 附加到运行中的后端
opencode attach http://10.20.30.40:4096

标志

标志	简写	描述
`--dir`		启动 TUI 的工作目录
`--session`	`-s`	要继续的会话 ID

create

创建具有自定义配置的新智能体。

opencode agent create

此命令将引导你通过自定义系统提示词和工具配置创建新的智能体。

list

列出当前所有可用的智能体。

opencode agent list

auth

管理 OpenCode 的凭据。

opencode auth [command]

登录到 OpenCode Zen 以管理模型访问、账单等。

opencode auth login

当 OpenCode 启动时，它会从凭据文件中加载提供商。如果你的环境变量或项目中的 .env 文件中定义了任何密钥，它也会加载这些密钥。

list

列出凭据文件中存储的所有已验证的提供商。

opencode auth list

或者简写版本：

opencode auth ls

logout

登出并清除本地存储的 API 密钥。

opencode auth logout

github

管理用于仓库自动化的 GitHub 智能体。

opencode github [command]

install

在你的仓库中安装 GitHub 智能体。

opencode github install

这将设置必要的 GitHub Actions 工作流，并引导你完成配置过程。了解更多。

run

运行 GitHub 智能体。这通常在 GitHub Actions 中使用。

opencode github run

标志

标志	描述
`--event`	运行智能体所针对的 GitHub 模拟事件
`--token`	GitHub 个人访问令牌

mcp

管理模型上下文协议 (Model Context Protocol) 服务器。

opencode mcp [command]

add

将 MCP 服务器添加到你的配置中。

opencode mcp add

此命令将引导你添加本地或远程 MCP 服务器。

list

列出所有已配置的 MCP 服务器及其连接状态。

opencode mcp list

或者使用简写版本：

opencode mcp ls

auth

与启用 OAuth 的 MCP 服务器进行身份验证。

opencode mcp auth [name]

如果你不提供服务器名称，系统将提示你从可用的支持 OAuth 的服务器中进行选择。

你还可以列出支持 OAuth 的服务器及其身份验证状态。

opencode mcp auth list

或者使用简写版本：

opencode mcp auth ls

logout

删除 MCP 服务器的 OAuth 凭据。

opencode mcp logout [name]

debug

调试 MCP 服务器的 OAuth 连接问题。

opencode mcp debug <name>

models

列出所有已配置提供商的可用模型。

opencode models [provider]

此命令以 provider/model 格式显示所有已配置提供商的可用模型。

这对于确定在你的配置中使用的确切模型名称非常有用。

你可以选择传递提供商 ID 来按该提供商过滤模型。

opencode models anthropic

标志

标志	描述
`--refresh`	从 models.dev 刷新模型缓存
`--verbose`	使用更详细的模型输出（包括成本等元数据）

使用 --refresh 标志更新缓存的模型列表。当提供商添加了新模型，并且你希望在 OpenCode 中看到它们时，这非常有用。

opencode models --refresh

run

对一个提示词执行单次运行并退出。这对于脚本编写或快速查询非常有用。

opencode run [prompt]

这对于脚本编写、自动化，或者当你想要快速获得答案而不启动完整 TUI 时非常有用。例如：

opencode run 解释 Go 中 context 的使用

你还可以附加到正在运行的 opencode serve 实例，以避免每次运行时 MCP 服务器冷启动：

# 在一个终端中启动无头服务器
opencode serve

# 在另一个终端中，运行附加到它的命令
opencode run --attach http://localhost:4096 "解释 JavaScript 中的 async/await"

标志

标志	简写	描述
`--command`		要运行的命令，使用消息作为参数
`--continue`	`-c`	继续上一个会话
`--session`	`-s`	要继续的会话 ID
`--share`		分享会话
`--model`	`-m`	以 provider/model 格式指定要使用的模型
`--agent`		要使用的智能体
`--file`	`-f`	附加到消息的文件
`--format`		格式：default (已格式化) 或 json (原始 JSON 事件)
`--title`		会话标题（如果未提供值，则使用截断的提示词）
`--attach`		附加到正在运行的 opencode 服务器（例如 http://localhost:4096）
`--port`		本地服务器的端口（默认为随机端口）

serve

启动 OpenCode 后端服务器而不启动 TUI。这允许远程客户端（如 Web 或移动应用）连接到此后端。

opencode serve

这将启动一个 HTTP 服务器，提供对 opencode 功能的 API 访问，而无需 TUI 界面。

标志

标志	描述
`--port`	监听端口
`--hostname`	监听主机名
`--mdns`	启用 mDNS 发现
`--cors`	允许 CORS 的额外浏览器源

session

管理 OpenCode 会话。

opencode session [command]

list

列出所有 OpenCode 会话。

opencode session list

标志

标志	简写	描述
`--max-count`	`-n`	限制为最近的 N 个会话
`--format`		输出格式：table 或 json (table)

stats

显示 OpenCode 会话的令牌使用情况和成本统计信息。

opencode stats

标志

标志	描述
`--days`	显示过去 N 天的统计信息（全部时间）
`--tools`	要显示的工具数量（全部）
`--models`	显示模型使用情况明细（默认隐藏）。传递一个数字以显示前 N 个
`--project`	按项目过滤（所有项目，空字符串：当前项目）

export

将会话数据导出为 JSON。

opencode export [sessionID]

如果你不提供会话 ID，系统将提示你从可用会话中进行选择。

import

从 JSON 文件或 OpenCode 分享 URL 导入会话数据。

opencode import <file>

你可以从本地文件或 OpenCode 分享 URL 导入。

opencode import session.json
opencode import https://opncd.ai/s/abc123

web

启动一个带有 Web 界面的无头 OpenCode 服务器。

opencode web

这将启动一个 HTTP 服务器并打开 Web 浏览器，以通过 Web 界面访问 OpenCode。

标志

标志	描述
`--port`	监听端口
`--hostname`	监听主机名
`--mdns`	启用 mDNS 发现
`--cors`	允许 CORS 的额外浏览器源

acp

启动 ACP (Agent Client Protocol) 服务器。

opencode acp

此命令启动一个通过 stdin/stdout 使用 nd-JSON 进行通信的 ACP 服务器。

标志

标志	描述
`--cwd`	工作目录
`--port`	监听端口
`--hostname`	监听主机名

uninstall

卸载 OpenCode 并删除所有相关文件。

opencode uninstall

标志

标志	简写	描述
`--keep-config`	`-c`	保留配置文件
`--keep-data`	`-d`	保留会话数据和快照
`--dry-run`		显示将要删除的内容而不实际删除
`--force`	`-f`	跳过确认提示

upgrade

将 opencode 更新到最新版本或指定版本。

opencode upgrade [target]

更新到最新版本：

opencode upgrade

更新到指定版本：

opencode upgrade v0.1.48

标志

标志	简写	描述
`--method`	`-m`	所使用的安装方法；curl, npm, pnpm, bun, brew

全局标志

opencode CLI 接受以下全局标志。

标志	简写	描述
`--help`	`-h`	显示帮助
`--version`	`-v`	打印版本号
`--print-logs`		将日志打印到 stderr
`--log-level`		日志级别 (DEBUG, INFO, WARN, ERROR)

环境变量

OpenCode 可以使用环境变量进行配置。

变量	类型	描述
`OPENCODE_AUTO_SHARE`	boolean	自动分享会话
`OPENCODE_GIT_BASH_PATH`	string	Windows 上 Git Bash 可执行文件的路径
`OPENCODE_CONFIG`	string	配置文件路径
`OPENCODE_CONFIG_DIR`	string	配置目录路径
`OPENCODE_CONFIG_CONTENT`	string	内联 JSON 配置内容
`OPENCODE_DISABLE_AUTOUPDATE`	boolean	禁用自动更新检查
`OPENCODE_DISABLE_PRUNE`	boolean	禁用旧数据清理
`OPENCODE_DISABLE_TERMINAL_TITLE`	boolean	禁用自动终端标题更新
`OPENCODE_PERMISSION`	string	内联 JSON 权限配置
`OPENCODE_DISABLE_DEFAULT_PLUGINS`	boolean	禁用默认插件
`OPENCODE_DISABLE_LSP_DOWNLOAD`	boolean	禁用自动 LSP 服务器下载
`OPENCODE_ENABLE_EXPERIMENTAL_MODELS`	boolean	启用实验性模型
`OPENCODE_DISABLE_AUTOCOMPACT`	boolean	禁用自动上下文压缩
`OPENCODE_CLIENT`	string	客户端标识符（默认为 `cli`）
`OPENCODE_ENABLE_EXA`	boolean	启用 Exa 网络搜索工具

实验性

这些环境变量启用了可能会更改或删除的实验性功能。

变量	类型	描述
`OPENCODE_EXPERIMENTAL`	boolean	启用所有实验性功能
`OPENCODE_EXPERIMENTAL_ICON_DISCOVERY`	boolean	启用图标发现
`OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT`	boolean	在 TUI 中禁用选择即复制
`OPENCODE_EXPERIMENTAL_BASH_MAX_OUTPUT_LENGTH`	number	bash 命令的最大输出长度
`OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS`	number	bash 命令的默认超时时间（毫秒）
`OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX`	number	LLM 响应的最大输出令牌数
`OPENCODE_EXPERIMENTAL_FILEWATCHER`	boolean	为整个目录启用文件观察器
`OPENCODE_EXPERIMENTAL_OXFMT`	boolean	启用 oxfmt 格式化程序
`OPENCODE_EXPERIMENTAL_LSP_TOOL`	boolean	启用实验性 LSP 工具