CLI

Matrix CLI 选项和命令。

Matrix CLI 在不带任何参数运行时，默认启动 TUI。

matrix

但它也接受本页面中记录的命令，使您可以通过编程方式与 Matrix 进行交互。

matrix run "Explain how closures work in JavaScript"

tui

启动 Matrix 终端用户界面。

matrix [project]

标志

标志	简写	描述
`--continue`	`-c`	继续上一个会话
`--session`	`-s`	要继续的会话 ID
`--fork`		继续时分叉会话（与 `--continue` 或 `--session` 配合使用）
`--prompt`		要使用的提示词
`--model`	`-m`	要使用的模型，格式为 provider/model
`--agent`		要使用的代理
`--port`		监听端口
`--hostname`		监听主机名

命令

Matrix CLI 还提供以下命令。

agent

管理 Matrix 的代理。

matrix agent [command]

attach

将终端连接到已通过 serve 或 web 命令启动的 Matrix 后端服务器。

matrix attach [url]

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

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

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

标志

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

list

列出所有可用的代理。

matrix agent list

auth

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

matrix auth [command]

Matrix 基于 Models.dev 的提供商列表运行，因此您可以使用 matrix auth login 为任何想要使用的提供商配置 API 密钥。密钥存储在 ~/.local/share/matrix/auth.json 中。

matrix auth login

Matrix 启动时会从凭据文件加载提供商信息，同时也会加载环境变量或项目中 .env 文件中定义的密钥。

list

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

matrix auth list

或使用简写版本。

matrix auth ls

logout

从凭据文件中清除提供商信息以完成登出。

matrix auth logout

github

管理用于仓库自动化的 GitHub 代理。

matrix github [command]

install

在您的仓库中安装 GitHub 代理。

matrix github install

此命令会设置必要的 GitHub Actions 工作流并引导您完成配置过程。了解更多。

run

运行 GitHub 代理。通常在 GitHub Actions 中使用。

matrix github run

标志

标志	描述
`--event`	用于运行代理的 GitHub 模拟事件
`--token`	GitHub 个人访问令牌

mcp

管理 Model Context Protocol 服务器。

matrix mcp [command]

list

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

matrix mcp list

或使用简写版本。

matrix mcp ls

auth

对支持 OAuth 的 MCP 服务器进行认证。

matrix mcp auth [name]

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

您还可以列出支持 OAuth 的服务器及其认证状态。

matrix mcp auth list

或使用简写版本。

matrix mcp auth ls

logout

移除 MCP 服务器的 OAuth 凭据。

matrix mcp logout [name]

debug

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

matrix mcp debug <name>

models

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

matrix models [provider]

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

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

您可以选择传入提供商 ID 来按提供商筛选模型。

matrix models anthropic

标志

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

使用 --refresh 标志可以更新缓存的模型列表。当提供商新增了模型并且您希望在 Matrix 中看到它们时，此功能非常有用。

matrix models --refresh

run

以非交互模式运行 Matrix，直接传入提示词。

matrix run [message..]

这对于脚本编写、自动化或无需启动完整 TUI 即可快速获取答案的场景非常有用。例如：

matrix run Explain the use of context in Go

您还可以连接到正在运行的 matrix serve 实例，以避免每次运行时 MCP 服务器的冷启动时间：

# Start a headless server in one terminal
matrix serve

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

标志

标志	简写	描述
`--command`		要运行的命令，使用 message 作为参数
`--continue`	`-c`	继续上一个会话
`--session`	`-s`	要继续的会话 ID
`--fork`		继续时分叉会话（与 `--continue` 或 `--session` 配合使用）
`--share`		分享会话
`--model`	`-m`	要使用的模型，格式为 provider/model
`--agent`		要使用的代理
`--file`	`-f`	附加到消息的文件
`--format`		格式：default（格式化输出）或 json（原始 JSON 事件）
`--title`		会话标题（未提供值时使用截断的提示词）
`--attach`		连接到正在运行的 matrix 服务器（例如 http://localhost:4096）
`--port`		本地服务器端口（默认为随机端口）

serve

启动无界面的 Matrix 服务器以提供 API 访问。查看服务器文档了解完整的 HTTP 接口。

matrix serve

此命令启动一个 HTTP 服务器，提供对 Matrix 功能的 API 访问，无需 TUI 界面。设置 MATRIX_SERVER_PASSWORD 可启用 HTTP 基本认证（用户名默认为 matrix）。

标志

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

session

管理 Matrix 会话。

matrix session [command]

list

列出所有 Matrix 会话。

matrix session list

标志

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

stats

显示 Matrix 会话的 Token 用量和费用统计信息。

matrix stats

标志

标志	描述
`--days`	显示最近 N 天的统计信息（默认为所有时间）
`--tools`	显示的工具数量（默认为全部）
`--models`	显示模型用量明细（默认隐藏）。传入数字可显示前 N 个
`--project`	按项目筛选（默认为所有项目，传入空字符串表示当前项目）

import

