CLI
CLI CodeTutor domyślnie uruchamia TUI, gdy wywołasz je bez argumentów.
opencodeCLI obsługuje też polecenia opisane na tej stronie, więc możesz używać CodeTutor programowo.
codetutor run "Explain how closures work in JavaScript"tui
Uruchamia interfejs terminalowy (TUI) CodeTutor.
opencode [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 CodeTutor zawiera także dodatkowe polecenia.
agent
Zarządzaj agentami CodeTutor.
codetutor agent [command]attach
Dołącz terminal do już działającego serwera backendu CodeTutor uruchomionego za pomocą serve lub web.
codetutor attach [url]Pozwala to połączyć TUI ze zdalnym backendem CodeTutor. Na przykład:
# Start the backend server for web/mobile accesscodetutor web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendcodetutor attach http://10.20.30.40:4096Flagi
| Flaga | Skrót | Opis |
|---|---|---|
--dir | Katalog roboczy, w którym uruchomić TUI | |
--continue | -c | Kontynuuj ostatnią sesję |
--session | -s | Identyfikator sesji do kontynuowania |
--fork | Rozgałęź sesję podczas kontynuowania (użyj z --continue lub --session) | |
--password | -p | Hasło uwierzytelniania podstawowego (domyślnie CODETUTOR_SERVER_PASSWORD) |
--username | -u | Nazwa użytkownika uwierzytelniania podstawowego (domyślnie CODETUTOR_SERVER_USERNAME lub codetutor) |
create
Utwórz nowego agenta z niestandardową konfiguracją.
codetutor 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.
codetutor agent listauth
Zarządzaj danymi uwierzytelniającymi i logowaniem dla dostawców.
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.
codetutor auth loginPodczas 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ń.
codetutor auth listLub skrócona wersja:
codetutor auth lslogout
Wyloguj się z dostawcy, usuwając go z pliku poświadczeń.
codetutor auth logoutgithub
Zarządzaj agentem GitHub w celu automatyzacji repozytorium.
codetutor github [command]install
Zainstaluj agenta GitHub w swoim repozytorium.
codetutor 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.
codetutor 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).
codetutor mcp [command]add
Dodaj serwer MCP do swojej konfiguracji.
codetutor 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.
codetutor mcp listLub skrócona wersja:
codetutor mcp lsauth
Uwierzytelnij się w serwerze MCP z włączoną funkcją OAuth.
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.
codetutor mcp auth listLub skrócona wersja:
codetutor mcp auth lslogout
Usuń tokeny OAuth dla serwera MCP.
codetutor mcp logout [name]debug
Debuguj problemy z połączeniem OAuth dla serwera MCP.
codetutor mcp debug <name>models
Wyświetl listę modeli ze wszystkich skonfigurowanych dostawców.
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.
codetutor 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 CodeTutor.
codetutor models --refreshrun
Uruchom CodeTutor w trybie nieinteraktywnym, przekazując bezpośrednio prompt.
codetutor run [message..]Jest to przydatne do tworzenia skryptów, automatyzacji lub gdy chcesz wysłać szybkie zapytanie bez uruchamiania TUI. Na przykład:
codetutor run Explain the use of context in GoMożna również użyć tego z działającym codetutor serve, aby uniknąć zimnego startu serwera MCP przy każdym uruchomieniu:
# Start a headless server in one terminalcodetutor serve
# In another terminal, run commands that attach to itcodetutor 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 CodeTutor (np. http://localhost:4096) | |
--password | -p | Hasło uwierzytelniania podstawowego (domyślnie CODETUTOR_SERVER_PASSWORD) |
--username | -u | Nazwa użytkownika uwierzytelniania podstawowego (domyślnie CODETUTOR_SERVER_USERNAME lub codetutor) |
--dir | Katalog do uruchomienia lub ścieżka na zdalnym serwerze podczas dołączania | |
--variant | Wariant modelu (poziom wnioskowania specyficzny dla dostawcy) | |
--thinking | Pokaż bloki myślenia | |
--port | Port 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.
codetutor serveUruchamia 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
| 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 CodeTutor.
codetutor session [command]list
Lista wszystkich sesji CodeTutor.
codetutor 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 CodeTutor.
codetutor 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.
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.
codetutor import <file>Możesz importować z pliku lokalnego lub adresu URL.
codetutor import session.jsoncodetutor import https://opncd.ai/s/abc123web
Uruchom serwer CodeTutor z interfejsem internetowym.
codetutor webUruchamia 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
| 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).
codetutor 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 CodeTutor i usuń wszystkie powiązane pliki.
codetutor 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 CodeTutor do najnowszej lub określonej wersji.
codetutor upgrade [target]Aby zaktualizować do najnowszej wersji:
codetutor upgradeAby zaktualizować do konkretnej wersji:
codetutor upgrade v0.1.48Flagi
| Flaga | Skrót | Opis |
|---|---|---|
--method | -m | Wymuś metodę instalacji: curl, npm, pnpm, bun, brew |
Flagi globalne
Interfejs CLI CodeTutor 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
CodeTutor można skonfigurować za pomocą zmiennych środowiskowych.
| Zmienna | Typ | Opis |
|---|---|---|
CODETUTOR_AUTO_SHARE | boolean | Automatycznie udostępniaj sesje |
CODETUTOR_GIT_BASH_PATH | string | Ścieżka do pliku wykonywalnego Git Bash w systemie Windows |
CODETUTOR_CONFIG | string | Ścieżka do pliku konfiguracyjnego |
CODETUTOR_TUI_CONFIG | string | Ścieżka do pliku konfiguracyjnego TUI |
CODETUTOR_CONFIG_DIR | string | Ścieżka do katalogu konfiguracyjnego |
CODETUTOR_CONFIG_CONTENT | string | Treść konfiguracji JSON (inline) |
CODETUTOR_DISABLE_AUTOUPDATE | boolean | Wyłącz automatyczne sprawdzanie aktualizacji |
CODETUTOR_DISABLE_PRUNE | boolean | Wyłącz czyszczenie starych wyników (pruning) |
CODETUTOR_DISABLE_TERMINAL_TITLE | boolean | Wyłącz automatyczne ustawianie tytułu terminala |
CODETUTOR_PERMISSION | string | Konfiguracja uprawnień w JSON (inline) |
CODETUTOR_DISABLE_DEFAULT_PLUGINS | boolean | Wyłącz domyślne wtyczki |
CODETUTOR_DISABLE_LSP_DOWNLOAD | boolean | Wyłącz automatyczne pobieranie serwerów LSP |
CODETUTOR_ENABLE_EXPERIMENTAL_MODELS | boolean | Włącz modele eksperymentalne |
CODETUTOR_DISABLE_AUTOCOMPACT | boolean | Wyłącz automatyczne kompaktowanie kontekstu |
CODETUTOR_DISABLE_CLAUDE_CODE | boolean | Wyłącz integrację z .claude (prompt + skills) |
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPT | boolean | Wyłącz czytanie ~/.claude/CLAUDE.md |
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLS | boolean | Wyłącz ładowanie .claude/skills |
CODETUTOR_DISABLE_MODELS_FETCH | boolean | Wyłącz pobieranie modeli ze źródeł zewnętrznych |
CODETUTOR_FAKE_VCS | string | Fałszywy dostawca VCS do celów testowych |
CODETUTOR_CLIENT | string | Identyfikator klienta (domyślnie cli) |
CODETUTOR_ENABLE_EXA | boolean | Włącz narzędzie wyszukiwania internetowego Exa |
CODETUTOR_SERVER_PASSWORD | string | Włącz uwierzytelnianie podstawowe dla serve/web |
CODETUTOR_SERVER_USERNAME | string | Nazwa użytkownika do autoryzacji (domyślnie codetutor) |
CODETUTOR_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 |
|---|---|---|
CODETUTOR_EXPERIMENTAL | boolean | Włącz funkcje eksperymentalne objęte flagą zbiorczą |
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERY | boolean | Włącz wykrywanie ikon |
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolean | Wyłącz kopiowanie przy zaznaczaniu w TUI |
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | number | Domyślny limit czasu dla narzędzia bash w ms |
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAX | number | Maksymalne tokeny wyjściowe dla LLM |
CODETUTOR_EXPERIMENTAL_FILEWATCHER | boolean | Włącz obserwatora plików dla całego katalogu |
CODETUTOR_EXPERIMENTAL_OXFMT | boolean | Włącz formater oxfmt |
CODETUTOR_EXPERIMENTAL_LSP_TOOL | boolean | Włącz eksperymentalne narzędzie LSP |
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHER | boolean | Wyłącz obserwatora plików |
CODETUTOR_EXPERIMENTAL_EXA | boolean | Włącz funkcje eksperymentalne Exa |
CODETUTOR_EXPERIMENTAL_LSP_TY | boolean | Włącz TY LSP dla plików python |
CODETUTOR_EXPERIMENTAL_PLAN_MODE | boolean | Włącz tryb planowania |
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTS | boolean | Włącz zadania subagentów w tle |
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEM | boolean | Włącz eksperymentalny system zdarzeń |
CODETUTOR_EXPERIMENTAL_NATIVE_LLM | boolean | Włącz natywną ścieżkę żądań LLM |
CODETUTOR_EXPERIMENTAL_PARALLEL | boolean | Włącz równoległe wykonywanie wyszukiwania web |
CODETUTOR_EXPERIMENTAL_SCOUT | boolean | Włącz subagenta Scout |
CODETUTOR_EXPERIMENTAL_WORKSPACES | boolean | Włącz obsługę obszarów roboczych |