Deutsch
Dokumentation
CLI

CLI

OpenCode CLI-Optionen und -Befehle.

Das OpenCode CLI startet standardmäßig das TUI, wenn es ohne Argumente ausgeführt wird.

opencode

Es akzeptiert aber auch Befehle, wie auf dieser Seite dokumentiert. Dies ermöglicht Ihnen die programmatische Interaktion mit OpenCode.

opencode run "Explain how closures work in JavaScript"

tui

Starten Sie die OpenCode Terminal-Benutzeroberfläche.

opencode [project]

Flags

FlagKurzBeschreibung
--continue-cLetzte Sitzung fortsetzen
--session-sSitzungs-ID zum Fortsetzen
--forkSitzung beim Fortsetzen forken (mit --continue oder --session verwenden)
--promptZu verwendender Prompt
--model-mZu verwendendes Modell im Format provider/model
--agentZu verwendender Agent
--portPort zum Lauschen
--hostnameHostname zum Lauschen

Befehle

Das OpenCode CLI hat außerdem die folgenden Befehle.


agent

Agenten für OpenCode verwalten.

opencode agent [command]

attach

Ein Terminal an einen bereits laufenden OpenCode-Backend-Server anhängen, der über die Befehle serve oder web gestartet wurde.

opencode attach [url]

Dies ermöglicht die Verwendung des TUI mit einem entfernten OpenCode-Backend. Zum Beispiel:

# Backend-Server für Web-/Mobilzugriff starten
opencode web --port 4096 --hostname 0.0.0.0
 
# In einem anderen Terminal das TUI an das laufende Backend anhängen
opencode attach http://10.20.30.40:4096

Flags

FlagKurzBeschreibung
--dirArbeitsverzeichnis zum Starten des TUI
--session-sSitzungs-ID zum Fortsetzen

create

Einen neuen Agenten mit benutzerdefinierter Konfiguration erstellen.

opencode agent create

Dieser Befehl führt Sie durch die Erstellung eines neuen Agenten mit benutzerdefiniertem System-Prompt und Tool-Konfiguration.


list

Alle verfügbaren Agenten auflisten.

opencode agent list

auth

Befehl zum Verwalten von Anmeldedaten und Login für Anbieter.

opencode auth [command]

login

OpenCode wird von der Anbieterliste bei Models.dev (opens in a new tab) unterstützt, sodass Sie opencode auth login verwenden können, um API-Schlüssel für jeden gewünschten Anbieter zu konfigurieren. Diese werden in ~/.local/share/opencode/auth.json gespeichert.

opencode auth login

Beim Start lädt OpenCode die Anbieter aus der Anmeldedatei. Und wenn Schlüssel in Ihren Umgebungsvariablen oder einer .env-Datei in Ihrem Projekt definiert sind.


list

Listet alle authentifizierten Anbieter auf, wie sie in der Anmeldedatei gespeichert sind.

opencode auth list

Oder die Kurzversion.

opencode auth ls

logout

Meldet Sie von einem Anbieter ab, indem er aus der Anmeldedatei entfernt wird.

opencode auth logout

github

Den GitHub-Agenten für Repository-Automatisierung verwalten.

opencode github [command]

install

Den GitHub-Agenten in Ihrem Repository installieren.

opencode github install

Dies richtet den erforderlichen GitHub Actions Workflow ein und führt Sie durch den Konfigurationsprozess. Mehr erfahren.


run

Den GitHub-Agenten ausführen. Dies wird typischerweise in GitHub Actions verwendet.

opencode github run
Flags
FlagBeschreibung
--eventGitHub Mock-Event, für das der Agent ausgeführt werden soll
--tokenGitHub Personal Access Token

mcp

Model Context Protocol Server verwalten.

opencode mcp [command]

add

Einen MCP-Server zu Ihrer Konfiguration hinzufügen.

opencode mcp add

Dieser Befehl führt Sie durch das Hinzufügen eines lokalen oder entfernten MCP-Servers.


list

Alle konfigurierten MCP-Server und ihren Verbindungsstatus auflisten.

opencode mcp list

Oder die Kurzversion.

opencode mcp ls

auth

Sich bei einem OAuth-fähigen MCP-Server authentifizieren.

opencode mcp auth [name]

Wenn Sie keinen Servernamen angeben, werden Sie aufgefordert, aus verfügbaren OAuth-fähigen Servern auszuwählen.

Sie können auch OAuth-fähige Server und ihren Authentifizierungsstatus auflisten.

opencode mcp auth list

Oder die Kurzversion.

opencode mcp auth ls

logout

OAuth-Anmeldedaten für einen MCP-Server entfernen.

opencode mcp logout [name]

debug

OAuth-Verbindungsprobleme für einen MCP-Server debuggen.

opencode mcp debug <name>

models

Alle verfügbaren Modelle der konfigurierten Anbieter auflisten.

opencode models [provider]

Dieser Befehl zeigt alle verfügbaren Modelle Ihrer konfigurierten Anbieter im Format provider/model an.

Dies ist nützlich, um den genauen Modellnamen für Ihre Konfiguration herauszufinden.

