CLI
Matrix CLI muligheder og kommandoer.
Matrix CLI starter som standard TUI, når den kører uden nogen argumenter.
matrixMen den accepterer også kommandoer som dokumenteret på denne side. Dette giver dig mulighed for at interagere med Matrix programmatisk.
matrix run "Explain how closures work in JavaScript"tui
Start Matrix terminalbrugergrænsefladen.
matrix [project]Flag
| Flag | Kort | Beskrivelse |
|---|---|---|
--continue | -c | Fortsæt sidste session |
--session | -s | Sessions-id for at fortsætte |
--fork | Forgren sessionen ved fortsættelse (brug med --continue eller --session) | |
--prompt | Spørg om at bruge | |
--model | -m | Model til brug i form af provider/model |
--agent | Agent hos bruge | |
--port | Port at lytte på | |
--hostname | Værtsnavn at lytte på |
Kommandoer
Matrix CLI har også følgende kommandoer.
agent
Administrer agenter i Matrix.
matrix agent [command]attach
Tilslut en terminal til en allerede kørende Matrix backend-server startet via serve eller web kommandoer.
matrix attach [url]Dette gør det muligt at bruge TUI med en ekstern Matrix backend. For eksempel:
# Start the backend server for web/mobile accessmatrix web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendmatrix attach http://10.20.30.40:4096Flag
| Flag | Kort | Beskrivelse |
|---|---|---|
--dir | Arbejdsmappe til at starte TUI i | |
--session | -s | Sessions-id for at fortsætte |
create
Opret en ny agent med brugerdefineret konfiguration.
matrix agent createDenne 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.
matrix agent listauth
Kommando til at administrere legitimationsoplysninger og login for udbydere.
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.
matrix auth loginNå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.
matrix auth listEller den korte version.
matrix auth lslogout
Logger dig ud af en udbyder ved at rydde den fra legitimationsfilen.
matrix auth logoutgithub
Administrator GitHub-agenten til lagerautomatisering.
matrix github [command]install
Installatør GitHub-agenten i dit lager.
matrix github installDette 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.
matrix github runFlag
| Flag | Beskrivelse |
|---|---|
--event | GitHub mock begivenhed for at køre agenten for |
--token | GitHub personlig adgangstoken |
mcp
Administrator Model Context Protocol-servere.
matrix mcp [command]add
Tilføj en MCP-server til din konfiguration.
matrix mcp addDenne 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.
matrix mcp listEller brug den korte version.
matrix mcp lsauth
Godkendt med en OAuth-aktiveret MCP-server.
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.
matrix mcp auth listEller brug den korte version.
matrix mcp auth lslogout
Fjern OAuth-legitimationsoplysninger for en MCP-server.
matrix mcp logout [name]debug
Fejlfinding af OAuth-forbindelsesproblemer for en MCP-server.
matrix mcp debug <name>models
Liste over alle tilgængelige modeller fra konfigurerede udbydere.
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.
matrix models anthropicFlag
| Flag | Beskrivelse |
|---|---|
--refresh | Opdater modelcachen fra models.dev |
--verbose | Brug 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.
matrix models --refreshrun
Kør matrix i ikke-interaktiv tilstand ved at sende en prompt direkte.
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.
matrix run Explain the use of context in GoDu kan også vedhæfte til en kørende matrix serve-instans for at undgå MCP serverens kolde opstartstider ved hver kørsel:
# Start a headless server in one terminalmatrix serve
# In another terminal, run commands that attach to itmatrix run --attach http://localhost:4096 "Explain async/await in JavaScript"Flag
| Flag | Kort | Beskrivelse |
|---|---|---|
--command | Kommandoen til at køre, brug besked til args | |
--continue | -c | Fortsæt sidste session |
--session | -s | Sessions-id for at fortsætte |
--fork | Forgren sessionen ved fortsættelse (brug med --continue eller --session) | |
--share | Del sessionen | |
--model | -m | Model til brug i form af provider/model |
--agent | Agent til brug | |
--file | -f | Fil(er), der skal vedhæftes til meddelelsen |
--format | Format: standard (formateret) eller json (rå JSON hændelser) | |
--title | Titel for sessionen (bruger trunkeret prompt, hvis der ikke er angivet nogen værdi) | |
--attach | Tilslut til en kørende matrix-server (f.eks. http://localhost:4096) | |
--port | Port 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.
matrix serveDette 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
| Flag | Beskrivelse |
|---|---|
--port | Port at lytte på |
--hostname | Værtsnavn at lytte på |
--mdns | Aktiver mDNS-opdagelse |
--cors | Yderligere browseroprindelse til at tillade CORS |
session
Administrator Matrix sessionsholder.
matrix session [command]list
Liste over alle Matrix sessioner.
matrix session listFlag
| Flag | Kort | Beskrivelse |
|---|---|---|
--max-count | -n | Begræns til N seneste sessioner |
--format | Outputformat: tabel eller json (tabel) |
stats
Vis tokenbrug og omkostningsstatistikker for dine Matrix-sessioner.
matrix statsFlag
| Flag | Beskrivelse |
|---|---|
--days | Vis statistik for de sidste N dage (hele tiden) |
--tools | Antal værktøjer, der skal vises (alle) |
--models | Vis modelbrugsopdeling (skjult som standard). Send et tal for at vise top N |
--project | Filtre efter projekt (alle projekter, tom streng: nuværende projekt) |
export
Eksporter sessionsdata som JSON.
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.
matrix import <file>Du kan importere fra en lokal fil eller en Matrix share URL.
matrix import session.jsonmatrix import https://opncd.ai/s/abc123web
Start en hovedløs Matrix-server med en webgrænseflade.
matrix webDette 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
| Flag | Beskrivelse |
|---|---|
--port | Port at lytte på |
--hostname | Værtsnavn at lytte på |
--mdns | Aktiver mDNS-opdagelse |
--cors | Yderligere browseroprindelse til at tillade CORS |
acp
Start en ACP-server (Agent Client Protocol).
matrix acpDenne kommando starter en ACP-server, der kommunikerer via stdin/stdout ved hjælp af nd-JSON.
Flag
| Flag | Beskrivelse |
|---|---|
--cwd | Arbejdsmappe |
--port | Port at lytte på |
--hostname | Værtsnavn at lytte på |
uninstall
Afinstaller Matrix og fjern alle relaterede filer.
matrix uninstallFlag
| Flag | Kort | Beskrivelse |
|---|---|---|
--keep-config | -c | Se konfigurationsfiler |
--keep-data | -d | Gem sessionsdata og snapshots |
--dry-run | Vis, hvad der ville blive fjernet uden at fjerne | |
--force | -f | Spring bekræftelsesspørgsmål over |
upgrade
Opdaterer Matrix til den nyeste version eller en specifik version.
matrix upgrade [target]For at opgradere til den nyeste version.
matrix upgradeFor at opgradere til en bestemt version.
matrix upgrade v0.1.48upgrade
| Flag | Kort | Beskrivelse |
|---|---|---|
--method | -m | Installationsmetoden, der blev brugt; curl, npm, pnpm, bun, brew |
Globale flag
matrix CLI tager følgende globale flag.
| Flag | Kort | Beskrivelse |
|---|---|---|
--help | -h | Vis hjælp |
--version | -v | Udskriftsversionsnummer |
--print-logs | Udskriv logfiler til stderr | |
--log-level | Logniveau (DEBUG, INFO, WARN, ERROR) |
Miljøvariabler
Matrix kan konfigureres ved hjælp af miljøvariabler.
| Variabel | Skriv | Beskrivelse |
|---|---|---|
MATRIX_AUTO_SHARE | boolean | Del automatisk session |
MATRIX_GIT_BASH_PATH | string | Sti til Git Bash eksekverbar på Windows |
MATRIX_CONFIG | string | Sti til konfigurationsfil |
MATRIX_TUI_CONFIG | string | Sti til TUI-konfigurationsfil |
MATRIX_CONFIG_DIR | string | Sti til konfigurationsmappe |
MATRIX_CONFIG_CONTENT | string | Indbygget json-konfigurationsindhold |
MATRIX_DISABLE_AUTOUPDATE | boolean | Deaktiver automatisk opdateringskontrol |
MATRIX_DISABLE_PRUNE | boolean | Deaktiver beskæring af gamle data |
MATRIX_DISABLE_TERMINAL_TITLE | boolean | Deaktiver automatisk opdatering af terminaltitel |
MATRIX_PERMISSION | string | Indbygget json-tilladelseskonfiguration |
MATRIX_DISABLE_DEFAULT_PLUGINS | boolean | Deaktiver standard plugins |
MATRIX_DISABLE_LSP_DOWNLOAD | boolean | Deaktiver automatisk LSP-serverdownloads |
MATRIX_ENABLE_EXPERIMENTAL_MODELS | boolean | Aktive eksperimentelle modeller |
MATRIX_DISABLE_AUTOCOMPACT | boolean | Deaktiver automatisk kontekstkomprimering |
MATRIX_DISABLE_CLAUDE_CODE | boolean | Deaktiver læsning fra .claude (prompt + færdigheder) |
MATRIX_DISABLE_CLAUDE_CODE_PROMPT | boolean | Deaktiver læsning ~/.claude/CLAUDE.md |
MATRIX_DISABLE_CLAUDE_CODE_SKILLS | boolean | Deaktiver indlæsning af .claude/skills |
MATRIX_DISABLE_MODELS_FETCH | boolean | Deaktivering af modeller fra eksterne kilder |
MATRIX_FAKE_VCS | string | Falsk VCS-udbyder til testformål |
MATRIX_DISABLE_FILETIME_CHECK | boolean | Deaktiver filtidskontrol for optimering |
MATRIX_CLIENT | string | Klient-id (standard til cli) |
MATRIX_ENABLE_EXA | boolean | Aktiver Exa-websøgeværktøjer |
MATRIX_SERVER_PASSWORD | string | Aktiver grundlæggende godkendelse for serve/web |
MATRIX_SERVER_USERNAME | string | Tilsidesæt grundlæggende godkendelsesbrugernavn (standard matrix) |
MATRIX_MODELS_URL | string | Brugerdefineret URL til hentning af modelkonfiguration |
Eksperimentel
Disse miljøvariabler muliggør eksperimentelle funktioner, der kan ændres eller fjernes.
| Variabel | Skriv | Beskrivelse |
|---|---|---|
MATRIX_EXPERIMENTAL | boolean | Aktiver alle eksperimentelle funktioner |
MATRIX_EXPERIMENTAL_ICON_DISCOVERY | boolean | Aktiver ikonopdagelse |
MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolean | Deaktiver kopi ved valg i TUI |
MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | nummer | Standard timeout for bash-kommandoer i ms |
MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAX | nummer | Maks. output-tokens for LLM-svar |
MATRIX_EXPERIMENTAL_FILEWATCHER | boolean | Aktiver filovervågning for hele dir |
MATRIX_EXPERIMENTAL_OXFMT | boolean | Aktiver oxfmt formatter |
MATRIX_EXPERIMENTAL_LSP_TOOL | boolean | Aktive eksperimenter LSP værktøj |
MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHER | boolean | Deaktiver filovervågning |
MATRIX_EXPERIMENTAL_EXA | boolean | Aktive eksperimenter Exa-funktioner |
MATRIX_EXPERIMENTAL_LSP_TY | boolean | Aktiver TY LSP for python-filer |
MATRIX_EXPERIMENTAL_MARKDOWN | boolean | Aktive eksperimentelle markdown-funktioner |
MATRIX_EXPERIMENTAL_PLAN_MODE | boolean | Aktiver plantilstand |