Przejdź do głównej zawartości

CLI

Opcje i polecenia wiersza poleceń Matrix.

CLI Matrix domyślnie uruchamia TUI, gdy wywołasz je bez argumentów.

Okno terminala
matrix

CLI obsługuje też polecenia opisane na tej stronie, więc możesz używać Matrix programowo.

Okno terminala
matrix run "Explain how closures work in JavaScript"

tui

Uruchamia interfejs terminalowy (TUI) Matrix.

Okno terminala
matrix [project]

Flagi

FlagaSkrótOpis
--continue-cKontynuuj ostatnią sesję
--session-sIdentyfikator sesji do kontynuowania
--forkSklonuj sesję podczas kontynuacji (użyj z --continue lub --session)
--promptMonit do użycia
--model-mModel do użycia w formacie dostawca/model
--agentAgent do użycia
--portPort do nasłuchiwania
--hostnameNazwa hosta, do której należy się powiązać

Polecenia

Interfejs CLI Matrix zawiera także dodatkowe polecenia.


agent

Zarządzaj agentami Matrix.

Okno terminala
matrix agent [command]

attach

Dołącz terminal do już działającego serwera backendu Matrix uruchomionego za pomocą serve lub web.

Okno terminala
matrix attach [url]

Pozwala to połączyć TUI ze zdalnym backendem Matrix. Na przykład:

Okno terminala
# 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

Flagi

FlagaSkrótOpis
--dirKatalog roboczy, w którym uruchomić TUI
--session-sIdentyfikator sesji do kontynuowania

create

Utwórz nowego agenta z niestandardową konfiguracją.

Okno terminala
matrix agent create

To polecenie poprowadzi Cię przez proces tworzenia nowego agenta z niestandardowym promptem systemowym i konfiguracją narzędzi.


list

Wyświetl listę wszystkich agentów.

Okno terminala
matrix agent list

auth

Zarządzaj danymi uwierzytelniającymi i logowaniem dla dostawców.

Okno terminala
matrix auth [command]

login

Matrix integruje się z wieloma dostawcami. Możesz użyć matrix auth login, aby skonfigurować klucz API dla dowolnego obsługiwanego dostawcy. Klucze są bezpiecznie przechowywane w ~/.local/share/matrix/auth.json.

Okno terminala
matrix auth login

Podczas uruchamiania Matrix ładuje dostawców z pliku poświadczeń, a także ze zmiennych środowiskowych lub pliku .env w Twoim projekcie.


list

Wyświetl listę wszystkich uwierzytelnionych dostawców przechowywanych w pliku poświadczeń.

Okno terminala
matrix auth list

Lub skrócona wersja:

Okno terminala
matrix auth ls

logout

Wyloguj się z dostawcy, usuwając go z pliku poświadczeń.

Okno terminala
matrix auth logout

github

Zarządzaj agentem GitHub w celu automatyzacji repozytorium.

Okno terminala
matrix github [command]

install

Zainstaluj agenta GitHub w swoim repozytorium.

Okno terminala
matrix github install

Spowoduje to utworzenie pliku workflow GitHub Actions i poprowadzi Cię przez proces konfiguracji. Dowiedz się więcej.


run

Uruchom agenta na GitHubie. Zwykle używane w GitHub Actions.

Okno terminala
matrix github run
Flagi
FlagaOpis
--eventZdarzenie GitHub, które wyzwoliło agenta
--tokenOsobisty token dostępu GitHub

mcp

Zarządzaj serwerami Model Context Protocol (MCP).

Okno terminala
matrix mcp [command]

add

Dodaj serwer MCP do swojej konfiguracji.

Okno terminala
matrix mcp add

To polecenie poprowadzi Cię przez proces dodawania lokalnego lub zdalnego serwera MCP.


list

Wyświetl listę wszystkich skonfigurowanych serwerów MCP i ich status.

Okno terminala
matrix mcp list

Lub skrócona wersja:

Okno terminala
matrix mcp ls

auth

Uwierzytelnij się w serwerze MCP z włączoną funkcją OAuth.

Okno terminala
matrix mcp auth [name]

Jeśli nie podasz nazwy serwera, zostaniesz poproszony o wybranie jednego z serwerów wymagających uwierzytelnienia.

Możesz także wyświetlić listę serwerów obsługujących OAuth i ich status uwierzytelnienia.

Okno terminala
matrix mcp auth list

Lub skrócona wersja:

Okno terminala
matrix mcp auth ls

logout

Usuń tokeny OAuth dla serwera MCP.

Okno terminala
matrix mcp logout [name]

debug

Debuguj problemy z połączeniem OAuth dla serwera MCP.

Okno terminala
matrix mcp debug <name>

models

Wyświetl listę modeli ze wszystkich skonfigurowanych dostawców.

Okno terminala
matrix models [provider]

Pokazuje modele dostępne do użycia w provider/model.

Jest to identyfikator modelu, którego używasz w konfiguracji.

Opcjonalnie możesz podać identyfikator dostawcy, aby filtrować modele według tego dostawcy.

Okno terminala
matrix models anthropic

