cli.mdx 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603
  1. ---
  2. title: CLI
  3. description: Opcje i polecenia wiersza poleceń OpenCode.
  4. ---
  5. import { Tabs, TabItem } from "@astrojs/starlight/components"
  6. CLI OpenCode domyślnie uruchamia [TUI](/docs/tui), gdy wywołasz je bez argumentów.
  7. ```bash
  8. opencode
  9. ```
  10. CLI obsługuje też polecenia opisane na tej stronie, więc możesz używać OpenCode programowo.
  11. ```bash
  12. opencode run "Explain how closures work in JavaScript"
  13. ```
  14. ---
  15. ### tui
  16. Uruchamia interfejs terminalowy (TUI) OpenCode.
  17. ```bash
  18. opencode [project]
  19. ```
  20. #### Flagi
  21. | Flaga | Skrót | Opis |
  22. | ------------ | ----- | ----------------------------------------------------------------------- |
  23. | `--continue` | `-c` | Kontynuuj ostatnią sesję |
  24. | `--session` | `-s` | Identyfikator sesji do kontynuowania |
  25. | `--fork` | | Sklonuj sesję podczas kontynuacji (użyj z `--continue` lub `--session`) |
  26. | `--prompt` | | Monit do użycia |
  27. | `--model` | `-m` | Model do użycia w formacie dostawca/model |
  28. | `--agent` | | Agent do użycia |
  29. | `--port` | | Port do nasłuchiwania |
  30. | `--hostname` | | Nazwa hosta, do której należy się powiązać |
  31. ---
  32. ## Polecenia
  33. Interfejs CLI OpenCode zawiera także dodatkowe polecenia.
  34. ---
  35. ### agent
  36. Zarządzaj agentami OpenCode.
  37. ```bash
  38. opencode agent [command]
  39. ```
  40. ---
  41. ### attach
  42. Dołącz terminal do już działającego serwera backendu OpenCode uruchomionego za pomocą `serve` lub `web`.
  43. ```bash
  44. opencode attach [url]
  45. ```
  46. Pozwala to połączyć TUI ze zdalnym backendem OpenCode. Na przykład:
  47. ```bash
  48. # Start the backend server for web/mobile access
  49. opencode web --port 4096 --hostname 0.0.0.0
  50. # In another terminal, attach the TUI to the running backend
  51. opencode attach http://10.20.30.40:4096
  52. ```
  53. #### Flagi
  54. | Flaga | Skrót | Opis |
  55. | ----------- | ----- | --------------------------------------- |
  56. | `--dir` | | Katalog roboczy, w którym uruchomić TUI |
  57. | `--session` | `-s` | Identyfikator sesji do kontynuowania |
  58. ---
  59. #### create
  60. Utwórz nowego agenta z niestandardową konfiguracją.
  61. ```bash
  62. opencode agent create
  63. ```
  64. To polecenie poprowadzi Cię przez proces tworzenia nowego agenta z niestandardowym promptem systemowym i konfiguracją narzędzi.
  65. ---
  66. #### list
  67. Wyświetl listę wszystkich agentów.
  68. ```bash
  69. opencode agent list
  70. ```
  71. ---
  72. ### auth
  73. Zarządzaj danymi uwierzytelniającymi i logowaniem dla dostawców.
  74. ```bash
  75. opencode auth [command]
  76. ```
  77. ---
  78. #### login
  79. 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`.
  80. ```bash
  81. opencode auth login
  82. ```
  83. Podczas uruchamiania OpenCode ładuje dostawców z pliku poświadczeń, a także ze zmiennych środowiskowych lub pliku `.env` w Twoim projekcie.
  84. ---
  85. #### list
  86. Wyświetl listę wszystkich uwierzytelnionych dostawców przechowywanych w pliku poświadczeń.
  87. ```bash
  88. opencode auth list
  89. ```
  90. Lub skrócona wersja:
  91. ```bash
  92. opencode auth ls
  93. ```
  94. ---
  95. #### logout
  96. Wyloguj się z dostawcy, usuwając go z pliku poświadczeń.
  97. ```bash
  98. opencode auth logout
  99. ```
  100. ---
  101. ### github
  102. Zarządzaj agentem GitHub w celu automatyzacji repozytorium.
  103. ```bash
  104. opencode github [command]
  105. ```
  106. ---
  107. #### install
  108. Zainstaluj agenta GitHub w swoim repozytorium.
  109. ```bash
  110. opencode github install
  111. ```
  112. Spowoduje to utworzenie pliku workflow GitHub Actions i poprowadzi Cię przez proces konfiguracji. [Dowiedz się więcej](/docs/github).
  113. ---
  114. #### run
  115. Uruchom agenta na GitHubie. Zwykle używane w GitHub Actions.
  116. ```bash
  117. opencode github run
  118. ```
  119. ##### Flagi
  120. | Flaga | Opis |
  121. | --------- | ---------------------------------------- |
  122. | `--event` | Zdarzenie GitHub, które wyzwoliło agenta |
  123. | `--token` | Osobisty token dostępu GitHub |
  124. ---
  125. ### mcp
  126. Zarządzaj serwerami Model Context Protocol (MCP).
  127. ```bash
  128. opencode mcp [command]
  129. ```
  130. ---
  131. #### add
  132. Dodaj serwer MCP do swojej konfiguracji.
  133. ```bash
  134. opencode mcp add
  135. ```
  136. To polecenie poprowadzi Cię przez proces dodawania lokalnego lub zdalnego serwera MCP.
  137. ---
  138. #### list
  139. Wyświetl listę wszystkich skonfigurowanych serwerów MCP i ich status.
  140. ```bash
  141. opencode mcp list
  142. ```
  143. Lub skrócona wersja:
  144. ```bash
  145. opencode mcp ls
  146. ```
  147. ---
  148. #### auth
  149. Uwierzytelnij się w serwerze MCP z włączoną funkcją OAuth.
  150. ```bash
  151. opencode mcp auth [name]
  152. ```
  153. Jeśli nie podasz nazwy serwera, zostaniesz poproszony o wybranie jednego z serwerów wymagających uwierzytelnienia.
  154. Możesz także wyświetlić listę serwerów obsługujących OAuth i ich status uwierzytelnienia.
  155. ```bash
  156. opencode mcp auth list
  157. ```
  158. Lub skrócona wersja:
  159. ```bash
  160. opencode mcp auth ls
  161. ```
  162. ---
  163. #### logout
  164. Usuń tokeny OAuth dla serwera MCP.
  165. ```bash
  166. opencode mcp logout [name]
  167. ```
  168. ---
  169. #### debug
  170. Debuguj problemy z połączeniem OAuth dla serwera MCP.
  171. ```bash
  172. opencode mcp debug <name>
  173. ```
  174. ---
  175. ### models
  176. Wyświetl listę modeli ze wszystkich skonfigurowanych dostawców.
  177. ```bash
  178. opencode models [provider]
  179. ```
  180. Pokazuje modele dostępne do użycia w `provider/model`.
  181. Jest to identyfikator modelu, którego używasz w [konfiguracji](/docs/config).
  182. Opcjonalnie możesz podać identyfikator dostawcy, aby filtrować modele według tego dostawcy.
  183. ```bash
  184. opencode models anthropic
  185. ```
  186. #### Flagi
  187. | Flaga | Opis |
  188. | ----------- | ------------------------------------------------------------------------------- |
  189. | `--refresh` | Odśwież pamięć podręczną modeli |
  190. | `--verbose` | Bardziej szczegółowe dane wyjściowe modelu (zawiera metadane, takie jak koszty) |
  191. 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.
  192. ```bash
  193. opencode models --refresh
  194. ```
  195. ---
  196. ### run
  197. Uruchom OpenCode w trybie nieinteraktywnym, przekazując bezpośrednio prompt.
  198. ```bash
  199. opencode run [message..]
  200. ```
  201. Jest to przydatne do tworzenia skryptów, automatyzacji lub gdy chcesz wysłać szybkie zapytanie bez uruchamiania TUI. Na przykład:
  202. ```bash "opencode run"
  203. opencode run Explain the use of context in Go
  204. ```
  205. Można również użyć tego z działającym `opencode serve`, aby uniknąć zimnego startu serwera MCP przy każdym uruchomieniu:
  206. ```bash
  207. # Start a headless server in one terminal
  208. opencode serve
  209. # In another terminal, run commands that attach to it
  210. opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"
  211. ```
  212. #### Flagi
  213. | Flaga | Skrót | Opis |
  214. | ------------ | ----- | ----------------------------------------------------------------------- |
  215. | `--command` | | Polecenie do uruchomienia, reszta to argumenty |
  216. | `--continue` | `-c` | Kontynuuj ostatnią sesję |
  217. | `--session` | `-s` | Identyfikator sesji do kontynuowania |
  218. | `--fork` | | Sklonuj sesję podczas kontynuacji (użyj z `--continue` lub `--session`) |
  219. | `--share` | | Udostępnij sesję po zakończeniu |
  220. | `--model` | `-m` | Model do użycia w formacie dostawca/model |
  221. | `--agent` | | Agent do użycia |
  222. | `--file` | `-f` | Pliki do załączenia do wiadomości |
  223. | `--format` | | Format wyjściowy: `default` (sformatowany) lub `json` (surowy JSON) |
  224. | `--title` | | Tytuł sesji (jeśli nie podano, zostanie wygenerowany z promptu) |
  225. | `--attach` | | Dołącz do działającego serwera OpenCode (np. http://localhost:4096) |
  226. | `--port` | | Port dla serwera lokalnego (domyślnie losowy) |
  227. ---
  228. ### serve
  229. Uruchom serwer OpenCode (bez interfejsu) w celu uzyskania dostępu do API. Pełny opis API HTTP znajduje się w [dokumentacji serwera](/docs/server).
  230. ```bash
  231. opencode serve
  232. ```
  233. 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`).
  234. #### Flagi
  235. | Flaga | Opis |
  236. | ------------ | ------------------------------------------ |
  237. | `--port` | Port do nasłuchiwania |
  238. | `--hostname` | Nazwa hosta, do której należy się powiązać |
  239. | `--mdns` | Włącz wykrywanie mDNS |
  240. | `--cors` | Dodatkowe dozwolone źródła CORS |
  241. ---
  242. ### session
  243. Zarządzaj sesjami OpenCode.
  244. ```bash
  245. opencode session [command]
  246. ```
  247. ---
  248. #### list
  249. Lista wszystkich sesji OpenCode.
  250. ```bash
  251. opencode session list
  252. ```
  253. ##### Flagi
  254. | Flaga | Skrót | Opis |
  255. | ------------- | ----- | ------------------------------------------ |
  256. | `--max-count` | `-n` | Ogranicz do ostatnich N sesji |
  257. | `--format` | | Format wyjściowy: tabela lub json (tabela) |
  258. ---
  259. ### stats
  260. Pokaż statystyki wykorzystania tokenów i sesji OpenCode.
  261. ```bash
  262. opencode stats
  263. ```
  264. #### Flagi
  265. | Flaga | Opis |
  266. | ----------- | ------------------------------------------------------------------------------------- |
  267. | `--days` | Pokaż statystyki z ostatnich N dni (domyślnie: cały czas) |
  268. | `--tools` | Pokaż użycie poszczególnych narzędzi (domyślnie: wszystkie) |
  269. | `--models` | Pokaż podział na modele (domyślnie ukryty). Podaj liczbę, aby pokazać N najczęstszych |
  270. | `--project` | Filtruj według projektu (domyślnie: wszystkie projekty, pusty ciąg: bieżący projekt) |
  271. ---
  272. ### export
  273. Eksportuj dane sesji jako JSON.
  274. ```bash
  275. opencode export [sessionID]
  276. ```
  277. Jeśli nie podasz identyfikatora sesji, zostaniesz poproszony o wybranie jednej z ostatnich sesji.
  278. ---
  279. ### import
  280. Importuj dane sesji z pliku JSON lub adresu URL udostępniania OpenCode.
  281. ```bash
  282. opencode import <file>
  283. ```
  284. Możesz importować z pliku lokalnego lub adresu URL.
  285. ```bash
  286. opencode import session.json
  287. opencode import https://opncd.ai/s/abc123
  288. ```
  289. ---
  290. ### web
  291. Uruchom serwer OpenCode z interfejsem internetowym.
  292. ```bash
  293. opencode web
  294. ```
  295. 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`).
  296. #### Flagi
  297. | Flaga | Opis |
  298. | ------------ | ------------------------------------------ |
  299. | `--port` | Port do nasłuchiwania |
  300. | `--hostname` | Nazwa hosta, do której należy się powiązać |
  301. | `--mdns` | Włącz wykrywanie mDNS |
  302. | `--cors` | Dodatkowe dozwolone źródła CORS |
  303. ---
  304. ### acp
  305. Uruchom serwer ACP (Agent Client Protocol).
  306. ```bash
  307. opencode acp
  308. ```
  309. Uruchamia serwer ACP, który komunikuje się przez stdin/stdout przy użyciu JSON-RPC.
  310. #### Flagi
  311. | Flaga | Opis |
  312. | ------------ | ------------------------------------------ |
  313. | `--cwd` | Katalog roboczy |
  314. | `--port` | Port do nasłuchiwania |
  315. | `--hostname` | Nazwa hosta, do której należy się powiązać |
  316. ---
  317. ### uninstall
  318. Odinstaluj OpenCode i usuń wszystkie powiązane pliki.
  319. ```bash
  320. opencode uninstall
  321. ```
  322. #### Flagi
  323. | Flaga | Skrót | Opis |
  324. | --------------- | ----- | ----------------------------- |
  325. | `--keep-config` | `-c` | Zachowaj pliki konfiguracyjne |
  326. | `--keep-data` | `-d` | Zachowaj dane sesji i migawki |
  327. | `--dry-run` | | Pokaż co zostanie usunięte |
  328. | `--force` | `-f` | Pomiń monity o potwierdzenie |
  329. ---
  330. ### upgrade
  331. Aktualizuj OpenCode do najnowszej lub określonej wersji.
  332. ```bash
  333. opencode upgrade [target]
  334. ```
  335. Aby zaktualizować do najnowszej wersji:
  336. ```bash
  337. opencode upgrade
  338. ```
  339. Aby zaktualizować do konkretnej wersji:
  340. ```bash
  341. opencode upgrade v0.1.48
  342. ```
  343. #### Flagi
  344. | Flaga | Skrót | Opis |
  345. | ---------- | ----- | --------------------------------------------------- |
  346. | `--method` | `-m` | Wymuś metodę instalacji: curl, npm, pnpm, bun, brew |
  347. ---
  348. ## Flagi globalne
  349. Interfejs CLI OpenCode przyjmuje następujące flagi globalne dla każdego polecenia.
  350. | Flaga | Skrót | Opis |
  351. | -------------- | ----- | ------------------------------------------- |
  352. | `--help` | `-h` | Wyświetl pomoc |
  353. | `--version` | `-v` | Wydrukuj numer wersji |
  354. | `--print-logs` | | Drukuj logi na stderr |
  355. | `--log-level` | | Poziom logowania (DEBUG, INFO, WARN, ERROR) |
  356. ---
  357. ## Zmienne środowiskowe
  358. OpenCode można skonfigurować za pomocą zmiennych środowiskowych.
  359. | Zmienna | Typ | Opis |
  360. | ------------------------------------- | ------- | ---------------------------------------------------------- |
  361. | `OPENCODE_AUTO_SHARE` | boolean | Automatycznie udostępniaj sesje |
  362. | `OPENCODE_GIT_BASH_PATH` | string | Ścieżka do pliku wykonywalnego Git Bash w systemie Windows |
  363. | `OPENCODE_CONFIG` | string | Ścieżka do pliku konfiguracyjnego |
  364. | `OPENCODE_TUI_CONFIG` | string | Ścieżka do pliku konfiguracyjnego TUI |
  365. | `OPENCODE_CONFIG_DIR` | string | Ścieżka do katalogu konfiguracyjnego |
  366. | `OPENCODE_CONFIG_CONTENT` | string | Treść konfiguracji JSON (inline) |
  367. | `OPENCODE_DISABLE_AUTOUPDATE` | boolean | Wyłącz automatyczne sprawdzanie aktualizacji |
  368. | `OPENCODE_DISABLE_PRUNE` | boolean | Wyłącz czyszczenie starych wyników (pruning) |
  369. | `OPENCODE_DISABLE_TERMINAL_TITLE` | boolean | Wyłącz automatyczne ustawianie tytułu terminala |
  370. | `OPENCODE_PERMISSION` | string | Konfiguracja uprawnień w JSON (inline) |
  371. | `OPENCODE_DISABLE_DEFAULT_PLUGINS` | boolean | Wyłącz domyślne wtyczki |
  372. | `OPENCODE_DISABLE_LSP_DOWNLOAD` | boolean | Wyłącz automatyczne pobieranie serwerów LSP |
  373. | `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | boolean | Włącz modele eksperymentalne |
  374. | `OPENCODE_DISABLE_AUTOCOMPACT` | boolean | Wyłącz automatyczne kompaktowanie kontekstu |
  375. | `OPENCODE_DISABLE_CLAUDE_CODE` | boolean | Wyłącz integrację z `.claude` (prompt + skills) |
  376. | `OPENCODE_DISABLE_CLAUDE_CODE_PROMPT` | boolean | Wyłącz czytanie `~/.claude/CLAUDE.md` |
  377. | `OPENCODE_DISABLE_CLAUDE_CODE_SKILLS` | boolean | Wyłącz ładowanie `.claude/skills` |
  378. | `OPENCODE_DISABLE_MODELS_FETCH` | boolean | Wyłącz pobieranie modeli ze źródeł zewnętrznych |
  379. | `OPENCODE_FAKE_VCS` | string | Fałszywy dostawca VCS do celów testowych |
  380. | `OPENCODE_CLIENT` | string | Identyfikator klienta (domyślnie `cli`) |
  381. | `OPENCODE_ENABLE_EXA` | boolean | Włącz narzędzie wyszukiwania internetowego Exa |
  382. | `OPENCODE_SERVER_PASSWORD` | string | Włącz uwierzytelnianie podstawowe dla `serve`/`web` |
  383. | `OPENCODE_SERVER_USERNAME` | string | Nazwa użytkownika do autoryzacji (domyślnie `opencode`) |
  384. | `OPENCODE_MODELS_URL` | string | Niestandardowy adres URL do pobierania konfiguracji modeli |
  385. ---
  386. ### Eksperymentalne
  387. Te zmienne włączają funkcje eksperymentalne, które mogą ulec zmianie lub zostać usunięte.
  388. | Zmienna | Typ | Opis |
  389. | ----------------------------------------------- | ------- | -------------------------------------------- |
  390. | `OPENCODE_EXPERIMENTAL` | boolean | Włącz wszystkie funkcje eksperymentalne |
  391. | `OPENCODE_EXPERIMENTAL_ICON_DISCOVERY` | boolean | Włącz wykrywanie ikon |
  392. | `OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT` | boolean | Wyłącz kopiowanie przy zaznaczaniu w TUI |
  393. | `OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS` | number | Domyślny limit czasu dla narzędzia bash w ms |
  394. | `OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX` | number | Maksymalne tokeny wyjściowe dla LLM |
  395. | `OPENCODE_EXPERIMENTAL_FILEWATCHER` | boolean | Włącz obserwatora plików dla całego katalogu |
  396. | `OPENCODE_EXPERIMENTAL_OXFMT` | boolean | Włącz formater oxfmt |
  397. | `OPENCODE_EXPERIMENTAL_LSP_TOOL` | boolean | Włącz eksperymentalne narzędzie LSP |
  398. | `OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER` | boolean | Wyłącz obserwatora plików |
  399. | `OPENCODE_EXPERIMENTAL_EXA` | boolean | Włącz funkcje eksperymentalne Exa |
  400. | `OPENCODE_EXPERIMENTAL_LSP_TY` | boolean | Włącz TY LSP dla plików python |
  401. | `OPENCODE_EXPERIMENTAL_MARKDOWN` | boolean | Włącz funkcje eksperymentalne Markdown |
  402. | `OPENCODE_EXPERIMENTAL_PLAN_MODE` | boolean | Włącz tryb planowania |