Przejdź do treści
Dokumentacja V1
tui

CLI

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

Terminal
opencode

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

Terminal
opencode run "Explain how closures work in JavaScript"

Uruchamia interfejs terminalowy (TUI) OpenCode.

Terminal
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ć

Interfejs CLI OpenCode zawiera także dodatkowe polecenia.


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

Terminal
opencode attach [url]

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

Terminal
# Start the backend server for web/mobile access
opencode web --port 4096 --hostname 0.0.0.0

# In another terminal, attach the TUI to the running backend
opencode 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 OPENCODE_SERVER_PASSWORD)
--username-uNazwa użytkownika uwierzytelniania podstawowego (domyślnie OPENCODE_SERVER_USERNAME lub opencode)

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

Terminal
opencode auth [command]

login

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

Terminal
opencode auth login

Podczas uruchamiania OpenCode ł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ń.

Terminal
opencode auth list

Lub skrócona wersja:

Terminal
opencode auth ls

logout

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

Terminal
opencode auth logout

Zarządzaj agentem GitHub w celu automatyzacji repozytorium.

Terminal
opencode github [command]

install

Zainstaluj agenta GitHub w swoim repozytorium.

Terminal
opencode 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.

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

Zarządzaj serwerami Model Context Protocol (MCP).

Terminal
opencode mcp [command]

add

Dodaj serwer MCP do swojej konfiguracji.

Terminal
opencode 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.

Terminal
opencode mcp list

Lub skrócona wersja:

Terminal
opencode mcp ls

auth

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

Terminal
opencode 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.

Terminal
opencode mcp auth list

Lub skrócona wersja:

Terminal
opencode mcp auth ls

logout

Usuń tokeny OAuth dla serwera MCP.

Terminal
opencode mcp logout [name]

debug

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

Terminal
opencode mcp debug <name>

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

Terminal
opencode 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.

Terminal
opencode 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 OpenCode.

Terminal
opencode models --refresh

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

Terminal
opencode run [message..]

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

Terminal
opencode run Explain the use of context in Go

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

Terminal
# Start a headless server in one terminal
opencode serve

# In another terminal, run commands that attach to it
opencode 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)
--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 OpenCode (np. http://localhost:4096)
--password-pHasło uwierzytelniania podstawowego (domyślnie OPENCODE_SERVER_PASSWORD)
--username-uNazwa użytkownika uwierzytelniania podstawowego (domyślnie OPENCODE_SERVER_USERNAME lub opencode)
--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)

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

Terminal
opencode serve

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

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

Zarządzaj sesjami OpenCode.

Terminal
opencode session [command]

list

Lista wszystkich sesji OpenCode.

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

Pokaż statystyki wykorzystania tokenów i sesji OpenCode.

Terminal
opencode 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)

Eksportuj dane sesji jako JSON.

Terminal
opencode export [sessionID]

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


Importuj dane sesji z pliku JSON.

Terminal
opencode import <file>
Terminal
opencode import session.json

Uruchom serwer OpenCode z interfejsem internetowym.

Terminal
opencode web

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

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

Uruchom serwer ACP (Agent Client Protocol).

Terminal
opencode 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ć

Odinstaluj OpenCode i usuń wszystkie powiązane pliki.

Terminal
opencode 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

Aktualizuj OpenCode do najnowszej lub określonej wersji.

Terminal
opencode upgrade [target]

Aby zaktualizować do najnowszej wersji:

Terminal
opencode upgrade

Aby zaktualizować do konkretnej wersji:

Terminal
opencode upgrade v0.1.48

Flagi

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

Interfejs CLI OpenCode 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)

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