Flagi

FlagaOpis
--refreshOdśwież pamięć podręczną modeli
--verboseBardziej szczegółowe dane wyjściowe modelu (zawiera metadane, takie jak koszty)

Użyj flagi --refresh, aby zaktualizować listę modeli w pamięci podręcznej. Jest to przydatne, gdy dostawca dodał nowe modele, które chcesz zobaczyć w Matrix.

Okno terminala
matrix models --refresh

run

Uruchom Matrix w trybie nieinteraktywnym, przekazując bezpośrednio prompt.

Okno terminala
matrix run [message..]

Jest to przydatne do tworzenia skryptów, automatyzacji lub gdy chcesz wysłać szybkie zapytanie bez uruchamiania TUI. Na przykład:

Okno terminala
matrix run Explain the use of context in Go

Można również użyć tego z działającym matrix serve, aby uniknąć zimnego startu serwera MCP przy każdym uruchomieniu:

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

Flagi

FlagaSkrótOpis
--commandPolecenie do uruchomienia, reszta to argumenty
--continue-cKontynuuj ostatnią sesję
--session-sIdentyfikator sesji do kontynuowania
--forkSklonuj sesję podczas kontynuacji (użyj z --continue lub --session)
--shareUdostępnij sesję po zakończeniu
--model-mModel do użycia w formacie dostawca/model
--agentAgent do użycia
--file-fPliki do załączenia do wiadomości
--formatFormat wyjściowy: default (sformatowany) lub json (surowy JSON)
--titleTytuł sesji (jeśli nie podano, zostanie wygenerowany z promptu)
--attachDołącz do działającego serwera Matrix (np. http://localhost:4096)
--portPort dla serwera lokalnego (domyślnie losowy)

serve

Uruchom serwer Matrix (bez interfejsu) w celu uzyskania dostępu do API. Pełny opis API HTTP znajduje się w dokumentacji serwera.

Okno terminala
matrix serve

Uruchamia to serwer HTTP, który zapewnia dostęp do API Matrix bez interfejsu TUI. Ustaw MATRIX_SERVER_PASSWORD, aby włączyć podstawowe uwierzytelnianie HTTP (domyślna nazwa użytkownika to matrix).

Flagi

FlagaOpis
--portPort do nasłuchiwania
--hostnameNazwa hosta, do której należy się powiązać
--mdnsWłącz wykrywanie mDNS
--corsDodatkowe dozwolone źródła CORS

session

Zarządzaj sesjami Matrix.

Okno terminala
matrix session [command]

list

Lista wszystkich sesji Matrix.

Okno terminala
matrix session list
Flagi
FlagaSkrótOpis
--max-count-nOgranicz do ostatnich N sesji
--formatFormat wyjściowy: tabela lub json (tabela)

stats

Pokaż statystyki wykorzystania tokenów i sesji Matrix.

Okno terminala
matrix stats

Flagi

FlagaOpis
--daysPokaż statystyki z ostatnich N dni (domyślnie: cały czas)
--toolsPokaż użycie poszczególnych narzędzi (domyślnie: wszystkie)
--modelsPokaż podział na modele (domyślnie ukryty). Podaj liczbę, aby pokazać N najczęstszych
--projectFiltruj według projektu (domyślnie: wszystkie projekty, pusty ciąg: bieżący projekt)

export

Eksportuj dane sesji jako JSON.

Okno terminala
matrix export [sessionID]

Jeśli nie podasz identyfikatora sesji, zostaniesz poproszony o wybranie jednej z ostatnich sesji.


import

Importuj dane sesji z pliku JSON lub adresu URL udostępniania Matrix.

Okno terminala
matrix import <file>

Możesz importować z pliku lokalnego lub adresu URL.

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

web

Uruchom serwer Matrix z interfejsem internetowym.

Okno terminala
matrix web

Uruchamia to serwer HTTP i udostępnia Matrix przez interfejs przeglądarkowy. Ustaw MATRIX_SERVER_PASSWORD, aby włączyć podstawowe uwierzytelnianie HTTP (domyślna nazwa użytkownika to matrix).

Flagi

FlagaOpis
--portPort do nasłuchiwania
--hostnameNazwa hosta, do której należy się powiązać
--mdnsWłącz wykrywanie mDNS
--corsDodatkowe dozwolone źródła CORS

acp

Uruchom serwer ACP (Agent Client Protocol).

Okno terminala
matrix acp

Uruchamia serwer ACP, który komunikuje się przez stdin/stdout przy użyciu JSON-RPC.

Flagi

FlagaOpis
--cwdKatalog roboczy
--portPort do nasłuchiwania
--hostnameNazwa hosta, do której należy się powiązać

uninstall

Odinstaluj Matrix i usuń wszystkie powiązane pliki.

Okno terminala
matrix uninstall

Flagi

FlagaSkrótOpis
--keep-config-cZachowaj pliki konfiguracyjne
--keep-data-dZachowaj dane sesji i migawki
--dry-runPokaż co zostanie usunięte
--force-fPomiń monity o potwierdzenie

upgrade

Aktualizuj Matrix do najnowszej lub określonej wersji.

Okno terminala
matrix upgrade [target]

Aby zaktualizować do najnowszej wersji:

Okno terminala
matrix upgrade

Aby zaktualizować do konkretnej wersji:

Okno terminala
matrix upgrade v0.1.48

Flagi

FlagaSkrótOpis
--method-mWymuś metodę instalacji: curl, npm, pnpm, bun, brew

Flagi globalne

Interfejs CLI Matrix przyjmuje następujące flagi globalne dla każdego polecenia.

FlagaSkrótOpis
--help-hWyświetl pomoc
--version-vWydrukuj numer wersji
--print-logsDrukuj logi na stderr
--log-levelPoziom logowania (DEBUG, INFO, WARN, ERROR)

Zmienne środowiskowe

Matrix można skonfigurować za pomocą zmiennych środowiskowych.

ZmiennaTypOpis
MATRIX_AUTO_SHAREbooleanAutomatycznie udostępniaj sesje
MATRIX_GIT_BASH_PATHstringŚcieżka do pliku wykonywalnego Git Bash w systemie Windows
MATRIX_CONFIGstringŚcieżka do pliku konfiguracyjnego
MATRIX_TUI_CONFIGstringŚcieżka do pliku konfiguracyjnego TUI
MATRIX_CONFIG_DIRstringŚcieżka do katalogu konfiguracyjnego
MATRIX_CONFIG_CONTENTstringTreść konfiguracji JSON (inline)
MATRIX_DISABLE_AUTOUPDATEbooleanWyłącz automatyczne sprawdzanie aktualizacji
MATRIX_DISABLE_PRUNEbooleanWyłącz czyszczenie starych wyników (pruning)
MATRIX_DISABLE_TERMINAL_TITLEbooleanWyłącz automatyczne ustawianie tytułu terminala
MATRIX_PERMISSIONstringKonfiguracja uprawnień w JSON (inline)
MATRIX_DISABLE_DEFAULT_PLUGINSbooleanWyłącz domyślne wtyczki
MATRIX_DISABLE_LSP_DOWNLOADbooleanWyłącz automatyczne pobieranie serwerów LSP
MATRIX_ENABLE_EXPERIMENTAL_MODELSbooleanWłącz modele eksperymentalne
MATRIX_DISABLE_AUTOCOMPACTbooleanWyłącz automatyczne kompaktowanie kontekstu
MATRIX_DISABLE_CLAUDE_CODEbooleanWyłącz integrację z .claude (prompt + skills)
MATRIX_DISABLE_CLAUDE_CODE_PROMPTbooleanWyłącz czytanie ~/.claude/CLAUDE.md
MATRIX_DISABLE_CLAUDE_CODE_SKILLSbooleanWyłącz ładowanie .claude/skills
MATRIX_DISABLE_MODELS_FETCHbooleanWyłącz pobieranie modeli ze źródeł zewnętrznych
MATRIX_FAKE_VCSstringFałszywy dostawca VCS do celów testowych
MATRIX_DISABLE_FILETIME_CHECKbooleanWyłącz sprawdzanie czasu modyfikacji plików (optymalizacja)
MATRIX_CLIENTstringIdentyfikator klienta (domyślnie cli)
MATRIX_ENABLE_EXAbooleanWłącz narzędzie wyszukiwania internetowego Exa
MATRIX_SERVER_PASSWORDstringWłącz uwierzytelnianie podstawowe dla serve/web
MATRIX_SERVER_USERNAMEstringNazwa użytkownika do autoryzacji (domyślnie matrix)
MATRIX_MODELS_URLstringNiestandardowy adres URL do pobierania konfiguracji modeli

Eksperymentalne

Te zmienne włączają funkcje eksperymentalne, które mogą ulec zmianie lub zostać usunięte.

ZmiennaTypOpis
MATRIX_EXPERIMENTALbooleanWłącz wszystkie funkcje eksperymentalne
MATRIX_EXPERIMENTAL_ICON_DISCOVERYbooleanWłącz wykrywanie ikon
MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanWyłącz kopiowanie przy zaznaczaniu w TUI
MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberDomyślny limit czasu dla narzędzia bash w ms
MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberMaksymalne tokeny wyjściowe dla LLM
MATRIX_EXPERIMENTAL_FILEWATCHERbooleanWłącz obserwatora plików dla całego katalogu
MATRIX_EXPERIMENTAL_OXFMTbooleanWłącz formater oxfmt
MATRIX_EXPERIMENTAL_LSP_TOOLbooleanWłącz eksperymentalne narzędzie LSP
MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanWyłącz obserwatora plików
MATRIX_EXPERIMENTAL_EXAbooleanWłącz funkcje eksperymentalne Exa
MATRIX_EXPERIMENTAL_LSP_TYbooleanWłącz TY LSP dla plików python
MATRIX_EXPERIMENTAL_MARKDOWNbooleanWłącz funkcje eksperymentalne Markdown
MATRIX_EXPERIMENTAL_PLAN_MODEbooleanWłącz tryb planowania