CLI

OpenCode CLI Optionen und Befehle.

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

opencode

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

opencode run "Explain how closures work in JavaScript"

tui

Startet die OpenCode Terminal-Benutzeroberfläche.

opencode [project]

Flags

Befehle

Das OpenCode CLI hat auch die folgenden Befehle.

agent

Verwaltet Agents für OpenCode.

opencode agent [command]

attach

Verbindet ein Terminal mit einem bereits laufenden OpenCode-Backend-Server, der über serve oder web Befehle gestartet wurde.

opencode attach [url]

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

# 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

Flags

create

Erstellt einen neuen Agent mit benutzerdefinierter Konfiguration.

opencode agent create

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

list

Listet alle verfügbaren Agents auf.

opencode agent list

auth

Befehl zur Verwaltung von Anmeldedaten und Login für Provider.

opencode auth [command]

login

OpenCode wird von der Provider-Liste 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 Provider zu konfigurieren. Dies wird in ~/.local/share/opencode/auth.json gespeichert.

opencode auth login

Beim Start lädt OpenCode die Provider aus der Anmeldedatei. Auch Schlüssel, die in Ihren Umgebungsvariablen oder einer .env-Datei in Ihrem Projekt definiert sind, werden geladen.

list

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

opencode auth list

Oder die Kurzversion.

opencode auth ls

logout

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

opencode auth logout

github

Verwaltet den GitHub-Agent für Repository-Automatisierung.

opencode github [command]

install

Installiert den GitHub-Agent in Ihrem Repository.

opencode github install

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

run

Führt den GitHub-Agent aus. Dies wird typischerweise in GitHub Actions verwendet.

opencode github run

Flags

mcp

Verwaltet Model Context Protocol Server.

opencode mcp [command]

add

Fügt einen MCP-Server zu Ihrer Konfiguration hinzu.

opencode mcp add

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

list

Listet alle konfigurierten MCP-Server und ihren Verbindungsstatus auf.

opencode mcp list

Oder verwenden Sie die Kurzversion.

opencode mcp ls

auth

Authentifiziert sich bei einem OAuth-fähigen MCP-Server.

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 verwenden Sie die Kurzversion.

opencode mcp auth ls

logout

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

opencode mcp logout [name]

debug

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

opencode mcp debug <name>

models

Listet alle verfügbaren Modelle von konfigurierten Providern auf.

opencode models [provider]

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

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

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

opencode models anthropic

Flags

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

opencode models --refresh

run

Führt OpenCode im nicht-interaktiven Modus aus, indem ein Prompt direkt übergeben wird.

opencode run [message..]

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

opencode run "Explain the use of context in Go"

Sie können sich auch mit einer laufenden opencode serve-Instanz verbinden, um MCP-Server-Kaltstartzeiten bei jedem Lauf zu vermeiden:

# 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"

Flags

serve

Startet einen Headless-OpenCode-Server für API-Zugriff. Siehe die Server-Dokumentation für die vollständige HTTP-Schnittstelle.

opencode serve

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

Flags

session

Verwaltet OpenCode-Sitzungen.

opencode session [command]

list

Listet alle OpenCode-Sitzungen auf.

opencode session list

Flags

stats

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

opencode stats

Flags

export

Exportiert Sitzungsdaten als JSON.

opencode export [sessionID]

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

import

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

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

Startet einen Headless-OpenCode-Server mit Web-Oberfläche.

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

acp

Startet einen ACP (Agent Client Protocol) Server.

opencode acp

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

Flags

uninstall

Deinstalliert OpenCode und entfernt alle zugehörigen Dateien.

opencode uninstall

Flags

upgrade

Aktualisiert opencode auf die neueste Version oder eine bestimmte Version.

opencode upgrade [target]

Auf die neueste Version aktualisieren.

opencode upgrade

Auf eine bestimmte Version aktualisieren.

opencode upgrade v0.1.48

Flags

Globale Flags

Das opencode CLI akzeptiert die folgenden globalen Flags.

Umgebungsvariablen

OpenCode kann mit Umgebungsvariablen konfiguriert werden.

Experimentell

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