cli.mdx 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603
  1. ---
  2. title: CLI
  3. description: OpenCode CLI Optionen und Befehle.
  4. ---
  5. import { Tabs, TabItem } from "@astrojs/starlight/components"
  6. Der OpenCode CLI startet standardmäßig den [TUI](/docs/tui), wenn er ohne Argumente ausgeführt wird.
  7. ```bash
  8. opencode
  9. ```
  10. Es akzeptiert aber auch Befehle, wie auf dieser Seite dokumentiert. Dadurch können Sie programmgesteuert mit OpenCode interagieren.
  11. ```bash
  12. opencode run "Explain how closures work in JavaScript"
  13. ```
  14. ---
  15. ### tui
  16. Starten Sie die Terminalbenutzeroberfläche OpenCode.
  17. ```bash
  18. opencode [project]
  19. ```
  20. #### Flaggen
  21. | Flagge | Kurz | Beschreibung |
  22. | ------------ | ---- | ---------------------------------------------------------------------- |
  23. | `--continue` | `-c` | Setzen Sie die letzte Sitzung fort |
  24. | `--session` | `-s` | Sitzung ID zum Fortfahren |
  25. | `--fork` | | Sitzung beim Fortsetzen verzweigen (mit `--continue` oder `--session`) |
  26. | `--prompt` | | Zur Verwendung auffordern |
  27. | `--model` | `-m` | Zu verwendendes Modell in der Form provider/model |
  28. | `--agent` | | Zu verwendender Agent |
  29. | `--port` | | Port zum Abhören |
  30. | `--hostname` | | Hostname zum Abhören |
  31. ---
  32. ## Befehle
  33. Der OpenCode CLI verfügt außerdem über die folgenden Befehle.
  34. ---
  35. ### agent
  36. Agenten für OpenCode verwalten.
  37. ```bash
  38. opencode agent [command]
  39. ```
  40. ---
  41. ### attach
  42. Schließen Sie ein Terminal an einen bereits laufenden OpenCode-Backend-Server an, der über die Befehle `serve` oder `web` gestartet wurde.
  43. ```bash
  44. opencode attach [url]
  45. ```
  46. Dies ermöglicht die Verwendung von TUI mit einem Remote-Backend OpenCode. Zum Beispiel:
  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. #### Flaggen
  54. | Flagge | Kurz | Beschreibung |
  55. | ----------- | ---- | ----------------------------------------- |
  56. | `--dir` | | Arbeitsverzeichnis zum Starten von TUI in |
  57. | `--session` | `-s` | Sitzung ID zum Fortfahren |
  58. ---
  59. #### create
  60. Erstellen Sie einen neuen Agenten mit benutzerdefinierter Konfiguration.
  61. ```bash
  62. opencode agent create
  63. ```
  64. Dieser Befehl führt Sie durch die Erstellung eines neuen Agenten mit einer benutzerdefinierten Systemeingabeaufforderung und Toolkonfiguration.
  65. ---
  66. #### list
  67. Hören Sie sich alle verfügbaren Agenten an.
  68. ```bash
  69. opencode agent list
  70. ```
  71. ---
  72. ### auth
  73. Befehl zum Verwalten von Anmeldeinformationen und Anmelden für Anbieter.
  74. ```bash
  75. opencode auth [command]
  76. ```
  77. ---
  78. #### login
  79. OpenCode wird von der Anbieterliste bei [Models.dev](https://models.dev) unterstützt, sodass Sie `opencode auth login` verwenden können, um API-Schlüssel für jeden Anbieter zu konfigurieren, den Sie verwenden möchten. Dies wird in `~/.local/share/opencode/auth.json` gespeichert.
  80. ```bash
  81. opencode auth login
  82. ```
  83. Wenn OpenCode startet, lädt es den Anbieter aus der Anmeldeinformationsdatei. Und ob in Ihren Umgebungen Schlüssel sind oder in Ihrem Projekt eine `.env`-Datei vorhanden ist.
  84. ---
  85. #### list
  86. Listet alle authentifizierten Anbieter auf, wie in der Anmeldeinformationsdatei gespeichert.
  87. ```bash
  88. opencode auth list
  89. ```
  90. Oder die Kurzversion.
  91. ```bash
  92. opencode auth ls
  93. ```
  94. ---
  95. #### logout
  96. Melden Sie sich von einem Anbieter ab, ohne dass es aus der Anmeldeinformationsdatei gelöscht wird.
  97. ```bash
  98. opencode auth logout
  99. ```
  100. ---
  101. ### github
  102. Verwalten Sie den GitHub-Agenten für die Repository-Automatisierung.
  103. ```bash
  104. opencode github [command]
  105. ```
  106. ---
  107. #### installieren
  108. Installieren Sie den GitHub-Agenten in Ihrem Repository.
  109. ```bash
  110. opencode github install
  111. ```
  112. Dadurch wird der erforderliche GitHub-Aktionsworkflow eingerichtet und Sie durch den Konfigurationsprozess geführt. [Learn more](/docs/github).
  113. ---
  114. #### laufen
  115. Führen Sie den GitHub-Agenten aus. Dies wird normalerweise in GitHub-Aktionen verwendet.
  116. ```bash
  117. opencode github run
  118. ```
  119. ##### Flaggen
  120. | Flagge | Beschreibung |
  121. | --------- | --------------------------------------------------- |
  122. | `--event` | GitHub Scheinereignis zum Ausführen des Agenten für |
  123. | `--token` | GitHub persönliches Zugriffstoken |
  124. ---
  125. ### mcp
  126. Verwalten Sie den Model Context Protocol-Server.
  127. ```bash
  128. opencode mcp [command]
  129. ```
  130. ---
  131. #### add
  132. Fügen Sie Ihrer Konfiguration einen MCP-Server hinzu.
  133. ```bash
  134. opencode mcp add
  135. ```
  136. Dieser Befehl führt Sie durch das Hinzufügen eines lokalen oder Remote-Servers MCP.
  137. ---
  138. #### list
  139. Hören Sie sich alle konfigurierten MCP-Server und deren Verbindungsstatus an.
  140. ```bash
  141. opencode mcp list
  142. ```
  143. Oder nutzen Sie die Kurzversion.
  144. ```bash
  145. opencode mcp ls
  146. ```
  147. ---
  148. #### auth
  149. Authentifizieren Sie sich mit einem OAuth-fähigen MCP-Server.
  150. ```bash
  151. opencode mcp auth [name]
  152. ```
  153. Wenn Sie keinen Servernamen angeben, werden Sie autorisiert, einen der verfügbaren OAuth-fähigen Server auszuwählen.
  154. Sie können auch OAuth-fähige Server und deren Authentifizierungsstatus auflisten.
  155. ```bash
  156. opencode mcp auth list
  157. ```
  158. Oder nutzen Sie die Kurzversion.
  159. ```bash
  160. opencode mcp auth ls
  161. ```
  162. ---
  163. #### logout
  164. Entfernen Sie OAuth-Anmeldeinformationen für einen MCP-Server.
  165. ```bash
  166. opencode mcp logout [name]
  167. ```
  168. ---
  169. #### debug
  170. Beheben Sie OAuth-Verbindungsprobleme für einen MCP-Server.
  171. ```bash
  172. opencode mcp debug <name>
  173. ```
  174. ---
  175. ### models
  176. Hören Sie sich alle verfügbaren Modelle der konfigurierten Anbieter an.
  177. ```bash
  178. opencode models [provider]
  179. ```
  180. Dieser Befehl zeigt alle bei Ihren konfigurierten Anbietern verfügbaren Modelle im Format `provider/model` an.
  181. Dies ist nützlich, um die genauen Modellnamen herauszufinden, die in [your config](/docs/config/) verwendet werden sollen.
  182. Sie können optional einen Anbieter ID übergeben, um Modelle nach diesem Anbieter zu filtern.
  183. ```bash
  184. opencode models anthropic
  185. ```
  186. #### Flaggen
  187. | Flagge | Beschreibung |
  188. | ----------- | ------------------------------------------------------------------------------------- |
  189. | `--refresh` | Aktualisieren Sie den Modellcache von models.dev |
  190. | `--verbose` | Verwenden Sie eine ausführlichere Modellausgabe (einschließlich Metadaten wie Kosten) |
  191. Verwenden Sie das Flag `--refresh`, um die zwischengespeicherte Modellliste zu aktualisieren. Dies ist nützlich, wenn einem Anbieter neue Modelle hinzugefügt wurden und Sie diese in OpenCode sehen möchten.
  192. ```bash
  193. opencode models --refresh
  194. ```
  195. ---
  196. ### laufen
  197. Führen Sie Opencode im nicht interaktiven Modus aus, indem Sie direkt eine Eingabeaufforderung übergeben.
  198. ```bash
  199. opencode run [message..]
  200. ```
  201. Dies ist nützlich für die Skripterstellung, die Automatisierung oder wenn Sie eine schnelle Antwort wünschen, ohne den vollständigen TUI zu starten. Zum Beispiel.
  202. ```bash "opencode run"
  203. opencode run Explain the use of context in Go
  204. ```
  205. Sie können auch eine Verbindung zu einer laufenden `opencode serve`-Instanz herstellen, um bei jedem Lauf Kaltstartzeiten für den MCP-Server zu vermeiden:
  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. #### Flaggen
  213. | Flagge | Kurz | Beschreibung |
  214. | ------------ | ---- | --------------------------------------------------------------------------------------------------- |
  215. | `--command` | | Der auszuführende Befehl, Nachricht für Argumente verwenden |
  216. | `--continue` | `-c` | Setzen Sie die letzte Sitzung fort |
  217. | `--session` | `-s` | Sitzung ID zum Fortfahren |
  218. | `--fork` | | Verzweigen Sie die Sitzung beim Fortsetzen (mit `--continue` oder `--session`) verwenden |
  219. | `--share` | | Teilen Sie die Sitzung |
  220. | `--model` | `-m` | Zu verwendendes Modell in der Form provider/model |
  221. | `--agent` | | Zu verwendender Agent |
  222. | `--file` | `-f` | Datei(en) zum Anhängen an die Nachricht |
  223. | `--format` | | Format: Standard (formatiert) oder JSON (rohe JSON-Ereignisse) |
  224. | `--title` | | Titel für die Sitzung (verwendet eine verkürzte Eingabeaufforderung, wenn kein Wert angegeben wird) |
  225. | `--attach` | | An einen laufenden Opencode-Server anschließen (e.g., http://localhost:4096) |
  226. | `--port` | | Port für den lokalen Server (standardmäßig zufälliger Port) |
  227. ---
  228. ### serve
  229. Starten Sie einen Headless-OpenCode-Server für den API-Zugriff. Sehen Sie sich [server docs](/docs/server) für die vollständige HTTP-Schnittstelle an.
  230. ```bash
  231. opencode serve
  232. ```
  233. Dadurch wird ein HTTP-Server gestartet, der API-Zugriff auf Opencode-Funktionalität ohne die TUI-Schnittstelle bietet. Legen Sie `OPENCODE_SERVER_PASSWORD` fest, um die HTTP-Basisauthentifizierung zu aktivieren (Benutzername ist standardmäßig `opencode`).
  234. #### Flaggen
  235. | Flagge | Beschreibung |
  236. | ------------ | -------------------------------------------------- |
  237. | `--port` | Port zum Abhören |
  238. | `--hostname` | Hostname zum Abhören |
  239. | `--mdns` | mDNS-Erkennung aktivieren |
  240. | `--cors` | Zusätzliche Browserursprung(e), um CORS zuzulassen |
  241. ---
  242. ### Sitzung
  243. Verwalten Sie OpenCode-Sitzungen.
  244. ```bash
  245. opencode session [command]
  246. ```
  247. ---
  248. #### list
  249. Hören Sie sich alle OpenCode-Sitzungen an.
  250. ```bash
  251. opencode session list
  252. ```
  253. ##### Flaggen
  254. | Flagge | Kurz | Beschreibung |
  255. | ------------- | ---- | ------------------------------------------ |
  256. | `--max-count` | `-n` | Auf N letzte Sitzungen beschränken |
  257. | `--format` | | Ausgabeformat: Tabelle oder JSON (Tabelle) |
  258. ---
  259. ### stats
  260. Zeigen Sie Token-Nutzungs- und Kostenstatistiken für Ihre OpenCode-Sitzungen an.
  261. ```bash
  262. opencode stats
  263. ```
  264. #### Flaggen
  265. | Flagge | Beschreibung |
  266. | ----------- | ------------------------------------------------------------------------------------------------------------------------------ |
  267. | `--days` | Statistiken für die letzten N Tage anzeigen (alle Zeiten) |
  268. | `--tools` | Anzahl der angebotenen Werkzeuge (alle) |
  269. | `--models` | Aufschlüsselung der Modellnutzung anzeigen (standardmäßig ausgeblendet). Übergeben Sie eine Zahl, um die obersten N anzuzeigen |
  270. | `--project` | Nach Projekt filtern (alle Projekte, leere Zeichenfolge: aktuelles Projekt) |
  271. ---
  272. ### export
  273. Sitzungsdaten als JSON exportieren.
  274. ```bash
  275. opencode export [sessionID]
  276. ```
  277. Wenn Sie keine Sitzung ID angeben, werden Sie berechtigt, eine der verfügbaren Sitzungen auszuwählen.
  278. ---
  279. ### import
  280. Importieren Sie Sitzungsdaten aus einer JSON-Datei oder einer OpenCode-Freigabe URL.
  281. ```bash
  282. opencode import <file>
  283. ```
  284. Sie können aus einer lokalen Datei oder einer OpenCode-Freigabe URL importieren.
  285. ```bash
  286. opencode import session.json
  287. opencode import https://opncd.ai/s/abc123
  288. ```
  289. ---
  290. ### web
  291. Starten Sie einen Headless-OpenCode-Server mit einer Weboberfläche.
  292. ```bash
  293. opencode web
  294. ```
  295. Dadurch wird ein HTTP-Server gestartet und ein Webbrowser geöffnet, um über eine Webschnittstelle auf OpenCode zuzugreifen. Legen Sie `OPENCODE_SERVER_PASSWORD` fest, um die HTTP-Basisauthentifizierung zu aktivieren (Benutzername ist standardmäßig `opencode`).
  296. #### Flaggen
  297. | Flagge | Beschreibung |
  298. | ------------ | -------------------------------------------------- |
  299. | `--port` | Port zum Abhören |
  300. | `--hostname` | Hostname zum Abhören |
  301. | `--mdns` | mDNS-Erkennung aktivieren |
  302. | `--cors` | Zusätzliche Browserursprung(e), um CORS zuzulassen |
  303. ---
  304. ### acp
  305. Starten Sie einen ACP-Server (Agent Client Protocol).
  306. ```bash
  307. opencode acp
  308. ```
  309. Dieser Befehl startet einen ACP-Server, der über stdin/stdout mit nd-JSON kommuniziert.
  310. #### Flaggen
  311. | Flagge | Beschreibung |
  312. | ------------ | -------------------- |
  313. | `--cwd` | Arbeitsverzeichnis |
  314. | `--port` | Port zum Abhören |
  315. | `--hostname` | Hostname zum Abhören |
  316. ---
  317. ### uninstall
  318. Deinstallieren Sie OpenCode und entfernen Sie alle zugehörigen Dateien.
  319. ```bash
  320. opencode uninstall
  321. ```
  322. #### Flaggen
  323. | Flagge | Kurz | Beschreibung |
  324. | --------------- | ---- | --------------------------------------------------- |
  325. | `--keep-config` | `-c` | Konfigurationsdateien behalten |
  326. | `--keep-data` | `-d` | Sitzungsdaten und Snapshots aufbewahren |
  327. | `--dry-run` | | Zeigt, was entfernt werden würde, ohne zu entfernen |
  328. | `--force` | `-f` | Bestätigungsaufforderungen überspringen |
  329. ---
  330. ### upgrade
  331. Aktualisiert Opencode auf die neueste Version oder eine bestimmte Version.
  332. ```bash
  333. opencode upgrade [target]
  334. ```
  335. Um auf die neueste Version zu aktualisieren.
  336. ```bash
  337. opencode upgrade
  338. ```
  339. Um auf eine bestimmte Version zu aktualisieren.
  340. ```bash
  341. opencode upgrade v0.1.48
  342. ```
  343. #### Flaggen
  344. | Flagge | Kurz | Beschreibung |
  345. | ---------- | ---- | --------------------------------------------------------------- |
  346. | `--method` | `-m` | Die verwendete Installationsmethode; curl, npm, pnpm, bun, brew |
  347. ---
  348. ## Globale Flaggen
  349. Der Opencode CLI akzeptiert die folgenden globalen Flags.
  350. | Flagge | Kurz | Beschreibung |
  351. | -------------- | ---- | ----------------------------------------- |
  352. | `--help` | `-h` | Hilfe anzeigen |
  353. | `--version` | `-v` | Versionsnummer drucken |
  354. | `--print-logs` | | Protokolle nach Standard drucken |
  355. | `--log-level` | | Protokollebene (DEBUG, INFO, WARN, ERROR) |
  356. ---
  357. ## Umgebungsvariablen
  358. OpenCode kann mithilfe von Umgebungsvariablen konfiguriert werden.
  359. | Variable | Geben Sie | eine Beschreibung |
  360. | ------------------------------------- | --------------- | -------------------------------------------------------------------------------- |
  361. | `OPENCODE_AUTO_SHARE` | boolescher Wert | Sitzungen automatisch teilen |
  362. | `OPENCODE_GIT_BASH_PATH` | Zeichenfolge | Pfad zur ausführbaren Git Bash-Datei unter Windows |
  363. | `OPENCODE_CONFIG` | Zeichenfolge | Pfad zur Konfigurationsdatei |
  364. | `OPENCODE_CONFIG_DIR` | Zeichenfolge | Pfad zum Konfigurationsverzeichnis |
  365. | `OPENCODE_CONFIG_CONTENT` | Zeichenfolge | Inline-JSON-Konfigurationsinhalt |
  366. | `OPENCODE_DISABLE_AUTOUPDATE` | boolescher Wert | Automatische Update-Prüfungen deaktivieren |
  367. | `OPENCODE_DISABLE_PRUNE` | boolescher Wert | Bereinigung alter Daten deaktivieren |
  368. | `OPENCODE_DISABLE_TERMINAL_TITLE` | boolescher Wert | Deaktivieren Sie die automatische Aktualisierung von Terminaltiteln |
  369. | `OPENCODE_PERMISSION` | Zeichenfolge | Inline-JSON-Berechtigungskonfiguration |
  370. | `OPENCODE_DISABLE_DEFAULT_PLUGINS` | boolescher Wert | Standard-Plugins deaktivieren |
  371. | `OPENCODE_DISABLE_LSP_DOWNLOAD` | boolescher Wert | Automatische LSP-Server-Downloads deaktivieren |
  372. | `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | boolescher Wert | Experimentelle Modelle aktivieren |
  373. | `OPENCODE_DISABLE_AUTOCOMPACT` | boolescher Wert | Automatische Kontextkomprimierung deaktivieren |
  374. | `OPENCODE_DISABLE_CLAUDE_CODE` | boolescher Wert | Deaktivieren Sie das Lesen von `.claude` (Eingabeaufforderung + Fähigkeiten) |
  375. | `OPENCODE_DISABLE_CLAUDE_CODE_PROMPT` | boolescher Wert | Deaktivieren Sie das Lesen von `~/.claude/CLAUDE.md` |
  376. | `OPENCODE_DISABLE_CLAUDE_CODE_SKILLS` | boolescher Wert | Deaktivieren Sie das Laden von `.claude/skills` |
  377. | `OPENCODE_DISABLE_MODELS_FETCH` | boolescher Wert | Deaktivieren Sie das gesammelte Modell von Remote-Quellen |
  378. | `OPENCODE_FAKE_VCS` | Zeichenfolge | Gefälschter VCS-Anbieter zu Testzwecken |
  379. | `OPENCODE_DISABLE_FILETIME_CHECK` | boolescher Wert | Dateizeitprüfung zur Optimierung deaktivieren |
  380. | `OPENCODE_CLIENT` | Zeichenfolge | Client-ID (standardmäßig `cli`) |
  381. | `OPENCODE_ENABLE_EXA` | boolescher Wert | Exa-Websuchtools aktivieren |
  382. | `OPENCODE_SERVER_PASSWORD` | Zeichenfolge | Aktivieren Sie die Basisauthentifizierung für `serve`/`web` |
  383. | `OPENCODE_SERVER_USERNAME` | Zeichenfolge | Benutzernamen für die Basisauthentifizierung überschreiben (Standard `opencode`) |
  384. | `OPENCODE_MODELS_URL` | Zeichenfolge | Benutzerdefinierte URL zum Erhalten der Modellkonfiguration |
  385. ---
  386. ### Experimental
  387. Diese Umgebungsvariablen ermöglichen experimentelle Funktionen, die sich ändern oder entfernen können.
  388. | Variable | Geben Sie | eine Beschreibung |
  389. | ----------------------------------------------- | --------------- | ------------------------------------------------------- |
  390. | `OPENCODE_EXPERIMENTAL` | boolescher Wert | Alle experimentellen Funktionen aktivieren |
  391. | `OPENCODE_EXPERIMENTAL_ICON_DISCOVERY` | boolescher Wert | Symbolerkennung aktivieren |
  392. | `OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT` | boolescher Wert | Kopieren bei Auswahl in TUI deaktivieren |
  393. | `OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS` | Zahl | Standard-Timeout für Bash-Befehle in ms |
  394. | `OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX` | Zahl | Maximale Ausgabetokens für LLM-Antworten |
  395. | `OPENCODE_EXPERIMENTAL_FILEWATCHER` | boolescher Wert | Dateiüberwachung für das gesamte Verzeichnis aktivieren |
  396. | `OPENCODE_EXPERIMENTAL_OXFMT` | boolescher Wert | Oxfmt-Formatierer aktivieren |
  397. | `OPENCODE_EXPERIMENTAL_LSP_TOOL` | boolescher Wert | Experimentelles LSP-Tool aktivieren |
  398. | `OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER` | boolescher Wert | Dateiüberwachung deaktivieren |
  399. | `OPENCODE_EXPERIMENTAL_EXA` | boolescher Wert | Experimentelle Exa-Funktionen aktivieren |
  400. | `OPENCODE_EXPERIMENTAL_LSP_TY` | boolescher Wert | Experimentelle LSP-Typprüfung aktivieren |
  401. | `OPENCODE_EXPERIMENTAL_MARKDOWN` | boolescher Wert | Experimentelle Markdown-Funktionen aktivieren |
  402. | `OPENCODE_EXPERIMENTAL_PLAN_MODE` | boolescher Wert | Planmodus aktivieren |