CLI

Opciones y comandos de la CLI de Matrix.

La CLI de Matrix de forma predeterminada inicia el TUI cuando se ejecuta sin ningún argumento.

matrix

Pero también acepta comandos como se documenta en esta página. Esto le permite interactuar con Matrix mediante programación.

matrix run "Explain how closures work in JavaScript"

tui

Inicie la interfaz de usuario del terminal Matrix.

matrix [project]

Opciones

Opción	Corta	Descripción
`--continue`	`-c`	Continuar la última sesión
`--session`	`-s`	ID de sesión para continuar
`--fork`		Bifurcar la sesión al continuar (usar con `--continue` o `--session`)
`--prompt`		Aviso de uso
`--model`	`-m`	Modelo a utilizar en forma de proveedor/modelo
`--agent`		Agente a utilizar
`--port`		Puerto para escuchar
`--hostname`		Nombre de host para escuchar

Comandos

La CLI de Matrix también tiene los siguientes comandos.

agent

Administrar agentes para Matrix.

matrix agent [command]

attach

Conecte una terminal a un servidor backend Matrix que ya se esté ejecutando y iniciado mediante los comandos serve o web.

matrix attach [url]

Esto permite usar TUI con un backend remoto Matrix. Por ejemplo:

# 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

Opciones

Opción	Corta	Descripción
`--dir`		Directorio de trabajo para iniciar TUI en
`--session`	`-s`	ID de sesión para continuar

create

Cree un nuevo agente con configuración personalizada.

matrix agent create

Este comando lo guiará en la creación de un nuevo agente con un mensaje del sistema personalizado y una configuración de herramientas.

list

Enumere todos los agentes disponibles.

matrix agent list

auth

Comando para administrar credenciales e iniciar sesión para proveedores.

matrix auth [command]

Matrix funciona con la lista de proveedores en Models.dev, por lo que puede usar matrix auth login para configurar las claves API para cualquier proveedor que desee utilizar. Esto se almacena en ~/.local/share/matrix/auth.json.

matrix auth login

Cuando se inicia Matrix, carga los proveedores desde el archivo de credenciales. Y si hay claves definidas en sus entornos o un archivo .env en su proyecto.

list

Enumera todos los proveedores autenticados tal como están almacenados en el archivo de credenciales.

matrix auth list

O la versión corta.

matrix auth ls

logout

Cierra tu sesión de un proveedor eliminándolo del archivo de credenciales.

matrix auth logout

github

Administre el agente GitHub para la automatización del repositorio.

matrix github [command]

install

Instale el agente GitHub en su repositorio.

matrix github install

Esto configura el flujo de trabajo de acciones GitHub necesario y lo guía a través del proceso de configuración. Más información.

run

Ejecute el agente GitHub. Esto se usa normalmente en acciones GitHub.

matrix github run

Opciones

Opción	Descripción
`--event`	GitHub evento simulado para ejecutar el agente
`--token`	GitHub token de acceso personal

mcp

Administrar servidores de protocolo de contexto modelo.

matrix mcp [command]

add

Agregue un servidor MCP a su configuración.

matrix mcp add

Este comando lo guiará para agregar un servidor MCP local o remoto.

list

Enumere todos los servidores MCP configurados y su estado de conexión.

matrix mcp list

O utilice la versión corta.

matrix mcp ls

auth

Autentíquese con un servidor MCP habilitado para OAuth.

matrix mcp auth [name]

Si no proporciona un nombre de servidor, se le pedirá que seleccione entre los servidores compatibles con OAuth disponibles.

También puede enumerar los servidores compatibles con OAuth y su estado de autenticación.

matrix mcp auth list

O utilice la versión corta.

matrix mcp auth ls

logout

Elimine las credenciales OAuth para un servidor MCP.

matrix mcp logout [name]

debug

Depurar problemas de conexión OAuth para un servidor MCP.

matrix mcp debug <name>

models

Enumere todos los modelos disponibles de los proveedores configurados.

matrix models [provider]

Este comando muestra todos los modelos disponibles en sus proveedores configurados en el formato provider/model.

Esto es útil para determinar el nombre exacto del modelo que se usará en su configuración.

Opcionalmente, puede pasar un ID de proveedor para filtrar modelos por ese proveedor.

matrix models anthropic

Opciones

Opción	Descripción
`--refresh`	Actualizar la caché de modelos desde models.dev
`--verbose`	Utilice una salida del modelo más detallada (incluye metadatos como costos)

Utilice el indicador --refresh para actualizar la lista de modelos almacenados en caché. Esto es útil cuando se han agregado nuevos modelos a un proveedor y desea verlos en Matrix.

matrix models --refresh

run

Ejecute matrix en modo no interactivo pasando un mensaje directamente.