从 JSON 文件或 Matrix 分享链接导入会话数据。

matrix import <file>

您可以从本地文件或 Matrix 分享链接导入。

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

web

启动带有 Web 界面的无界面 Matrix 服务器。

matrix web

此命令启动一个 HTTP 服务器并打开浏览器，通过 Web 界面访问 Matrix。设置 MATRIX_SERVER_PASSWORD 可启用 HTTP 基本认证（用户名默认为 matrix）。

标志

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

acp

启动 ACP（Agent Client Protocol）服务器。

matrix acp

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

标志

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

uninstall

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

matrix uninstall

标志

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

upgrade

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

matrix upgrade [target]

更新到最新版本。

matrix upgrade

更新到指定版本。

matrix upgrade v0.1.48

标志

标志	简写	描述
`--method`	`-m`	使用的安装方式：curl、npm、pnpm、bun、brew

全局标志

Matrix CLI 接受以下全局标志。

标志	简写	描述
`--help`	`-h`	显示帮助信息
`--version`	`-v`	打印版本号
`--print-logs`		将日志输出到 stderr
`--log-level`		日志级别（DEBUG、INFO、WARN、ERROR）

变量	类型	描述
`MATRIX_AUTO_SHARE`	boolean	自动分享会话
`MATRIX_GIT_BASH_PATH`	string	Windows 上 Git Bash 可执行文件的路径
`MATRIX_CONFIG`	string	配置文件路径
`MATRIX_TUI_CONFIG`	string	TUI 配置文件路径
`MATRIX_CONFIG_DIR`	string	配置目录路径
`MATRIX_CONFIG_CONTENT`	string	内联 JSON 配置内容
`MATRIX_DISABLE_AUTOUPDATE`	boolean	禁用自动更新检查
`MATRIX_DISABLE_PRUNE`	boolean	禁用旧数据清理
`MATRIX_DISABLE_TERMINAL_TITLE`	boolean	禁用自动终端标题更新
`MATRIX_PERMISSION`	string	内联 JSON 权限配置
`MATRIX_DISABLE_DEFAULT_PLUGINS`	boolean	禁用默认插件
`MATRIX_DISABLE_LSP_DOWNLOAD`	boolean	禁用 LSP 服务器自动下载
`MATRIX_ENABLE_EXPERIMENTAL_MODELS`	boolean	启用实验性模型
`MATRIX_DISABLE_AUTOCOMPACT`	boolean	禁用自动上下文压缩
`MATRIX_DISABLE_CLAUDE_CODE`	boolean	禁用读取 `.claude`（提示词 + 技能）
`MATRIX_DISABLE_CLAUDE_CODE_PROMPT`	boolean	禁用读取 `~/.claude/CLAUDE.md`
`MATRIX_DISABLE_CLAUDE_CODE_SKILLS`	boolean	禁用加载 `.claude/skills`
`MATRIX_DISABLE_MODELS_FETCH`	boolean	禁用从远程源获取模型
`MATRIX_FAKE_VCS`	string	用于测试目的的模拟 VCS 提供商
`MATRIX_DISABLE_FILETIME_CHECK`	boolean	禁用文件时间检查优化
`MATRIX_CLIENT`	string	客户端标识符（默认为 `cli`）
`MATRIX_ENABLE_EXA`	boolean	启用 Exa 网络搜索工具
`MATRIX_SERVER_PASSWORD`	string	为 `serve`/`web` 启用基本认证
`MATRIX_SERVER_USERNAME`	string	覆盖基本认证用户名（默认为 `matrix`）
`MATRIX_MODELS_URL`	string	自定义模型配置获取 URL

| 变量 | 类型 | 描述 | | ----------------------------------------------- | ------- | ------------------------------- | --- | -------------------------------- | ------- | ------------------------ | | MATRIX_EXPERIMENTAL | boolean | 启用所有实验性功能 | | MATRIX_EXPERIMENTAL_ICON_DISCOVERY | boolean | 启用图标发现 | | MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolean | 禁用 TUI 中的选中即复制 | | MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | number | bash 命令的默认超时时间（毫秒） | | MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAX | number | LLM 响应的最大输出 Token 数 | | MATRIX_EXPERIMENTAL_FILEWATCHER | boolean | 启用整个目录的文件监听器 | | MATRIX_EXPERIMENTAL_OXFMT | boolean | 启用 oxfmt 格式化器 | | MATRIX_EXPERIMENTAL_LSP_TOOL | boolean | 启用实验性 LSP 工具 | | MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHER | boolean | 禁用文件监听器 | | MATRIX_EXPERIMENTAL_EXA | boolean | 启用实验性 Exa 功能 | | MATRIX_EXPERIMENTAL_LSP_TY | boolean | 为 python 文件启用 TY LSP | | MATRIX_EXPERIMENTAL_MARKDOWN | boolean | 启用实验性 Markdown 功能 | | MATRIX_EXPERIMENTAL_PLAN_MODE | boolean | 启用计划模式 |