CLI 命令行界面

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

opencode

如果你想与其进行编程交互，它也接受本页面文档中所述的命令。

opencode run "Explain how closures work in JavaScript"

---

tui

启动 OpenCode 终端用户界面。

opencode [project]

标志 Flags

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

---

命令 Commands

OpenCode CLI 还有以下命令。

---

agent

管理 OpenCode 的智能体。

opencode agent [command]

---

attach

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

opencode attach [url]

这允许使用 TUI 连接远程 OpenCode 后端。例如：

# Start the backend server for web/mobile access
opencode web --port 4096 --hostname 0.0.0.0

# In another terminal, attach the TUI to the running backend
opencode attach http://10.20.30.40:4096

标志 Flags

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

---

create

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

opencode agent create

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

---

list

列出所有可用的智能体。

opencode agent list

---

auth

管理提供商凭据和登录的命令。

opencode auth [command]

---

login

OpenCode 由 Models.dev 上的提供商列表提供支持，因此你可以使用 opencode auth login 为你想要使用的任何提供商配置 API 密钥。这也存储在 ~/.local/share/opencode/auth.json 中。

opencode auth login

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

---

list

列出存储在凭据文件中的所有经过身份验证的提供商。

opencode auth list

或者使用简短版本。

opencode auth ls

---

logout

通过从凭据文件中清除提供商来注销。

opencode auth logout

---

github

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

opencode github [command]

---

install

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

opencode github install

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

---

run

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

opencode github run

标志 Flags

标志	描述
--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

标志 Flags

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

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

opencode models --refresh

---

run

通过直接传递提示词，以非交互模式运行 opencode。

opencode run [message..]

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

opencode run Explain the use of context in Go

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

# Start a headless server in one terminal
opencode serve

# In another terminal, run commands that attach to it
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"

标志 Flags

标志	简写	描述
--command		要运行的命令，使用 message 作为参数
--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

启动 headless OpenCode 服务器以进行 API 访问。查看 服务器文档 了解完整的 HTTP 接口。

opencode serve

这将启动一个 HTTP 服务器，提供对 opencode 功能的 API 访问，而无需 TUI 界面。设置 OPENCODE_SERVER_PASSWORD 以启用 HTTP 基本身份验证（用户名默认为 opencode）。

标志 Flags

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

---

session

管理 OpenCode 会话。

opencode session [command]

---

list

列出所有 OpenCode 会话。

opencode session list

标志 Flags

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

---

stats

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

opencode stats

标志 Flags

标志	描述
--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 界面的 headless OpenCode 服务器。

opencode web

这将启动一个 HTTP 服务器并打开 Web 浏览器以通过 Web 界面访问 OpenCode。设置 OPENCODE_SERVER_PASSWORD 以启用 HTTP 基本身份验证（用户名默认为 opencode）。

标志 Flags

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

---

acp

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

opencode acp

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

标志 Flags

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

---

uninstall

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

opencode uninstall

标志 Flags

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

---

upgrade

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

opencode upgrade [target]

要更新到最新版本。

opencode upgrade

要更新到特定版本。

opencode upgrade v0.1.48

标志 Flags

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

---

全局标志 Global Flags

opencode CLI 接受以下全局标志。

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

---

环境变量 Environment variables

可以使用环境变量配置 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_DISABLE_CLAUDE_CODE	boolean	禁用读取 .claude (prompt + skills)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPT	boolean	禁用读取 ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLS	boolean	禁用加载 .claude/skills
OPENCODE_CLIENT	string	客户端标识符（默认为 cli）
OPENCODE_ENABLE_EXA	boolean	启用 Exa 网络搜索工具
OPENCODE_SERVER_PASSWORD	string	启用 serve/web 的基本认证
OPENCODE_SERVER_USERNAME	string	覆盖基本认证用户名（默认为 opencode）

---

实验性功能 Experimental

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

变量	类型	描述
OPENCODE_EXPERIMENTAL	boolean	启用所有实验性功能
OPENCODE_EXPERIMENTAL_ICON_DISCOVERY	boolean	启用图标发现
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT	boolean	禁用 TUI 中的选择复制
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 工具
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER	boolean	禁用文件观察器
OPENCODE_EXPERIMENTAL_EXA	boolean	启用实验性 Exa 功能
OPENCODE_EXPERIMENTAL_LSP_TY	boolean	启用实验性 LSP 类型检查
OPENCODE_EXPERIMENTAL_MARKDOWN	boolean	启用实验性 markdown 功能
OPENCODE_EXPERIMENTAL_PLAN_MODE	boolean	启用计划模式