CLI

Opções e comandos da CLI do matrix.

A CLI do matrix, por padrão, inicia o TUI quando executada sem argumentos.

matrix

Mas também aceita comandos conforme documentado nesta página. Isso permite que você interaja com o matrix programaticamente.

matrix run "Explain how closures work in JavaScript"

tui

Inicie a interface de usuário do terminal do matrix.

matrix [project]

Opções

Flag	Curto	Descrição
`--continue`	`-c`	Continue a última sessão
`--session`	`-s`	ID da sessão para continuar
`--fork`		Criar um fork da sessão ao continuar (use com `--continue` ou `--session`)
`--prompt`		Prompt a ser usado
`--model`	`-m`	Modelo a ser usado na forma de provider/model
`--agent`		Agente a ser usado
`--port`		Porta para escutar
`--hostname`		Nome do host para escutar

Comandos

A CLI do matrix também possui os seguintes comandos.

agent

Gerencie agentes para o matrix.

matrix agent [command]

attach

Anexe um terminal a um servidor backend do matrix já em execução, iniciado via comandos serve ou web.

matrix attach [url]

Isso permite usar o TUI com um backend matrix remoto. Por exemplo:

# Inicie o servidor backend para acesso web/mobile
matrix web --port 4096 --hostname 0.0.0.0

# Em outro terminal, anexe o TUI ao backend em execução
matrix attach http://10.20.30.40:4096

Opções

Flag	Curto	Descrição
`--dir`		Diretório de trabalho para iniciar o TUI
`--session`	`-s`	ID da sessão para continuar

create

Crie um novo agente com configuração personalizada.

matrix agent create

Este comando irá guiá-lo na criação de um novo agente com um prompt de sistema personalizado e configuração de ferramentas.

list

Liste todos os agentes disponíveis.

matrix agent list

auth

Comando para gerenciar credenciais e login para provedores.

matrix auth [command]

O matrix é alimentado pela lista de provedores em Models.dev, então você pode usar matrix auth login para configurar chaves de API para qualquer provedor que você gostaria de usar. Isso é armazenado em ~/.local/share/matrix/auth.json.

matrix auth login

Quando o matrix é iniciado, ele carrega os provedores do arquivo de credenciais. E se houver chaves definidas em seus ambientes ou em um arquivo .env em seu projeto.

list

Lista todos os provedores autenticados conforme armazenado no arquivo de credenciais.

matrix auth list

Ou a versão curta.

matrix auth ls

logout

Desconecta você de um provedor limpando-o do arquivo de credenciais.

matrix auth logout

github

Gerencie o agente do GitHub para automação de repositórios.

matrix github [command]

install

Instale o agente do GitHub em seu repositório.

matrix github install

Isso configura o fluxo de trabalho necessário do GitHub Actions e o guia pelo processo de configuração. Saiba mais.

run

Execute o agente do GitHub. Isso é tipicamente usado em GitHub Actions.

matrix github run

Opções

Flag	Descrição
`--event`	Evento simulado do GitHub para executar o agente
`--token`	Token de acesso pessoal do GitHub

mcp

Gerencie servidores do Model Context Protocol.

matrix mcp [command]

add

Adicione um servidor MCP à sua configuração.

matrix mcp add

Este comando irá guiá-lo na adição de um servidor MCP local ou remoto.

list

Liste todos os servidores MCP configurados e seu status de conexão.

matrix mcp list

Ou use a versão curta.

matrix mcp ls

auth

Autentique-se com um servidor MCP habilitado para OAuth.

matrix mcp auth [name]

Se você não fornecer um nome de servidor, será solicitado que você selecione entre os servidores disponíveis habilitados para OAuth.

Você também pode listar servidores habilitados para OAuth e seu status de autenticação.

matrix mcp auth list

Ou use a versão curta.

matrix mcp auth ls

logout

Remova credenciais OAuth para um servidor MCP.

matrix mcp logout [name]

debug

Depure problemas de conexão OAuth para um servidor MCP.

matrix mcp debug <name>

models

Liste todos os modelos disponíveis dos provedores configurados.

matrix models [provider]

Este comando exibe todos os modelos disponíveis entre seus provedores configurados no formato provider/model.

Isso é útil para descobrir o nome exato do modelo a ser usado em sua configuração.

Você pode opcionalmente passar um ID de provedor para filtrar modelos por esse provedor.

matrix models anthropic

Opções

Flag	Descrição
`--refresh`	Atualiza o cache de modelos a partir do models.dev
`--verbose`	Use uma saída de modelo mais detalhada (inclui metadados como custos)

Use a flag --refresh para atualizar a lista de modelos em cache. Isso é útil quando novos modelos foram adicionados a um provedor e você deseja vê-los no matrix.