ZmiennaTypOpis
OPENCODE_GIT_BASH_PATHstringŚcieżka do pliku wykonywalnego Git Bash w systemie Windows
OPENCODE_CONFIGstringŚcieżka do pliku konfiguracyjnego
OPENCODE_TUI_CONFIGstringŚcieżka do pliku konfiguracyjnego TUI
OPENCODE_CONFIG_DIRstringŚcieżka do katalogu konfiguracyjnego
OPENCODE_CONFIG_CONTENTstringTreść konfiguracji JSON (inline)
OPENCODE_DISABLE_AUTOUPDATEbooleanWyłącz automatyczne sprawdzanie aktualizacji
OPENCODE_DISABLE_PRUNEbooleanWyłącz czyszczenie starych wyników (pruning)
OPENCODE_DISABLE_TERMINAL_TITLEbooleanWyłącz automatyczne ustawianie tytułu terminala
OPENCODE_PERMISSIONstringKonfiguracja uprawnień w JSON (inline)
OPENCODE_DISABLE_DEFAULT_PLUGINSbooleanWyłącz domyślne wtyczki
OPENCODE_DISABLE_LSP_DOWNLOADbooleanWyłącz automatyczne pobieranie serwerów LSP
OPENCODE_ENABLE_EXPERIMENTAL_MODELSbooleanWłącz modele eksperymentalne
OPENCODE_DISABLE_AUTOCOMPACTbooleanWyłącz automatyczne kompaktowanie kontekstu
OPENCODE_DISABLE_CLAUDE_CODEbooleanWyłącz integrację z .claude (prompt + skills)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTbooleanWyłącz czytanie ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSbooleanWyłącz ładowanie .claude/skills
OPENCODE_DISABLE_MODELS_FETCHbooleanWyłącz pobieranie modeli ze źródeł zewnętrznych
OPENCODE_FAKE_VCSstringFałszywy dostawca VCS do celów testowych
OPENCODE_CLIENTstringIdentyfikator klienta (domyślnie cli)
OPENCODE_ENABLE_EXAbooleanWłącz narzędzie wyszukiwania internetowego Exa
OPENCODE_SERVER_PASSWORDstringWłącz uwierzytelnianie podstawowe dla serve/web
OPENCODE_SERVER_USERNAMEstringNazwa użytkownika do autoryzacji (domyślnie opencode)
OPENCODE_MODELS_URLstringNiestandardowy adres URL do pobierania konfiguracji modeli

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

ZmiennaTypOpis
OPENCODE_EXPERIMENTALbooleanWłącz funkcje eksperymentalne objęte flagą zbiorczą
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooleanWłącz wykrywanie ikon
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanWyłącz kopiowanie przy zaznaczaniu w TUI
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberDomyślny limit czasu dla narzędzia bash w ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberMaksymalne tokeny wyjściowe dla LLM
OPENCODE_EXPERIMENTAL_FILEWATCHERbooleanWłącz obserwatora plików dla całego katalogu
OPENCODE_EXPERIMENTAL_OXFMTbooleanWłącz formater oxfmt
OPENCODE_EXPERIMENTAL_LSP_TOOLbooleanWłącz eksperymentalne narzędzie LSP
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanWyłącz obserwatora plików
OPENCODE_EXPERIMENTAL_EXAbooleanWłącz funkcje eksperymentalne Exa
OPENCODE_EXPERIMENTAL_LSP_TYbooleanWłącz TY LSP dla plików python
OPENCODE_EXPERIMENTAL_PLAN_MODEbooleanWłącz tryb planowania
OPENCODE_EXPERIMENTAL_EVENT_SYSTEMbooleanWłącz eksperymentalny system zdarzeń
OPENCODE_EXPERIMENTAL_NATIVE_LLMbooleanWłącz natywną ścieżkę żądań LLM
OPENCODE_EXPERIMENTAL_PARALLELbooleanWłącz równoległe wykonywanie wyszukiwania web
OPENCODE_EXPERIMENTAL_SCOUTbooleanWłącz subagenta Scout
OPENCODE_EXPERIMENTAL_WORKSPACESbooleanWłącz obsługę obszarów roboczych