CLI

Параметры и команда matrix CLI.

CLI matrix по умолчанию запускает TUI при запуске без каких-либо аргументов.

matrix

Но он также принимает команды, описанные на этой странице. Это позволяет вам программно взаимодействовать с matrix.

matrix run "Explain how closures work in JavaScript"

tui

Запустите TUI matrix.

matrix [project]

Флаги

Флаг	Короткий	Описание
`--continue`	`-c`	Продолжить последний сеанс
`--session`	`-s`	Идентификатор сеанса для продолжения
`--fork`		Разветвить сеанс при продолжении (используйте с `--continue` или `--session`)
`--prompt`		Промпт для использования
`--model`	`-m`	Модель для использования в виде поставщика/модели.
`--agent`		Агент для использования
`--port`		Порт для прослушивания
`--hostname`		Имя хоста для прослушивания

Команды

CLI matrix также имеет следующие команды.

agent

Управляйте агентами для matrix.

matrix agent [command]

attach

Подключите терминал к уже работающему внутреннему серверу matrix, запущенному с помощью команд serve или web.

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`	Идентификатор сеанса для продолжения

create

Создайте нового агента с пользовательской конфигурацией.

matrix agent create

Эта команда поможет вам создать новый агент с настраиваемой системной подсказкой и настройкой инструмента.

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.

matrix github run

Флаги

Флаг	Описание
`--event`	Имитирующее событие GitHub для запуска агента
`--token`	Токен личного доступа GitHub

mcp

Управляйте серверами протокола контекста модели.

matrix mcp [command]

add

Добавьте сервер MCP в свою конфигурацию.

matrix mcp add

Эта команда поможет вам добавить локальный или удаленный сервер MCP.

list

Перечислите все настроенные серверы MCP и состояние их подключения.

matrix mcp list

Или используйте короткую версию.

matrix mcp ls

auth

Аутентификация с помощью сервера MCP с поддержкой OAuth.

matrix mcp auth [name]

Если вы не укажете имя сервера, вам будет предложено выбрать один из доступных серверов с поддержкой OAuth.

Вы также можете перечислить серверы с поддержкой OAuth и их статус аутентификации.

matrix mcp auth list

Или используйте короткую версию.

matrix mcp auth ls

logout

Удалите учетные данные OAuth для сервера MCP.

matrix mcp logout [name]

debug

Отладка проблем с подключением OAuth для сервера MCP.

matrix mcp debug <name>

models

Перечислите все доступные модели от настроенных поставщиков.

matrix models [provider]

Эта команда отображает все модели, доступные у настроенных вами поставщиков, в формате provider/model.

Это полезно для определения точного названия модели, которое будет использоваться в вашем config.

При желании вы можете передать идентификатор поставщика, чтобы фильтровать модели по этому поставщику.

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`		Команда для запуска, используйте сообщение для аргументов
`--continue`	`-c`	Продолжить последний сеанс
`--session`	`-s`	Идентификатор сеанса для продолжения
`--fork`		Разветвить сеанс при продолжении (используйте с `--continue` или `--session`)
`--share`		Поделиться сеансом
`--model`	`-m`	Модель для использования в виде поставщика/модели.
`--agent`		Агент для использования
`--file`	`-f`	Файл(ы) для прикрепления к сообщению
`--format`		Формат: по умолчанию (отформатированный) или json (необработанные события JSON).
`--title`		Название сеанса (использует усеченное приглашение, если значение не указано)
`--attach`		Подключитесь к работающему серверу matrix (например, http://localhost:4096)
`--port`		Порт локального сервера (по умолчанию случайный порт)

serve

Запустите автономный сервер matrix для доступа к API. Полный HTTP-интерфейс можно найти в server docs.

matrix serve

При этом запускается HTTP-сервер, который обеспечивает доступ API к функциям matrix без интерфейса 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`		Формат вывода: таблица или json (таблица)

stats

Покажите статистику использования токенов и затрат для ваших сеансов matrix.

matrix stats

Флаги

Флаг	Описание
`--days`	Показать статистику за последние N дней (все время)
`--tools`	Количество инструментов для отображения (все)
`--models`	Показать разбивку по использованию модели (по умолчанию скрыто). Передайте номер, чтобы показать верхнюю N
`--project`	Фильтровать по проекту (все проекты, пустая строка: текущий проект)

export

Экспортируйте данные сеанса в формате JSON.

matrix export [sessionID]

Если вы не укажете идентификатор сеанса, вам будет предложено выбрать один из доступных сеансов.

import

Импортируйте данные сеанса из файла JSON или URL-адреса общего ресурса matrix.

matrix import <file>

Вы можете импортировать из локального файла или URL-адреса общего ресурса matrix.

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

web

Запустите автономный сервер matrix с веб-интерфейсом.

matrix web

При этом запускается HTTP-сервер и открывается веб-браузер для доступа к matrix через веб-интерфейс. Установите MATRIX_SERVER_PASSWORD, чтобы включить базовую аутентификацию HTTP (имя пользователя по умолчанию — matrix).

Флаги

Флаг	Описание
`--port`	Порт для прослушивания
`--hostname`	Имя хоста для прослушивания
`--mdns`	Включить обнаружение mDNS
`--cors`	Дополнительные источники браузера, позволяющие разрешить CORS

acp

Запустите сервер ACP (агент-клиентский протокол).

matrix acp

Эта команда запускает сервер ACP, который обменивается данными через stdin/stdout с использованием nd-JSON.

Флаги

Флаг	Описание
`--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`	Используемый метод установки: local, npm, pnpm, bun, brew

Глобальные флаги

CLI matrix принимает следующие глобальные флаги.

Флаг	Короткий	Описание
`--help`	`-h`	Отобразить справку
`--version`	`-v`	Распечатать номер версии
`--print-logs`		Печать журналов в stderr
`--log-level`		Уровень журнала (DEBUG, INFO, WARN, ERROR)

Переменные среды

matrix можно настроить с помощью переменных среды.

Переменная	Тип	Описание
`MATRIX_AUTO_SHARE`	логическое значение	Автоматически делиться сеансами
`MATRIX_GIT_BASH_PATH`	строка	Путь к исполняемому файлу Git Bash в Windows
`MATRIX_CONFIG`	строка	Путь к файлу конфигурации
`MATRIX_TUI_CONFIG`	строка	Путь к файлу конфигурации TUI
`MATRIX_CONFIG_DIR`	строка	Путь к каталогу конфигурации
`MATRIX_CONFIG_CONTENT`	строка	Встроенное содержимое конфигурации json
`MATRIX_DISABLE_AUTOUPDATE`	логическое значение	Отключить автоматическую проверку обновлений
`MATRIX_DISABLE_PRUNE`	логическое значение	Отключить удаление старых данных
`MATRIX_DISABLE_TERMINAL_TITLE`	логическое значение	Отключить автоматическое обновление заголовка терминала
`MATRIX_PERMISSION`	строка	Встроенная конфигурация разрешений json
`MATRIX_DISABLE_DEFAULT_PLUGINS`	логическое значение	Отключить плагины по умолчанию
`MATRIX_DISABLE_LSP_DOWNLOAD`	логическое значение	Отключить автоматическую загрузку LSP-сервера
`MATRIX_ENABLE_EXPERIMENTAL_MODELS`	логическое значение	Включить экспериментальные модели
`MATRIX_DISABLE_AUTOCOMPACT`	логическое значение	Отключить автоматическое сжатие контекста
`MATRIX_DISABLE_CLAUDE_CODE`	логическое значение	Отключить чтение из `.claude` (подсказка + навыки)
`MATRIX_DISABLE_CLAUDE_CODE_PROMPT`	логическое значение	Отключить чтение `~/.claude/CLAUDE.md`
`MATRIX_DISABLE_CLAUDE_CODE_SKILLS`	логическое значение	Отключить загрузку `.claude/skills`
`MATRIX_DISABLE_MODELS_FETCH`	логическое значение	Отключить получение моделей из удаленных источников
`MATRIX_FAKE_VCS`	строка	Поддельный поставщик VCS для целей тестирования
`MATRIX_DISABLE_FILETIME_CHECK`	логическое значение	Отключить проверку времени файла для оптимизации
`MATRIX_CLIENT`	строка	Идентификатор клиента (по умолчанию `cli`)
`MATRIX_ENABLE_EXA`	логическое значение	Включить инструменты веб-поиска Exa
`MATRIX_SERVER_PASSWORD`	строка	Включить базовую аутентификацию для `serve`/`web`
`MATRIX_SERVER_USERNAME`	строка	Переопределить имя пользователя базовой аутентификации (по умолчанию `matrix`)
`MATRIX_MODELS_URL`	строка	Пользовательский URL-адрес для получения конфигурации модели

Экспериментальные функции

Эти переменные среды позволяют использовать экспериментальные функции, которые могут быть изменены или удалены.

Переменная	Тип	Описание
`MATRIX_EXPERIMENTAL`	логическое значение	Включить все экспериментальные функции
`MATRIX_EXPERIMENTAL_ICON_DISCOVERY`	логическое значение	Включить обнаружение значков
`MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECT`	логическое значение	Отключить копирование при выборе в TUI
`MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS`	число	Таймаут по умолчанию для команд bash в мс
`MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAX`	число	Максимальное количество токенов вывода для ответов LLM
`MATRIX_EXPERIMENTAL_FILEWATCHER`	логическое значение	Включить просмотр файлов для всего каталога
`MATRIX_EXPERIMENTAL_OXFMT`	логическое значение	Включить форматтер oxfmt
`MATRIX_EXPERIMENTAL_LSP_TOOL`	логическое значение	Включить экспериментальный инструмент LSP
`MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHER`	логическое значение	Отключить просмотрщик файлов
`MATRIX_EXPERIMENTAL_EXA`	логическое значение	Включить экспериментальные функции Exa
`MATRIX_EXPERIMENTAL_LSP_TY`	логическое значение	Включить TY LSP для файлов python
`MATRIX_EXPERIMENTAL_MARKDOWN`	логическое значение	Включить экспериментальные функции Markdown
`MATRIX_EXPERIMENTAL_PLAN_MODE`	логическое значение	Включить режим плана