Sie können optional eine Anbieter-ID übergeben, um Modelle nach diesem Anbieter zu filtern.

opencode models anthropic

Flags

FlagBeschreibung
--refreshModell-Cache von models.dev aktualisieren
--verboseAusführlichere Modellausgabe verwenden (enthält Metadaten wie Kosten)

Verwenden Sie das --refresh-Flag, um die zwischengespeicherte Modellliste zu aktualisieren. Dies ist nützlich, wenn neue Modelle zu einem Anbieter hinzugefügt wurden und Sie diese in OpenCode sehen möchten.

opencode models --refresh

run

OpenCode im nicht-interaktiven Modus ausführen, indem Sie einen Prompt direkt übergeben.

opencode run [message..]

Dies ist nützlich für Skripting, Automatisierung oder wenn Sie eine schnelle Antwort ohne das vollständige TUI möchten. Zum Beispiel.

opencode run "Explain the use of context in Go"

Sie können sich auch an eine laufende opencode serve-Instanz anhängen, um MCP-Server-Kaltstartzeiten bei jedem Aufruf zu vermeiden:

# Headless-Server in einem Terminal starten
opencode serve
 
# In einem anderen Terminal Befehle ausführen, die sich daran anhängen
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"

Flags

FlagKurzBeschreibung
--commandDer auszuführende Befehl, Nachricht für Argumente verwenden
--continue-cLetzte Sitzung fortsetzen
--session-sSitzungs-ID zum Fortsetzen
--forkSitzung beim Fortsetzen forken (mit --continue oder --session verwenden)
--shareSitzung teilen
--model-mZu verwendendes Modell im Format provider/model
--agentZu verwendender Agent
--file-fDatei(en) an die Nachricht anhängen
--formatFormat: default (formatiert) oder json (rohe JSON-Events)
--titleTitel für die Sitzung (verwendet gekürzten Prompt, wenn kein Wert angegeben)
--attachAn einen laufenden opencode-Server anhängen (z.B. http://localhost:4096 (opens in a new tab))
--portPort für den lokalen Server (Standard: zufälliger Port)

serve

Einen Headless OpenCode-Server für API-Zugriff starten. Schauen Sie sich die Server-Dokumentation für die vollständige HTTP-Schnittstelle an.

opencode serve

Dies startet einen HTTP-Server, der API-Zugriff auf OpenCode-Funktionalität ohne die TUI-Oberfläche bietet. Setzen Sie OPENCODE_SERVER_PASSWORD, um HTTP Basic Auth zu aktivieren (Benutzername ist standardmäßig opencode).

Flags

FlagBeschreibung
--portPort zum Lauschen
--hostnameHostname zum Lauschen
--mdnsmDNS-Erkennung aktivieren
--corsZusätzliche Browser-Origin(s) für CORS erlauben

session

OpenCode-Sitzungen verwalten.

opencode session [command]

list

Alle OpenCode-Sitzungen auflisten.

opencode session list
Flags
FlagKurzBeschreibung
--max-count-nAuf die N neuesten Sitzungen begrenzen
--formatAusgabeformat: table oder json (table)

stats

Token-Nutzung und Kostenstatistiken für Ihre OpenCode-Sitzungen anzeigen.

opencode stats

Flags

FlagBeschreibung
--daysStatistiken der letzten N Tage anzeigen (alle Zeiten)
--toolsAnzahl der anzuzeigenden Tools (alle)
--modelsModellnutzungs-Aufschlüsselung anzeigen (standardmäßig ausgeblendet). Zahl übergeben, um Top N anzuzeigen
--projectNach Projekt filtern (alle Projekte, leerer String: aktuelles Projekt)

export

Sitzungsdaten als JSON exportieren.

opencode export [sessionID]

Wenn Sie keine Sitzungs-ID angeben, werden Sie aufgefordert, aus verfügbaren Sitzungen auszuwählen.


import

Sitzungsdaten aus einer JSON-Datei oder OpenCode-Share-URL importieren.

opencode import <file>

Sie können aus einer lokalen Datei oder einer OpenCode-Share-URL importieren.

opencode import session.json
opencode import https://opncd.ai/s/abc123

web

Einen Headless OpenCode-Server mit Web-Oberfläche starten.

opencode web

Dies startet einen HTTP-Server und öffnet einen Webbrowser, um über eine Web-Oberfläche auf OpenCode zuzugreifen. Setzen Sie OPENCODE_SERVER_PASSWORD, um HTTP Basic Auth zu aktivieren (Benutzername ist standardmäßig opencode).

Flags

FlagBeschreibung
--portPort zum Lauschen
--hostnameHostname zum Lauschen
--mdnsmDNS-Erkennung aktivieren
--corsZusätzliche Browser-Origin(s) für CORS erlauben

acp

Einen ACP (Agent Client Protocol) Server starten.

opencode acp

Dieser Befehl startet einen ACP-Server, der über stdin/stdout mittels nd-JSON kommuniziert.

Flags

FlagBeschreibung
--cwdArbeitsverzeichnis
--portPort zum Lauschen
--hostnameHostname zum Lauschen

uninstall

OpenCode deinstallieren und alle zugehörigen Dateien entfernen.

opencode uninstall

Flags

FlagKurzBeschreibung
--keep-config-cKonfigurationsdateien behalten
--keep-data-dSitzungsdaten und Snapshots behalten
--dry-runAnzeigen, was entfernt würde, ohne zu entfernen
--force-fBestätigungsaufforderungen überspringen

upgrade

OpenCode auf die neueste Version oder eine bestimmte Version aktualisieren.

opencode upgrade [target]

Auf die neueste Version aktualisieren.

opencode upgrade

Auf eine bestimmte Version aktualisieren.

opencode upgrade v0.1.48

Flags

FlagKurzBeschreibung
--method-mDie verwendete Installationsmethode; curl, npm, pnpm, bun, brew

Globale Flags

Das opencode CLI akzeptiert die folgenden globalen Flags.

FlagKurzBeschreibung
--help-hHilfe anzeigen
--version-vVersionsnummer ausgeben
--print-logsLogs auf stderr ausgeben
--log-levelLog-Level (DEBUG, INFO, WARN, ERROR)

Umgebungsvariablen

OpenCode kann über Umgebungsvariablen konfiguriert werden.

VariableTypBeschreibung
OPENCODE_AUTO_SHAREbooleanSitzungen automatisch teilen
OPENCODE_GIT_BASH_PATHstringPfad zur Git Bash-Ausführungsdatei unter Windows
OPENCODE_CONFIGstringPfad zur Konfigurationsdatei
OPENCODE_CONFIG_DIRstringPfad zum Konfigurationsverzeichnis
OPENCODE_CONFIG_CONTENTstringInline-JSON-Konfigurationsinhalt
OPENCODE_DISABLE_AUTOUPDATEbooleanAutomatische Update-Prüfungen deaktivieren
OPENCODE_DISABLE_PRUNEbooleanBereinigung alter Daten deaktivieren
OPENCODE_DISABLE_TERMINAL_TITLEbooleanAutomatische Terminal-Titel-Updates deaktivieren
OPENCODE_PERMISSIONstringInline-JSON-Berechtigungskonfiguration
OPENCODE_DISABLE_DEFAULT_PLUGINSbooleanStandard-Plugins deaktivieren
OPENCODE_DISABLE_LSP_DOWNLOADbooleanAutomatische LSP-Server-Downloads deaktivieren
OPENCODE_ENABLE_EXPERIMENTAL_MODELSbooleanExperimentelle Modelle aktivieren
OPENCODE_DISABLE_AUTOCOMPACTbooleanAutomatische Kontext-Kompaktierung deaktivieren
OPENCODE_DISABLE_CLAUDE_CODEbooleanLesen von .claude (Prompt + Skills) deaktivieren
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTbooleanLesen von ~/.claude/CLAUDE.md deaktivieren
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSbooleanLaden von .claude/skills deaktivieren
OPENCODE_DISABLE_MODELS_FETCHbooleanAbrufen von Modellen aus Remote-Quellen deaktivieren
OPENCODE_FAKE_VCSstringFake-VCS-Anbieter für Testzwecke
OPENCODE_DISABLE_FILETIME_CHECKbooleanDateizeitprüfung zur Optimierung deaktivieren
OPENCODE_CLIENTstringClient-Kennung (Standard: cli)
OPENCODE_ENABLE_EXAbooleanExa-Websuche-Tools aktivieren
OPENCODE_SERVER_PASSWORDstringBasic Auth für serve/web aktivieren
OPENCODE_SERVER_USERNAMEstringBasic Auth Benutzername überschreiben (Standard opencode)
OPENCODE_MODELS_URLstringBenutzerdefinierte URL zum Abrufen der Modellkonfiguration

Experimentell

Diese Umgebungsvariablen aktivieren experimentelle Funktionen, die sich ändern oder entfernt werden können.

VariableTypBeschreibung
OPENCODE_EXPERIMENTALbooleanAlle experimentellen Funktionen aktivieren
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooleanIcon-Erkennung aktivieren
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanKopieren bei Auswahl im TUI deaktivieren
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnumberStandard-Timeout für Bash-Befehle in ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnumberMaximale Ausgabe-Token für LLM-Antworten
OPENCODE_EXPERIMENTAL_FILEWATCHERbooleanDatei-Watcher für gesamtes Verzeichnis aktivieren
OPENCODE_EXPERIMENTAL_OXFMTbooleanoxfmt-Formatierer aktivieren
OPENCODE_EXPERIMENTAL_LSP_TOOLbooleanExperimentelles LSP-Tool aktivieren
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanDatei-Watcher deaktivieren
OPENCODE_EXPERIMENTAL_EXAbooleanExperimentelle Exa-Funktionen aktivieren
OPENCODE_EXPERIMENTAL_LSP_TYbooleanExperimentelle LSP-Typprüfung aktivieren
OPENCODE_EXPERIMENTAL_MARKDOWNbooleanExperimentelle Markdown-Funktionen aktivieren
OPENCODE_EXPERIMENTAL_PLAN_MODEbooleanPlan-Modus aktivieren