Gå til innholdet

CLI

Matrix CLI-alternativer og kommandoer.

Matrix CLI starter som standard TUI når den kjøres uten noen argumenter.

Terminal window
matrix

Men den godtar også kommandoer som dokumentert på denne siden. Dette lar deg samhandle med Matrix programmatisk.

Terminal window
matrix run "Explain how closures work in JavaScript"

tui

Start Matrix-terminalbrukergrensesnittet.

Terminal window
matrix [project]

Flagg

FlaggKortBeskrivelse
--continue-cFortsett siste økt
--session-sØkt ID for å fortsette
--forkForgren økten ved fortsettelse (bruk med --continue eller --session)
--promptLedetekst som skal brukes
--model-mModell å bruke i form av leverandør/modell
--agentAgent som skal brukes
--portPort å lytte på
--hostnameVertsnavn å lytte på

Kommandoer

Matrix CLI har også følgende kommandoer.


agent

Administrer agenter for Matrix.

Terminal window
matrix agent [command]

attach

Koble en terminal til en allerede kjørende Matrix-backend-server startet via serve eller web kommandoer.

Terminal window
matrix attach [url]

Dette gjør det mulig å bruke TUI med en ekstern Matrix-backend. For eksempel:

Terminal window
# 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

Flagg

FlaggKortBeskrivelse
--dirArbeidskatalog for å starte TUI i
--session-sØkt ID for å fortsette

create

Opprett en ny agent med tilpasset konfigurasjon.

Terminal window
matrix agent create

Denne kommandoen vil veilede deg gjennom å lage en ny agent med en tilpasset systemmelding og verktøykonfigurasjon.


list

List opp alle tilgjengelige agenter.

Terminal window
matrix agent list

auth

Kommando for administrasjon av påloggingsinformasjon og innlogging for leverandører.

Terminal window
matrix auth [command]

login

Matrix drives av leverandørlisten på Models.dev, så du kan bruke matrix auth login til å konfigurere API-nøkler for enhver leverandør du vil bruke. Dette er lagret i ~/.local/share/matrix/auth.json.

Terminal window
matrix auth login

Når Matrix starter opp, laster den leverandørene fra filen med påloggingsinformasjon. Og hvis det er noen nøkler definert i miljøene dine eller en .env-fil i prosjektet ditt.


list

Viser alle de autentiserte leverandørene som er lagret i filen med påloggingsinformasjon.

Terminal window
matrix auth list

Eller bruk kortversjonen.

Terminal window
matrix auth ls

logout

Logger deg ut av en leverandør ved å fjerne den fra filen med påloggingsinformasjon.

Terminal window
matrix auth logout

github

Administrer GitHub-agenten for depotautomatisering.

Terminal window
matrix github [command]

install

Installer GitHub-agenten i depotet ditt.

Terminal window
matrix github install

Dette setter opp den nødvendige GitHub Actions-arbeidsflyten og veileder deg gjennom konfigurasjonsprosessen. Finn ut mer.


run

Kjør GitHub-agenten. Dette brukes vanligvis i GitHub Actions.

Terminal window
matrix github run
Flagg
FlaggBeskrivelse
--eventGitHub mock-hendelse agenten skal kjøres for
--tokenGitHub personlig tilgangsnøkkel

mcp

Administrer Model Context Protocol-servere.

Terminal window
matrix mcp [command]

add

Legg til en MCP-server til konfigurasjonen.

Terminal window
matrix mcp add

Denne kommandoen vil veilede deg gjennom å legge til enten en lokal eller ekstern MCP-server.


list

Liste alle konfigurerte MCP-servere og deres tilkoblingsstatus.

Terminal window
matrix mcp list

Eller bruk den korte versjonen.

Terminal window
matrix mcp ls

auth

Autentiser med en OAuth-aktivert MCP-server.

Terminal window
matrix mcp auth [name]

Hvis du ikke oppgir et servernavn, blir du bedt om å velge blant tilgjengelige OAuth-kompatible servere.

Du kan også liste opp OAuth-kompatible servere og deres autentiseringsstatus.

Terminal window
matrix mcp auth list

Eller bruk den korte versjonen.

Terminal window
matrix mcp auth ls

logout

Fjern OAuth-påloggingsinformasjon for en MCP-server.

Terminal window
matrix mcp logout [name]

debug

Feilsøk OAuth-tilkoblingsproblemer for en MCP-server.

Terminal window
matrix mcp debug <name>

models

List opp alle tilgjengelige modeller fra konfigurerte leverandører.

Terminal window
matrix models [provider]

Denne kommandoen viser alle modeller som er tilgjengelige på tvers av dine konfigurerte leverandører i formatet provider/model.

Dette er nyttig for å finne ut det eksakte modellnavnet som skal brukes i din konfigurasjon.

