Przejdź do głównej zawartości

CLI

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

Okno terminala
opencode

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

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

tui

Uruchamia interfejs terminalowy (TUI) CodeTutor.

Okno terminala
opencode [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 CodeTutor zawiera także dodatkowe polecenia.


agent

Zarządzaj agentami CodeTutor.

Okno terminala
codetutor agent [command]

attach

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

Okno terminala
codetutor attach [url]

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

Okno terminala
# Start the backend server for web/mobile access
codetutor web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
codetutor attach http://10.20.30.40:4096

Flagi

FlagaSkrótOpis
--dirKatalog roboczy, w którym uruchomić TUI
--continue-cKontynuuj ostatnią sesję
--session-sIdentyfikator sesji do kontynuowania
--forkRozgałęź sesję podczas kontynuowania (użyj z --continue lub --session)
--password-pHasło uwierzytelniania podstawowego (domyślnie CODETUTOR_SERVER_PASSWORD)
--username-uNazwa użytkownika uwierzytelniania podstawowego (domyślnie CODETUTOR_SERVER_USERNAME lub codetutor)

create

Utwórz nowego agenta z niestandardową konfiguracją.

Okno terminala
codetutor 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
codetutor agent list

auth

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

Okno terminala
codetutor auth [command]

login

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

Okno terminala
codetutor auth login

Podczas uruchamiania CodeTutor ł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
codetutor auth list

Lub skrócona wersja:

Okno terminala
codetutor auth ls

logout

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

Okno terminala
codetutor auth logout

github

Zarządzaj agentem GitHub w celu automatyzacji repozytorium.

Okno terminala
codetutor github [command]

install

Zainstaluj agenta GitHub w swoim repozytorium.

Okno terminala
codetutor 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
codetutor 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
codetutor mcp [command]

add

Dodaj serwer MCP do swojej konfiguracji.

Okno terminala
codetutor 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
codetutor mcp list

Lub skrócona wersja:

Okno terminala
codetutor mcp ls

auth

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

Okno terminala
codetutor 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
codetutor mcp auth list

Lub skrócona wersja:

Okno terminala
codetutor mcp auth ls

logout

Usuń tokeny OAuth dla serwera MCP.

Okno terminala
codetutor mcp logout [name]

debug

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

Okno terminala
codetutor mcp debug <name>

models

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

Okno terminala
codetutor 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
codetutor 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 CodeTutor.

Okno terminala
codetutor models --refresh

run

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

Okno terminala
codetutor 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
codetutor run Explain the use of context in Go

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

Okno terminala
# Start a headless server in one terminal
codetutor serve
# In another terminal, run commands that attach to it
codetutor 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 CodeTutor (np. http://localhost:4096)
--password-pHasło uwierzytelniania podstawowego (domyślnie CODETUTOR_SERVER_PASSWORD)
--username-uNazwa użytkownika uwierzytelniania podstawowego (domyślnie CODETUTOR_SERVER_USERNAME lub codetutor)
--dirKatalog do uruchomienia lub ścieżka na zdalnym serwerze podczas dołączania
--variantWariant modelu (poziom wnioskowania specyficzny dla dostawcy)
--thinkingPokaż bloki myślenia
--portPort dla serwera lokalnego (domyślnie losowy)

serve

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

Okno terminala
codetutor serve

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

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 CodeTutor.

Okno terminala
codetutor session [command]

list

Lista wszystkich sesji CodeTutor.

Okno terminala
codetutor 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 CodeTutor.

Okno terminala
codetutor 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
codetutor 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 CodeTutor.

Okno terminala
codetutor import <file>

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

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

web

Uruchom serwer CodeTutor z interfejsem internetowym.

Okno terminala
codetutor web

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

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
codetutor 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 CodeTutor i usuń wszystkie powiązane pliki.

Okno terminala
codetutor 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 CodeTutor do najnowszej lub określonej wersji.

Okno terminala
codetutor upgrade [target]

Aby zaktualizować do najnowszej wersji:

Okno terminala
codetutor upgrade

Aby zaktualizować do konkretnej wersji:

Okno terminala
codetutor upgrade v0.1.48

Flagi

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

Flagi globalne

Interfejs CLI CodeTutor 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

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

ZmiennaTypOpis
CODETUTOR_AUTO_SHAREbooleanAutomatycznie udostępniaj sesje
CODETUTOR_GIT_BASH_PATHstringŚcieżka do pliku wykonywalnego Git Bash w systemie Windows
CODETUTOR_CONFIGstringŚcieżka do pliku konfiguracyjnego
CODETUTOR_TUI_CONFIGstringŚcieżka do pliku konfiguracyjnego TUI
CODETUTOR_CONFIG_DIRstringŚcieżka do katalogu konfiguracyjnego
CODETUTOR_CONFIG_CONTENTstringTreść konfiguracji JSON (inline)
CODETUTOR_DISABLE_AUTOUPDATEbooleanWyłącz automatyczne sprawdzanie aktualizacji
CODETUTOR_DISABLE_PRUNEbooleanWyłącz czyszczenie starych wyników (pruning)
CODETUTOR_DISABLE_TERMINAL_TITLEbooleanWyłącz automatyczne ustawianie tytułu terminala
CODETUTOR_PERMISSIONstringKonfiguracja uprawnień w JSON (inline)
CODETUTOR_DISABLE_DEFAULT_PLUGINSbooleanWyłącz domyślne wtyczki
CODETUTOR_DISABLE_LSP_DOWNLOADbooleanWyłącz automatyczne pobieranie serwerów LSP
CODETUTOR_ENABLE_EXPERIMENTAL_MODELSbooleanWłącz modele eksperymentalne
CODETUTOR_DISABLE_AUTOCOMPACTbooleanWyłącz automatyczne kompaktowanie kontekstu
CODETUTOR_DISABLE_CLAUDE_CODEbooleanWyłącz integrację z .claude (prompt + skills)
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPTbooleanWyłącz czytanie ~/.claude/CLAUDE.md
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLSbooleanWyłącz ładowanie .claude/skills
CODETUTOR_DISABLE_MODELS_FETCHbooleanWyłącz pobieranie modeli ze źródeł zewnętrznych
CODETUTOR_FAKE_VCSstringFałszywy dostawca VCS do celów testowych
CODETUTOR_CLIENTstringIdentyfikator klienta (domyślnie cli)
CODETUTOR_ENABLE_EXAbooleanWłącz narzędzie wyszukiwania internetowego Exa
CODETUTOR_SERVER_PASSWORDstringWłącz uwierzytelnianie podstawowe dla serve/web
CODETUTOR_SERVER_USERNAMEstringNazwa użytkownika do autoryzacji (domyślnie codetutor)
CODETUTOR_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
CODETUTOR_EXPERIMENTALbooleanWłącz funkcje eksperymentalne objęte flagą zbiorczą
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERYbooleanWłącz wykrywanie ikon
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanWyłącz kopiowanie przy zaznaczaniu w TUI
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberDomyślny limit czasu dla narzędzia bash w ms
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberMaksymalne tokeny wyjściowe dla LLM
CODETUTOR_EXPERIMENTAL_FILEWATCHERbooleanWłącz obserwatora plików dla całego katalogu
CODETUTOR_EXPERIMENTAL_OXFMTbooleanWłącz formater oxfmt
CODETUTOR_EXPERIMENTAL_LSP_TOOLbooleanWłącz eksperymentalne narzędzie LSP
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanWyłącz obserwatora plików
CODETUTOR_EXPERIMENTAL_EXAbooleanWłącz funkcje eksperymentalne Exa
CODETUTOR_EXPERIMENTAL_LSP_TYbooleanWłącz TY LSP dla plików python
CODETUTOR_EXPERIMENTAL_PLAN_MODEbooleanWłącz tryb planowania
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTSbooleanWłącz zadania subagentów w tle
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEMbooleanWłącz eksperymentalny system zdarzeń
CODETUTOR_EXPERIMENTAL_NATIVE_LLMbooleanWłącz natywną ścieżkę żądań LLM
CODETUTOR_EXPERIMENTAL_PARALLELbooleanWłącz równoległe wykonywanie wyszukiwania web
CODETUTOR_EXPERIMENTAL_SCOUTbooleanWłącz subagenta Scout
CODETUTOR_EXPERIMENTAL_WORKSPACESbooleanWłącz obsługę obszarów roboczych