matrix run [message..]

Esto es útil para secuencias de comandos, automatización o cuando desea una respuesta rápida sin iniciar el TUI completo. Por ejemplo.

matrix run Explain the use of context in Go

También puede conectarse a una instancia matrix serve en ejecución para evitar tiempos de arranque en frío del servidor MCP en cada ejecución:

# 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"

Opciones

Opción	Corta	Descripción
`--command`		El comando a ejecutar, use mensaje para args
`--continue`	`-c`	Continuar la última sesión
`--session`	`-s`	ID de sesión para continuar
`--fork`		Bifurcar la sesión al continuar (usar con `--continue` o `--session`)
`--share`		Comparte la sesión
`--model`	`-m`	Modelo a utilizar en forma de proveedor/modelo
`--agent`		Agente a utilizar
`--file`	`-f`	Archivo(s) para adjuntar al mensaje
`--format`		Formato: predeterminado (formateado) o json (eventos JSON sin formato)
`--title`		Título de la sesión (utiliza un mensaje truncado si no se proporciona ningún valor)
`--attach`		Adjuntar a un servidor matrix en ejecución (por ejemplo, http://localhost:4096)
`--port`		Puerto para el servidor local (el puerto predeterminado es aleatorio)

serve

Inicie un servidor Matrix sin cabeza para acceso API. Consulte los documentos del servidor para conocer la interfaz HTTP completa.

matrix serve

Esto inicia un servidor HTTP que proporciona acceso API a la funcionalidad matrix sin la interfaz TUI. Configure MATRIX_SERVER_PASSWORD para habilitar la autenticación básica HTTP (el nombre de usuario predeterminado es matrix).

Opciones

Opción	Descripción
`--port`	Puerto para escuchar
`--hostname`	Nombre de host para escuchar
`--mdns`	Habilitar el descubrimiento de mDNS
`--cors`	Orígenes de navegador adicionales para permitir CORS

session

Administrar Matrix sesiones.

matrix session [command]

list

Enumere todas las sesiones Matrix.

matrix session list

Opciones

Opción	Corta	Descripción
`--max-count`	`-n`	Limitar a N sesiones más recientes
`--format`		Formato de salida: tabla o json (tabla)

stats

Muestre el uso de tokens y las estadísticas de costos para sus sesiones Matrix.

matrix stats

Opciones

Opción	Descripción
`--days`	Mostrar estadísticas de los últimos N días (todo el tiempo)
`--tools`	Número de herramientas para mostrar (todas)
`--models`	Mostrar el desglose del uso del modelo (oculto de forma predeterminada). Pase un número para mostrar la parte superior N
`--project`	Filtrar por proyecto (todos los proyectos, cadena vacía: proyecto actual)

export

Exportar datos de la sesión como JSON.

matrix export [sessionID]

Si no proporciona una ID de sesión, se le pedirá que seleccione entre las sesiones disponibles.

import

Importe datos de sesión desde un archivo JSON o una URL compartida Matrix.

matrix import <file>

Puede importar desde un archivo local o una URL compartida Matrix.

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

web

Inicie un servidor Matrix sin cabeza con una interfaz web.

matrix web

Esto inicia un servidor HTTP y abre un navegador web para acceder a Matrix a través de una interfaz web. Configure MATRIX_SERVER_PASSWORD para habilitar la autenticación básica HTTP (el nombre de usuario predeterminado es matrix).

Opciones

Opción	Descripción
`--port`	Puerto para escuchar
`--hostname`	Nombre de host para escuchar
`--mdns`	Habilitar el descubrimiento de mDNS
`--cors`	Orígenes de navegador adicionales para permitir CORS

acp

Inicie un servidor ACP (Agent Client Protocol).

matrix acp

Este comando inicia un servidor ACP que se comunica a través de stdin/stdout usando nd-JSON.

Opciones

Opción	Descripción
`--cwd`	Directorio de trabajo
`--port`	Puerto para escuchar
`--hostname`	Nombre de host para escuchar

uninstall

Desinstale Matrix y elimine todos los archivos relacionados.

matrix uninstall

Opciones

Opción	Corta	Descripción
`--keep-config`	`-c`	Mantener archivos de configuración
`--keep-data`	`-d`	Conservar datos de sesión e instantáneas
`--dry-run`		Mostrar lo que se eliminaría sin eliminar
`--force`	`-f`	Saltar mensajes de confirmación

upgrade

Actualiza matrix a la última versión o a una versión específica.

matrix upgrade [target]

Para actualizar a la última versión.

matrix upgrade

Para actualizar a una versión específica.

matrix upgrade v0.1.48

Opciones

Opción	Corta	Descripción
`--method`	`-m`	El método de instalación que se utilizó; curl, npm, pnpm, bun, brew

Opciones globales

La CLI de Matrix toma las siguientes banderas globales.

Opción	Corta	Descripción
`--help`	`-h`	Mostrar ayuda
`--version`	`-v`	Número de versión de impresión
`--print-logs`		Imprimir registros en stderr
`--log-level`		Nivel de registro (DEBUG, INFO, WARN, ERROR)

Variables de entorno

Matrix se puede configurar mediante variables de entorno.

Variable	Type	Description
`MATRIX_AUTO_SHARE`	booleano	Compartir sesiones automáticamente
`MATRIX_GIT_BASH_PATH`	cadena	Ruta al ejecutable de Git Bash en Windows
`MATRIX_CONFIG`	cadena	Ruta al archivo de configuración
`MATRIX_CONFIG_DIR`	cadena	Ruta al directorio de configuración
`MATRIX_CONFIG_CONTENT`	cadena	Contenido de configuración json en línea
`MATRIX_DISABLE_AUTOUPDATE`	booleano	Deshabilitar las comprobaciones automáticas de actualizaciones
`MATRIX_DISABLE_PRUNE`	booleano	Deshabilitar la poda de datos antiguos
`MATRIX_DISABLE_TERMINAL_TITLE`	booleano	Deshabilitar las actualizaciones automáticas de títulos de terminal
`MATRIX_PERMISSION`	cadena	Configuración de permisos json incorporados
`MATRIX_DISABLE_DEFAULT_PLUGINS`	booleano	Deshabilitar complementos predeterminados
`MATRIX_DISABLE_LSP_DOWNLOAD`	booleano	Deshabilitar las descargas automáticas del servidor LSP
`MATRIX_ENABLE_EXPERIMENTAL_MODELS`	booleano	Habilitar modelos experimentales
`MATRIX_DISABLE_AUTOCOMPACT`	booleano	Deshabilitar la compactación automática de contexto
`MATRIX_DISABLE_CLAUDE_CODE`	booleano	Deshabilitar la lectura desde `.claude` (mensaje + habilidades)
`MATRIX_DISABLE_CLAUDE_CODE_PROMPT`	booleano	Desactivar lectura `~/.claude/CLAUDE.md`
`MATRIX_DISABLE_CLAUDE_CODE_SKILLS`	booleano	Deshabilitar la carga `.claude/skills`
`MATRIX_DISABLE_MODELS_FETCH`	booleano	Deshabilitar la recuperación de modelos desde fuentes remotas
`MATRIX_FAKE_VCS`	cadena	Proveedor de VCS falso para fines de prueba
`MATRIX_DISABLE_FILETIME_CHECK`	booleano	Deshabilite la verificación del tiempo del archivo para optimizarlo
`MATRIX_CLIENT`	cadena	Identificador de cliente (por defecto `cli`)
`MATRIX_ENABLE_EXA`	booleano	Habilitar las herramientas de búsqueda web de Exa
`MATRIX_SERVER_PASSWORD`	cadena	Habilite la autenticación básica para `serve`/`web`
`MATRIX_SERVER_USERNAME`	cadena	Anular el nombre de usuario de autenticación básica (predeterminado `matrix`)
`MATRIX_MODELS_URL`	cadena	URL personalizada para buscar la configuración de modelos

Experimental

Estas variables de entorno habilitan funciones experimentales que pueden cambiar o eliminarse.

Variable	Type	Description
`MATRIX_EXPERIMENTAL`	booleano	Habilitar todas las funciones experimentales
`MATRIX_EXPERIMENTAL_ICON_DISCOVERY`	booleano	Habilitar descubrimiento de íconos
`MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECT`	booleano	Deshabilitar copia al seleccionar en TUI
`MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS`	número	Tiempo de espera predeterminado para comandos bash en ms
`MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAX`	número	Tokens de salida máximos para respuestas LLM
`MATRIX_EXPERIMENTAL_FILEWATCHER`	booleano	Habilite el observador de archivos para todo el directorio
`MATRIX_EXPERIMENTAL_OXFMT`	booleano	Habilitar el formateador oxfmt
`MATRIX_EXPERIMENTAL_LSP_TOOL`	booleano	Habilitar herramienta experimental LSP
`MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHER`	booleano	Deshabilitar el observador de archivos
`MATRIX_EXPERIMENTAL_EXA`	booleano	Habilitar funciones experimentales de Exa
`MATRIX_EXPERIMENTAL_LSP_TY`	booleano	Habilitar Habilitar TY LSP para archivos python
`MATRIX_EXPERIMENTAL_MARKDOWN`	booleano	Habilitar funciones de Markdown experimentales
`MATRIX_EXPERIMENTAL_PLAN_MODE`	booleano	Habilitar modo de plan