Du kan eventuelt sende en leverandør ID for å filtrere modeller etter den leverandøren.

Terminal window
matrix models anthropic

Flagg

FlaggBeskrivelse
--refreshOppdater modellbufferen fra models.dev
--verboseBruk mer detaljert modellutdata (inkluderer metadata som kostnader)

Bruk --refresh-flagget for å oppdatere den bufrede modelllisten. Dette er nyttig når nye modeller er lagt til en leverandør og du vil se dem i Matrix.

Terminal window
matrix models --refresh

run

Kjør Matrix i ikke-interaktiv modus ved å sende en melding direkte.

Terminal window
matrix run [message..]

Dette er nyttig for skripting, automatisering eller når du vil ha et raskt svar uten å starte hele TUI. For eksempel.

Terminal window
matrix run Explain the use of context in Go

Du kan også koble til en kjørende matrix serve-forekomst for å unngå MCP-serveres kaldstarttid ved hver kjøring:

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

Flagg

FlaggKortBeskrivelse
--commandKommandoen for å kjøre, bruk melding for args
--continue-cFortsett siste økt
--session-sØkt ID for å fortsette
--forkForgren økten ved fortsettelse (bruk med --continue eller --session)
--shareDel økten
--model-mModell å bruke i form av leverandør/modell
--agentAgent å bruke
--file-fFil(er) som skal legges ved meldingen
--formatFormat: standard (formatert) eller json (rå JSON hendelser)
--titleTittel for økten (bruker avkortet ledetekst hvis ingen verdi er oppgitt)
--attachKoble til en kjørende Matrix-server (f.eks. http://localhost:4096)
--portPort for den lokale serveren (standard til tilfeldig port)

serve

Start en headless Matrix-server for API-tilgang. Sjekk ut server-dokumentene for hele HTTP-grensesnittet.

Terminal window
matrix serve

Dette starter en HTTP-server som gir API tilgang til Matrix-funksjonalitet uten TUI-grensesnittet. Sett MATRIX_SERVER_PASSWORD for å aktivere HTTP grunnleggende autentisering (brukernavn er standard til matrix).

Flagg

FlaggBeskrivelse
--portPort å lytte på
--hostnameVertsnavn å lytte på
--mdnsAktiver mDNS-oppdagelse
--corsYtterligere nettleseropprinnelse som tillater CORS

session

Administrer Matrix-økter.

Terminal window
matrix session [command]

list

List opp alle Matrix-økter.

Terminal window
matrix session list
Flagg
FlaggKortBeskrivelse
--max-count-nBegrens til N siste økter
--formatUtdataformat: tabell eller json (tabell)

stats

Vis tokenbruk og kostnadsstatistikk for Matrix-øktene dine.

Terminal window
matrix stats

Flagg

FlaggBeskrivelse
--daysVis statistikk for de siste N dagene (hele tiden)
--toolsAntall verktøy som skal vises (alle)
--modelsVis oversikt over modellbruk (skjult som standard). Gi et tall for å vise topp N
--projectFiltrer etter prosjekt (alle prosjekter, tom streng: gjeldende prosjekt)

export

Eksporter øktdata som JSON.

Terminal window
matrix export [sessionID]

Hvis du ikke gir en økt ID, blir du bedt om å velge fra tilgjengelige økter.


import

Importer øktdata fra en JSON-fil eller en Matrix share-URL.

Terminal window
matrix import <file>

Du kan importere fra en lokal fil eller en Matrix share-URL.

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

web

Start en headless Matrix-server med et webgrensesnitt.

Terminal window
matrix web

Dette starter en HTTP-server og åpner en nettleser for å få tilgang til Matrix via et nettgrensesnitt. Sett MATRIX_SERVER_PASSWORD for å aktivere HTTP grunnleggende autentisering (brukernavn er standard til matrix).

Flagg

FlaggBeskrivelse
--portPort å lytte på
--hostnameVertsnavn å lytte på
--mdnsAktiver mDNS-oppdagelse
--corsYtterligere nettleseropprinnelse som tillater CORS

acp

Start en ACP (Agent Client Protocol) server.

Terminal window
matrix acp

Denne kommandoen starter en ACP-server som kommuniserer via stdin/stdout ved å bruke nd-JSON.

Flagg

FlaggBeskrivelse
--cwdArbeidskatalog
--portPort å lytte på
--hostnameVertsnavn å lytte på

uninstall

Avinstaller Matrix og fjern alle relaterte filer.

Terminal window
matrix uninstall

Flagg

FlaggKortBeskrivelse
--keep-config-cBehold konfigurasjonsfiler
--keep-data-dBehold øktdata og øyeblikksbilder
--dry-runVis hva som ville blitt fjernet uten å fjerne
--force-fHopp over bekreftelsesforespørsler

upgrade

Oppdaterer Matrix til siste versjon eller en spesifikk versjon.

Terminal window
matrix upgrade [target]

For å oppgradere til siste versjon.

Terminal window
matrix upgrade

For å oppgradere til en bestemt versjon.

Terminal window
matrix upgrade v0.1.48

Flagg

FlaggKortBeskrivelse
--method-mInstallasjonsmetoden som ble brukt: curl, npm, pnpm, bun, brew

Globale flagg

Matrix CLI bruker følgende globale flagg.

FlaggKortBeskrivelse
--help-hVis hjelp
--version-vSkriv ut versjonsnummer
--print-logsSkriv ut logger til stderr
--log-levelLoggnivå (DEBUG, INFO, WARN, ERROR)

Miljøvariabler

Matrix kan konfigureres ved hjelp av miljøvariabler.

VariabelTypeBeskrivelse
MATRIX_AUTO_SHAREboolskDel økter automatisk
MATRIX_GIT_BASH_PATHstrengBane til Git Bash-kjørbar på Windows
MATRIX_CONFIGstrengBane til konfigurasjonsfil
MATRIX_TUI_CONFIGstrengBane til TUI-konfigurasjonsfil
MATRIX_CONFIG_DIRstrengBane til konfigurasjonskatalog
MATRIX_CONFIG_CONTENTstrengInnebygd json-konfigurasjonsinnhold
MATRIX_DISABLE_AUTOUPDATEboolskDeaktiver automatiske oppdateringskontroller
MATRIX_DISABLE_PRUNEboolskDeaktiver beskjæring av gamle data
MATRIX_DISABLE_TERMINAL_TITLEboolskDeaktiver automatiske terminaltitteloppdateringer
MATRIX_PERMISSIONstrengInnebygd json-tillatelseskonfigurasjon
MATRIX_DISABLE_DEFAULT_PLUGINSboolskDeaktiver standard plugins
MATRIX_DISABLE_LSP_DOWNLOADboolskDeaktiver automatiske LSP servernedlastinger
MATRIX_ENABLE_EXPERIMENTAL_MODELSboolskAktiver eksperimentelle modeller
MATRIX_DISABLE_AUTOCOMPACTboolskDeaktiver automatisk kontekstkomprimering
MATRIX_DISABLE_CLAUDE_CODEboolskDeaktiver lesing fra .claude (spørsmål + ferdigheter)
MATRIX_DISABLE_CLAUDE_CODE_PROMPTboolskDeaktiver lesing ~/.claude/CLAUDE.md
MATRIX_DISABLE_CLAUDE_CODE_SKILLSboolskDeaktiver innlasting av .claude/skills
MATRIX_DISABLE_MODELS_FETCHboolskDeaktiver henting av modeller fra eksterne kilder
MATRIX_FAKE_VCSstrengFalsk VCS-leverandør for testformål
MATRIX_DISABLE_FILETIME_CHECKboolskDeaktiver filtidskontroll for optimalisering
MATRIX_CLIENTstrengKlientidentifikator (standard til cli)
MATRIX_ENABLE_EXAboolskAktiver Exa-nettsøkeverktøy
MATRIX_SERVER_PASSWORDstrengAktiver grunnleggende autentisering for serve/web
MATRIX_SERVER_USERNAMEstrengOverstyr grunnleggende autentiseringsbrukernavn (standard matrix)
MATRIX_MODELS_URLstrengEgendefinert URL for henting av modellkonfigurasjon

Eksperimentelt

Disse miljøvariablene muliggjør eksperimentelle funksjoner som kan endres eller fjernes.

VariabelTypeBeskrivelse
MATRIX_EXPERIMENTALboolskAktiver alle eksperimentelle funksjoner
MATRIX_EXPERIMENTAL_ICON_DISCOVERYboolskAktiver ikonoppdagelse
MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECTboolskDeaktiver kopi ved valg i TUI
MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MStallStandard tidsavbrudd for bash-kommandoer i ms
MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAXtallMaks Output Tokens for LLM-svar
MATRIX_EXPERIMENTAL_FILEWATCHERboolskAktiver filovervåker for hele dir
MATRIX_EXPERIMENTAL_OXFMTboolskAktiver oxfmt formatter
MATRIX_EXPERIMENTAL_LSP_TOOLboolskAktiver eksperimentelt LSP-verktøy
MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHERboolskDeaktiver filovervåking
MATRIX_EXPERIMENTAL_EXAboolskAktiver eksperimentelle Exa-funksjoner
MATRIX_EXPERIMENTAL_LSP_TYboolskAktiver TY LSP for python-filer
MATRIX_EXPERIMENTAL_MARKDOWNboolskAktiver eksperimentelle Markdown-funksjoner
MATRIX_EXPERIMENTAL_PLAN_MODEboolskAktiver planmodus