Gå til indhold

CLI

Matrix CLI muligheder og kommandoer.

Matrix CLI starter som standard TUI, når den kører uden nogen argumenter.

Terminal window
matrix

Men den accepterer også kommandoer som dokumenteret på denne side. Dette giver dig mulighed for at interagere med Matrix programmatisk.

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

tui

Start Matrix terminalbrugergrænsefladen.

Terminal window
matrix [project]

Flag

FlagKortBeskrivelse
--continue-cFortsæt sidste session
--session-sSessions-id for at fortsætte
--forkForgren sessionen ved fortsættelse (brug med --continue eller --session)
--promptSpørg om at bruge
--model-mModel til brug i form af provider/model
--agentAgent hos bruge
--portPort at lytte på
--hostnameVærtsnavn at lytte på

Kommandoer

Matrix CLI har også følgende kommandoer.


agent

Administrer agenter i Matrix.

Terminal window
matrix agent [command]

attach

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

Terminal window
matrix attach [url]

Dette gør det muligt at bruge 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

Flag

FlagKortBeskrivelse
--dirArbejdsmappe til at starte TUI i
--session-sSessions-id for at fortsætte

create

Opret en ny agent med brugerdefineret konfiguration.

Terminal window
matrix agent create

Denne kommando vil guide dig gennem oprettelse af en ny agent med en brugerdefineret systemprompt og værktøjskonfiguration.


list

Liste over alle tilgængelige agenter.

Terminal window
matrix agent list

auth

Kommando til at administrere legitimationsoplysninger og login for udbydere.

Terminal window
matrix auth [command]

login

Matrix drives af udbyderlisten på Models.dev, så du kan bruge matrix auth login til at konfigurere API-nøgler for enhver udbyder, du vil bruge. Dette er gemt i ~/.local/share/matrix/auth.json.

Terminal window
matrix auth login

Når Matrix starter op, indlæser den udbyderne fra legitimationsfilen. Og hvis der er nogen nøgler defineret i dine miljøer eller en .env fil i dit projekt.


list

Viser alle de godkendte udbydere som gemt i legitimationsfilen.

Terminal window
matrix auth list

Eller den korte version.

Terminal window
matrix auth ls

logout

Logger dig ud af en udbyder ved at rydde den fra legitimationsfilen.

Terminal window
matrix auth logout

github

Administrator GitHub-agenten til lagerautomatisering.

Terminal window
matrix github [command]

install

Installatør GitHub-agenten i dit lager.

Terminal window
matrix github install

Dette opsætter det nødvendige GitHub Actions workflow og guider dig gennem konfigurationsprocessen. Learn more.


run

Kør GitHub-agenten. Dette bruges typisk i GitHub Actions.

Terminal window
matrix github run
Flag
FlagBeskrivelse
--eventGitHub mock begivenhed for at køre agenten for
--tokenGitHub personlig adgangstoken

mcp

Administrator Model Context Protocol-servere.

Terminal window
matrix mcp [command]

add

Tilføj en MCP-server til din konfiguration.

Terminal window
matrix mcp add

Denne kommando vil guide dig gennem tilføjelse af enten en lokal eller ekstern MCP-server.


list

Liste over alle konfigurerede MCP-servere og deres forbindelsesstatus.

Terminal window
matrix mcp list

Eller brug den korte version.

Terminal window
matrix mcp ls

auth

Godkendt med en OAuth-aktiveret MCP-server.

Terminal window
matrix mcp auth [name]

Hvis du ikke angiver et servernavn, bliver du bedt om at vælge blandt tilgængelige OAuth-kompatible servere.

Du kan også angive OAuth-kompatible servere og deres godkendelsesstatus.

Terminal window
matrix mcp auth list

Eller brug den korte version.

Terminal window
matrix mcp auth ls

logout

Fjern OAuth-legitimationsoplysninger for en MCP-server.

Terminal window
matrix mcp logout [name]

debug

Fejlfinding af OAuth-forbindelsesproblemer for en MCP-server.

Terminal window
matrix mcp debug <name>

models

Liste over alle tilgængelige modeller fra konfigurerede udbydere.

Terminal window
matrix models [provider]

Denne kommando viser alle tilgængelige modeller på tværs af dine konfigurerede udbydere i formatet provider/model.

Dette er nyttigt til at finde ud af det nøjagtige modelnavn, der skal bruges i your config.

Du kan eventuelt videregive et udbyder-id for at filtrere modeller efter den udbyder.

Terminal window
matrix models anthropic

Flag