matrix models --refresh

run

Execute o matrix em modo não interativo passando um prompt diretamente.

matrix run [message..]

Isso é útil para scripts, automação ou quando você deseja uma resposta rápida sem iniciar o TUI completo. Por exemplo.

matrix run Explique o uso de context em Go

Você também pode se anexar a uma instância em execução do matrix serve para evitar tempos de inicialização a frio do servidor MCP em cada execução:

# Inicie um servidor sem cabeça em um terminal
matrix serve

# Em outro terminal, execute comandos que se anexam a ele
matrix run --attach http://localhost:4096 "Explique async/await em JavaScript"

Opções

Flag	Curto	Descrição
`--command`		O comando a ser executado, use mensagem para argumentos
`--continue`	`-c`	Continue a última sessão
`--session`	`-s`	ID da sessão para continuar
`--fork`		Criar um fork da sessão ao continuar (use com `--continue` ou `--session`)
`--share`		Compartilhe a sessão
`--model`	`-m`	Modelo a ser usado na forma de provider/model
`--agent`		Agente a ser usado
`--file`	`-f`	Arquivo(s) a serem anexados à mensagem
`--format`		Formato: padrão (formatado) ou json (eventos JSON brutos)
`--title`		Título para a sessão (usa o prompt truncado se nenhum valor for fornecido)
`--attach`		Anexe a um servidor matrix em execução (por exemplo, http://localhost:4096)
`--port`		Porta para o servidor local (padrão para porta aleatória)

serve

Inicie um servidor matrix sem cabeça para acesso à API. Confira a documentação do servidor para a interface HTTP completa.

matrix serve

Isso inicia um servidor HTTP que fornece acesso à funcionalidade do matrix sem a interface TUI. Defina MATRIX_SERVER_PASSWORD para habilitar a autenticação básica HTTP (o nome de usuário padrão é matrix).

Opções

Flag	Descrição
`--port`	Porta para escutar
`--hostname`	Nome do host para escutar
`--mdns`	Habilitar descoberta mDNS
`--cors`	Origem(ns) de navegador adicionais para permitir CORS

session

Gerencie sessões do matrix.

matrix session [command]

list

Liste todas as sessões do matrix.

matrix session list

Opções

Flag	Curto	Descrição
`--max-count`	`-n`	Limitar às N sessões mais recentes
`--format`		Formato de saída: tabela ou json (tabela)

stats

Mostre o uso de tokens e estatísticas de custo para suas sessões do matrix.

matrix stats

Opções

Flag	Descrição
`--days`	Mostre estatísticas dos últimos N dias (todo o tempo)
`--tools`	Número de ferramentas a serem mostradas (todas)
`--models`	Mostre a divisão do uso de modelos (oculto por padrão). Passe um número para mostrar os N principais
`--project`	Filtrar por projeto (todos os projetos, string vazia: projeto atual)

export

Exporte dados da sessão como JSON.

matrix export [sessionID]

Se você não fornecer um ID de sessão, será solicitado que você selecione entre as sessões disponíveis.

import

Importe dados da sessão de um arquivo JSON ou URL de compartilhamento do matrix.

matrix import <file>

Você pode importar de um arquivo local ou de uma URL de compartilhamento do matrix.

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

web

Inicie um servidor matrix sem cabeça com uma interface web.

matrix web

Isso inicia um servidor HTTP e abre um navegador para acessar o matrix através de uma interface web. Defina MATRIX_SERVER_PASSWORD para habilitar a autenticação básica HTTP (o nome de usuário padrão é matrix).

Opções

Flag	Descrição
`--port`	Porta para escutar
`--hostname`	Nome do host para escutar
`--mdns`	Habilitar descoberta mDNS
`--cors`	Origem(ns) de navegador adicionais para permitir CORS

acp

Inicie um servidor ACP (Agent Client Protocol).

matrix acp

Este comando inicia um servidor ACP que se comunica via stdin/stdout usando nd-JSON.

Opções

Flag	Descrição
`--cwd`	Diretório de trabalho
`--port`	Porta para escutar
`--hostname`	Nome do host para escutar

uninstall

Desinstale o matrix e remova todos os arquivos relacionados.

matrix uninstall

Opções

Flag	Curto	Descrição
`--keep-config`	`-c`	Manter arquivos de configuração
`--keep-data`	`-d`	Manter dados de sessão e snapshots
`--dry-run`		Mostrar o que seria removido sem remover
`--force`	`-f`	Pular prompts de confirmação

upgrade

Atualiza o matrix para a versão mais recente ou uma versão específica.

matrix upgrade [target]

Para atualizar para a versão mais recente.

matrix upgrade

Para atualizar para uma versão específica.

matrix upgrade v0.1.48

Opções

Flag	Curto	Descrição
`--method`	`-m`	O método de instalação que foi usado; curl, npm, pnpm, bun, brew

Opções Globais

A CLI do matrix aceita as seguintes flags globais.

Flag	Curto	Descrição
`--help`	`-h`	Exibir ajuda
`--version`	`-v`	Imprimir número da versão
`--print-logs`		Imprimir logs no stderr
`--log-level`		Nível de log (DEBUG, INFO, WARN, ERROR)

Variáveis de ambiente

O matrix pode ser configurado usando variáveis de ambiente.

Variável	Tipo	Descrição
`MATRIX_AUTO_SHARE`	boolean	Compartilhar sessões automaticamente
`MATRIX_GIT_BASH_PATH`	string	Caminho para o executável do Git Bash no Windows
`MATRIX_CONFIG`	string	Caminho para o arquivo de configuração
`MATRIX_CONFIG_DIR`	string	Caminho para o diretório de configuração
`MATRIX_CONFIG_CONTENT`	string	Conteúdo de configuração json inline
`MATRIX_DISABLE_AUTOUPDATE`	boolean	Desabilitar verificações de atualização automática
`MATRIX_DISABLE_PRUNE`	boolean	Desabilitar a poda de dados antigos
`MATRIX_DISABLE_TERMINAL_TITLE`	boolean	Desabilitar atualizações automáticas do título do terminal
`MATRIX_PERMISSION`	string	Configuração de permissões json inline
`MATRIX_DISABLE_DEFAULT_PLUGINS`	boolean	Desabilitar plugins padrão
`MATRIX_DISABLE_LSP_DOWNLOAD`	boolean	Desabilitar downloads automáticos do servidor LSP
`MATRIX_ENABLE_EXPERIMENTAL_MODELS`	boolean	Habilitar modelos experimentais
`MATRIX_DISABLE_AUTOCOMPACT`	boolean	Desabilitar compactação automática de contexto
`MATRIX_DISABLE_CLAUDE_CODE`	boolean	Desabilitar leitura de `.claude` (prompt + habilidades)
`MATRIX_DISABLE_CLAUDE_CODE_PROMPT`	boolean	Desabilitar leitura de `~/.claude/CLAUDE.md`
`MATRIX_DISABLE_CLAUDE_CODE_SKILLS`	boolean	Desabilitar carregamento de `.claude/skills`
`MATRIX_DISABLE_MODELS_FETCH`	boolean	Desabilitar busca de modelos de fontes remotas
`MATRIX_FAKE_VCS`	string	Provedor VCS falso para fins de teste
`MATRIX_DISABLE_FILETIME_CHECK`	boolean	Desabilitar verificação de tempo de arquivo para otimização
`MATRIX_CLIENT`	string	Identificador do cliente (padrão é `cli`)
`MATRIX_ENABLE_EXA`	boolean	Habilitar ferramentas de busca web Exa
`MATRIX_SERVER_PASSWORD`	string	Habilitar autenticação básica para `serve`/`web`
`MATRIX_SERVER_USERNAME`	string	Substituir nome de usuário de autenticação básica (padrão `matrix`)
`MATRIX_MODELS_URL`	string	URL personalizada para buscar configuração de modelos

Experimental

Essas variáveis de ambiente habilitam recursos experimentais que podem mudar ou ser removidos.

Variável	Tipo	Descrição
`MATRIX_EXPERIMENTAL`	boolean	Habilitar todos os recursos experimentais
`MATRIX_EXPERIMENTAL_ICON_DISCOVERY`	boolean	Habilitar descoberta de ícones
`MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECT`	boolean	Desabilitar cópia ao selecionar no TUI
`MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS`	number	Tempo limite padrão para comandos bash em ms
`MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAX`	number	Máximo de tokens de saída para respostas LLM
`MATRIX_EXPERIMENTAL_FILEWATCHER`	boolean	Habilitar monitoramento de arquivos para todo o diretório
`MATRIX_EXPERIMENTAL_OXFMT`	boolean	Habilitar formatador oxfmt
`MATRIX_EXPERIMENTAL_LSP_TOOL`	boolean	Habilitar ferramenta LSP experimental
`MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHER`	boolean	Desabilitar monitoramento de arquivos
`MATRIX_EXPERIMENTAL_EXA`	boolean	Habilitar recursos experimentais do Exa
`MATRIX_EXPERIMENTAL_LSP_TY`	boolean	Habilitar TY LSP para arquivos python
`MATRIX_EXPERIMENTAL_MARKDOWN`	boolean	Habilitar recursos experimentais de markdown
`MATRIX_EXPERIMENTAL_PLAN_MODE`	boolean	Habilitar modo de plano