CLI
Opcje i polecenia wiersza poleceń Matrix.
CLI Matrix domyślnie uruchamia TUI, gdy wywołasz je bez argumentów.
matrixCLI obsługuje też polecenia opisane na tej stronie, więc możesz używać Matrix programowo.
matrix run "Explain how closures work in JavaScript"tui
Uruchamia interfejs terminalowy (TUI) Matrix.
matrix [project]Flagi
| Flaga | Skrót | Opis |
|---|---|---|
--continue | -c | Kontynuuj ostatnią sesję |
--session | -s | Identyfikator sesji do kontynuowania |
--fork | Sklonuj sesję podczas kontynuacji (użyj z --continue lub --session) | |
--prompt | Monit do użycia | |
--model | -m | Model do użycia w formacie dostawca/model |
--agent | Agent do użycia | |
--port | Port do nasłuchiwania | |
--hostname | Nazwa hosta, do której należy się powiązać |
Polecenia
Interfejs CLI Matrix zawiera także dodatkowe polecenia.
agent
Zarządzaj agentami Matrix.
matrix agent [command]attach
Dołącz terminal do już działającego serwera backendu Matrix uruchomionego za pomocą serve lub web.
matrix attach [url]Pozwala to połączyć TUI ze zdalnym backendem Matrix. Na przykład:
# 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:4096Flagi
| Flaga | Skrót | Opis |
|---|---|---|
--dir | Katalog roboczy, w którym uruchomić TUI | |
--session | -s | Identyfikator sesji do kontynuowania |
create
Utwórz nowego agenta z niestandardową konfiguracją.
matrix agent createTo polecenie poprowadzi Cię przez proces tworzenia nowego agenta z niestandardowym promptem systemowym i konfiguracją narzędzi.
list
Wyświetl listę wszystkich agentów.
matrix agent listauth
Zarządzaj danymi uwierzytelniającymi i logowaniem dla dostawców.
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.
matrix auth loginPodczas 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ń.
matrix auth listLub skrócona wersja:
matrix auth lslogout
Wyloguj się z dostawcy, usuwając go z pliku poświadczeń.
matrix auth logoutgithub
Zarządzaj agentem GitHub w celu automatyzacji repozytorium.
matrix github [command]install
Zainstaluj agenta GitHub w swoim repozytorium.
matrix github installSpowoduje 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.
matrix github runFlagi
| Flaga | Opis |
|---|---|
--event | Zdarzenie GitHub, które wyzwoliło agenta |
--token | Osobisty token dostępu GitHub |
mcp
Zarządzaj serwerami Model Context Protocol (MCP).
matrix mcp [command]add
Dodaj serwer MCP do swojej konfiguracji.
matrix mcp addTo polecenie poprowadzi Cię przez proces dodawania lokalnego lub zdalnego serwera MCP.
list
Wyświetl listę wszystkich skonfigurowanych serwerów MCP i ich status.
matrix mcp listLub skrócona wersja:
matrix mcp lsauth
Uwierzytelnij się w serwerze MCP z włączoną funkcją OAuth.
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.
matrix mcp auth listLub skrócona wersja:
matrix mcp auth lslogout
Usuń tokeny OAuth dla serwera MCP.
matrix mcp logout [name]debug
Debuguj problemy z połączeniem OAuth dla serwera MCP.
matrix mcp debug <name>models
Wyświetl listę modeli ze wszystkich skonfigurowanych dostawców.
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.
matrix models anthropicFlagi
| Flaga | Opis |
|---|---|
--refresh | Odśwież pamięć podręczną modeli |
--verbose | Bardziej 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.
matrix models --refreshrun
Uruchom Matrix w trybie nieinteraktywnym, przekazując bezpośrednio prompt.
matrix run [message..]Jest to przydatne do tworzenia skryptów, automatyzacji lub gdy chcesz wysłać szybkie zapytanie bez uruchamiania TUI. Na przykład:
matrix run Explain the use of context in GoMożna również użyć tego z działającym matrix serve, aby uniknąć zimnego startu serwera MCP przy każdym uruchomieniu:
# 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"Flagi
| Flaga | Skrót | Opis |
|---|---|---|
--command | Polecenie do uruchomienia, reszta to argumenty | |
--continue | -c | Kontynuuj ostatnią sesję |
--session | -s | Identyfikator sesji do kontynuowania |
--fork | Sklonuj sesję podczas kontynuacji (użyj z --continue lub --session) | |
--share | Udostępnij sesję po zakończeniu | |
--model | -m | Model do użycia w formacie dostawca/model |
--agent | Agent do użycia | |
--file | -f | Pliki do załączenia do wiadomości |
--format | Format wyjściowy: default (sformatowany) lub json (surowy JSON) | |
--title | Tytuł sesji (jeśli nie podano, zostanie wygenerowany z promptu) | |
--attach | Dołącz do działającego serwera Matrix (np. http://localhost:4096) | |
--port | Port 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.
matrix serveUruchamia 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
| Flaga | Opis |
|---|---|
--port | Port do nasłuchiwania |
--hostname | Nazwa hosta, do której należy się powiązać |
--mdns | Włącz wykrywanie mDNS |
--cors | Dodatkowe dozwolone źródła CORS |
session
Zarządzaj sesjami Matrix.
matrix session [command]list
Lista wszystkich sesji Matrix.
matrix session listFlagi
| Flaga | Skrót | Opis |
|---|---|---|
--max-count | -n | Ogranicz do ostatnich N sesji |
--format | Format wyjściowy: tabela lub json (tabela) |
stats
Pokaż statystyki wykorzystania tokenów i sesji Matrix.
matrix statsFlagi
| Flaga | Opis |
|---|---|
--days | Pokaż statystyki z ostatnich N dni (domyślnie: cały czas) |
--tools | Pokaż użycie poszczególnych narzędzi (domyślnie: wszystkie) |
--models | Pokaż podział na modele (domyślnie ukryty). Podaj liczbę, aby pokazać N najczęstszych |
--project | Filtruj według projektu (domyślnie: wszystkie projekty, pusty ciąg: bieżący projekt) |
export
Eksportuj dane sesji jako JSON.
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.
matrix import <file>Możesz importować z pliku lokalnego lub adresu URL.
matrix import session.jsonmatrix import https://opncd.ai/s/abc123web
Uruchom serwer Matrix z interfejsem internetowym.
matrix webUruchamia 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
| Flaga | Opis |
|---|---|
--port | Port do nasłuchiwania |
--hostname | Nazwa hosta, do której należy się powiązać |
--mdns | Włącz wykrywanie mDNS |
--cors | Dodatkowe dozwolone źródła CORS |
acp
Uruchom serwer ACP (Agent Client Protocol).
matrix acpUruchamia serwer ACP, który komunikuje się przez stdin/stdout przy użyciu JSON-RPC.
Flagi
| Flaga | Opis |
|---|---|
--cwd | Katalog roboczy |
--port | Port do nasłuchiwania |
--hostname | Nazwa hosta, do której należy się powiązać |
uninstall
Odinstaluj Matrix i usuń wszystkie powiązane pliki.
matrix uninstallFlagi
| Flaga | Skrót | Opis |
|---|---|---|
--keep-config | -c | Zachowaj pliki konfiguracyjne |
--keep-data | -d | Zachowaj dane sesji i migawki |
--dry-run | Pokaż co zostanie usunięte | |
--force | -f | Pomiń monity o potwierdzenie |
upgrade
Aktualizuj Matrix do najnowszej lub określonej wersji.
matrix upgrade [target]Aby zaktualizować do najnowszej wersji:
matrix upgradeAby zaktualizować do konkretnej wersji:
matrix upgrade v0.1.48Flagi
| Flaga | Skrót | Opis |
|---|---|---|
--method | -m | Wymuś metodę instalacji: curl, npm, pnpm, bun, brew |
Flagi globalne
Interfejs CLI Matrix przyjmuje następujące flagi globalne dla każdego polecenia.
| Flaga | Skrót | Opis |
|---|---|---|
--help | -h | Wyświetl pomoc |
--version | -v | Wydrukuj numer wersji |
--print-logs | Drukuj logi na stderr | |
--log-level | Poziom logowania (DEBUG, INFO, WARN, ERROR) |
Zmienne środowiskowe
Matrix można skonfigurować za pomocą zmiennych środowiskowych.
| Zmienna | Typ | Opis |
|---|---|---|
MATRIX_AUTO_SHARE | boolean | Automatycznie udostępniaj sesje |
MATRIX_GIT_BASH_PATH | string | Ścieżka do pliku wykonywalnego Git Bash w systemie Windows |
MATRIX_CONFIG | string | Ścieżka do pliku konfiguracyjnego |
MATRIX_TUI_CONFIG | string | Ścieżka do pliku konfiguracyjnego TUI |
MATRIX_CONFIG_DIR | string | Ścieżka do katalogu konfiguracyjnego |
MATRIX_CONFIG_CONTENT | string | Treść konfiguracji JSON (inline) |
MATRIX_DISABLE_AUTOUPDATE | boolean | Wyłącz automatyczne sprawdzanie aktualizacji |
MATRIX_DISABLE_PRUNE | boolean | Wyłącz czyszczenie starych wyników (pruning) |
MATRIX_DISABLE_TERMINAL_TITLE | boolean | Wyłącz automatyczne ustawianie tytułu terminala |
MATRIX_PERMISSION | string | Konfiguracja uprawnień w JSON (inline) |
MATRIX_DISABLE_DEFAULT_PLUGINS | boolean | Wyłącz domyślne wtyczki |
MATRIX_DISABLE_LSP_DOWNLOAD | boolean | Wyłącz automatyczne pobieranie serwerów LSP |
MATRIX_ENABLE_EXPERIMENTAL_MODELS | boolean | Włącz modele eksperymentalne |
MATRIX_DISABLE_AUTOCOMPACT | boolean | Wyłącz automatyczne kompaktowanie kontekstu |
MATRIX_DISABLE_CLAUDE_CODE | boolean | Wyłącz integrację z .claude (prompt + skills) |
MATRIX_DISABLE_CLAUDE_CODE_PROMPT | boolean | Wyłącz czytanie ~/.claude/CLAUDE.md |
MATRIX_DISABLE_CLAUDE_CODE_SKILLS | boolean | Wyłącz ładowanie .claude/skills |
MATRIX_DISABLE_MODELS_FETCH | boolean | Wyłącz pobieranie modeli ze źródeł zewnętrznych |
MATRIX_FAKE_VCS | string | Fałszywy dostawca VCS do celów testowych |
MATRIX_DISABLE_FILETIME_CHECK | boolean | Wyłącz sprawdzanie czasu modyfikacji plików (optymalizacja) |
MATRIX_CLIENT | string | Identyfikator klienta (domyślnie cli) |
MATRIX_ENABLE_EXA | boolean | Włącz narzędzie wyszukiwania internetowego Exa |
MATRIX_SERVER_PASSWORD | string | Włącz uwierzytelnianie podstawowe dla serve/web |
MATRIX_SERVER_USERNAME | string | Nazwa użytkownika do autoryzacji (domyślnie matrix) |
MATRIX_MODELS_URL | string | Niestandardowy adres URL do pobierania konfiguracji modeli |
Eksperymentalne
Te zmienne włączają funkcje eksperymentalne, które mogą ulec zmianie lub zostać usunięte.
| Zmienna | Typ | Opis |
|---|---|---|
MATRIX_EXPERIMENTAL | boolean | Włącz wszystkie funkcje eksperymentalne |
MATRIX_EXPERIMENTAL_ICON_DISCOVERY | boolean | Włącz wykrywanie ikon |
MATRIX_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolean | Wyłącz kopiowanie przy zaznaczaniu w TUI |
MATRIX_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | number | Domyślny limit czasu dla narzędzia bash w ms |
MATRIX_EXPERIMENTAL_OUTPUT_TOKEN_MAX | number | Maksymalne tokeny wyjściowe dla LLM |
MATRIX_EXPERIMENTAL_FILEWATCHER | boolean | Włącz obserwatora plików dla całego katalogu |
MATRIX_EXPERIMENTAL_OXFMT | boolean | Włącz formater oxfmt |
MATRIX_EXPERIMENTAL_LSP_TOOL | boolean | Włącz eksperymentalne narzędzie LSP |
MATRIX_EXPERIMENTAL_DISABLE_FILEWATCHER | boolean | Wyłącz obserwatora plików |
MATRIX_EXPERIMENTAL_EXA | boolean | Włącz funkcje eksperymentalne Exa |
MATRIX_EXPERIMENTAL_LSP_TY | boolean | Włącz TY LSP dla plików python |
MATRIX_EXPERIMENTAL_MARKDOWN | boolean | Włącz funkcje eksperymentalne Markdown |
MATRIX_EXPERIMENTAL_PLAN_MODE | boolean | Włącz tryb planowania |