FlagBeskrivelse
--refreshOpdater modelcachen fra models.dev
--verboseBrug mere detaljeret modeloutput (inkluderer metadata som omkostninger)

Brug flaget --refresh til at opdatere den cachelagrede modelliste. Dette er nyttigt, når nye modeller er blevet tilføjet til en udbyder, og du vil se dem i Matrix.

Terminal window
matrix models --refresh

run

Kør matrix i ikke-interaktiv tilstand ved at sende en prompt direkte.

Terminal window
matrix run [message..]

Dette er nyttigt til scripting, automatisering, eller når du vil have et hurtigt svar uden at starte hele TUI. F.eks.

Terminal window
matrix run Explain the use of context in Go

Du kan også vedhæfte til en kørende matrix serve-instans for at undgå MCP serverens kolde opstartstider ved hver kørsel:

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"

Flag

FlagKortBeskrivelse
--commandKommandoen til at køre, brug besked til args
--continue-cFortsæt sidste session
--session-sSessions-id for at fortsætte
--forkForgren sessionen ved fortsættelse (brug med --continue eller --session)
--shareDel sessionen
--model-mModel til brug i form af provider/model
--agentAgent til brug
--file-fFil(er), der skal vedhæftes til meddelelsen
--formatFormat: standard (formateret) eller json (rå JSON hændelser)
--titleTitel for sessionen (bruger trunkeret prompt, hvis der ikke er angivet nogen værdi)
--attachTilslut til en kørende matrix-server (f.eks. http://localhost:4096)
--portPort til den lokale server (standard til vilkårlig port)

serve

Start en hovedløs Matrix-server til API-adgang. Tjek server docs for den fulde HTTP-grænseflade.

Terminal window
matrix serve

Dette starter en HTTP-server, der giver API-adgang til matrix-funktionalitet uden TUI-grænsefladen. Indstil MATRIX_SERVER_PASSWORD for at aktivere HTTP grundlæggende godkendelse (brugernavn er standard til matrix).

Flag

FlagBeskrivelse
--portPort at lytte på
--hostnameVærtsnavn at lytte på
--mdnsAktiver mDNS-opdagelse
--corsYderligere browseroprindelse til at tillade CORS

session

Administrator Matrix sessionsholder.

Terminal window
matrix session [command]

list

Liste over alle Matrix sessioner.

Terminal window
matrix session list
Flag
FlagKortBeskrivelse
--max-count-nBegræns til N seneste sessioner
--formatOutputformat: tabel eller json (tabel)

stats

Vis tokenbrug og omkostningsstatistikker for dine Matrix-sessioner.

Terminal window
matrix stats

Flag

FlagBeskrivelse
--daysVis statistik for de sidste N dage (hele tiden)
--toolsAntal værktøjer, der skal vises (alle)
--modelsVis modelbrugsopdeling (skjult som standard). Send et tal for at vise top N
--projectFiltre efter projekt (alle projekter, tom streng: nuværende projekt)

export

Eksporter sessionsdata som JSON.

Terminal window
matrix export [sessionID]

Hvis du ikke angiver et sessions-id, bliver du bedt om at vælge mellem tilgængelige sessioner.


import

Importer sessionsdata fra en JSON fil eller Matrix del 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 hovedløs Matrix-server med en webgrænseflade.

Terminal window
matrix web

Dette starter en HTTP-server og åbner en webbrowser for at få adgang til Matrix via en webgrænseflade. Indstil MATRIX_SERVER_PASSWORD for at aktivere HTTP grundlæggende godkendelse (brugernavn er standard til matrix).

Flag

FlagBeskrivelse
--portPort at lytte på
--hostnameVærtsnavn at lytte på
--mdnsAktiver mDNS-opdagelse
--corsYderligere browseroprindelse til at tillade CORS

acp

Start en ACP-server (Agent Client Protocol).

Terminal window
matrix acp

Denne kommando starter en ACP-server, der kommunikerer via stdin/stdout ved hjælp af nd-JSON.

Flag

FlagBeskrivelse
--cwdArbejdsmappe
--portPort at lytte på
--hostnameVærtsnavn at lytte på

uninstall

Afinstaller Matrix og fjern alle relaterede filer.

Terminal window
matrix uninstall

Flag

FlagKortBeskrivelse
--keep-config-cSe konfigurationsfiler
--keep-data-dGem sessionsdata og snapshots
--dry-runVis, hvad der ville blive fjernet uden at fjerne
--force-fSpring bekræftelsesspørgsmål over

upgrade

Opdaterer Matrix til den nyeste version eller en specifik version.

Terminal window
matrix upgrade [target]

For at opgradere til den nyeste version.

Terminal window
matrix upgrade

For at opgradere til en bestemt version.

Terminal window
matrix upgrade v0.1.48

upgrade

FlagKortBeskrivelse
--method-mInstallationsmetoden, der blev brugt; curl, npm, pnpm, bun, brew

Globale flag

matrix CLI tager følgende globale flag.

FlagKortBeskrivelse
--help-hVis hjælp
--version-vUdskriftsversionsnummer
--print-logsUdskriv logfiler til stderr
--log-levelLogniveau (DEBUG, INFO, WARN, ERROR)

Miljøvariabler

Matrix kan konfigureres ved hjælp af miljøvariabler.

VariabelSkrivBeskrivelse
MATRIX_AUTO_SHAREbooleanDel automatisk session
MATRIX_GIT_BASH_PATHstringSti til Git Bash eksekverbar på Windows
MATRIX_CONFIGstringSti til konfigurationsfil
MATRIX_TUI_CONFIGstringSti til TUI-konfigurationsfil
MATRIX_CONFIG_DIRstringSti til konfigurationsmappe
MATRIX_CONFIG_CONTENTstringIndbygget json-konfigurationsindhold
MATRIX_DISABLE_AUTOUPDATEbooleanDeaktiver automatisk opdateringskontrol
MATRIX_DISABLE_PRUNEbooleanDeaktiver beskæring af gamle data
MATRIX_DISABLE_TERMINAL_TITLEbooleanDeaktiver automatisk opdatering af terminaltitel
MATRIX_PERMISSIONstringIndbygget json-tilladelseskonfiguration
MATRIX_DISABLE_DEFAULT_PLUGINSbooleanDeaktiver standard plugins
MATRIX_DISABLE_LSP_DOWNLOADbooleanDeaktiver automatisk LSP-serverdownloads
MATRIX_ENABLE_EXPERIMENTAL_MODELSbooleanAktive eksperimentelle modeller
MATRIX_DISABLE_AUTOCOMPACTbooleanDeaktiver automatisk kontekstkomprimering
MATRIX_DISABLE_CLAUDE_CODEbooleanDeaktiver læsning fra .claude (prompt + færdigheder)
MATRIX_DISABLE_CLAUDE_CODE_PROMPTbooleanDeaktiver læsning ~/.claude/CLAUDE.md
MATRIX_DISABLE_CLAUDE_CODE_SKILLSbooleanDeaktiver indlæsning af .claude/skills
MATRIX_DISABLE_MODELS_FETCHbooleanDeaktivering af modeller fra eksterne kilder
MATRIX_FAKE_VCSstringFalsk VCS-udbyder til testformål
MATRIX_DISABLE_FILETIME_CHECKbooleanDeaktiver filtidskontrol for optimering
MATRIX_CLIENTstringKlient-id (standard til cli)
MATRIX_ENABLE_EXAbooleanAktiver Exa-websøgeværktøjer
MATRIX_SERVER_PASSWORDstringAktiver grundlæggende godkendelse for serve/web
MATRIX_SERVER_USERNAMEstringTilsidesæt grundlæggende godkendelsesbrugernavn (standard matrix)
MATRIX_MODELS_URLstringBrugerdefineret URL til hentning af modelkonfiguration

Eksperimentel

Disse miljøvariabler muliggør eksperimentelle funktioner, der kan ændres eller fjernes.

VariabelSkrivBeskrivelse
MATRIX_EXPERIMENTALbooleanAktiver alle eksperimentelle funktioner
MATRIX_EXPERIMENTAL_ICON_DISCOVERYbooleanAktiver ikonopdagelse
MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanDeaktiver kopi ved valg i TUI
MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnummerStandard timeout for bash-kommandoer i ms
MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAXnummerMaks. output-tokens for LLM-svar
MATRIX_EXPERIMENTAL_FILEWATCHERbooleanAktiver filovervågning for hele dir
MATRIX_EXPERIMENTAL_OXFMTbooleanAktiver oxfmt formatter
MATRIX_EXPERIMENTAL_LSP_TOOLbooleanAktive eksperimenter LSP værktøj
MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanDeaktiver filovervågning
MATRIX_EXPERIMENTAL_EXAbooleanAktive eksperimenter Exa-funktioner
MATRIX_EXPERIMENTAL_LSP_TYbooleanAktiver TY LSP for python-filer
MATRIX_EXPERIMENTAL_MARKDOWNbooleanAktive eksperimentelle markdown-funktioner
MATRIX_EXPERIMENTAL_PLAN_MODEbooleanAktiver plantilstand