Zum Inhalt springen

CLI

Der CodeTutor CLI startet standardmäßig das TUI, wenn er ohne Argumente ausgeführt wird.

Terminal-Fenster
opencode

Es akzeptiert aber auch Befehle, wie auf dieser Seite dokumentiert. Dadurch können Sie programmgesteuert mit CodeTutor interagieren.

Terminal-Fenster
codetutor run "Explain how closures work in JavaScript"

tui

Starten Sie die Terminalbenutzeroberfläche CodeTutor.

Terminal-Fenster
opencode [project]

Optionen

FlagKurzBeschreibung
--continue-cSetzen Sie die letzte Sitzung fort
--session-sSession-ID zum Fortfahren
--forkSitzung beim Fortsetzen verzweigen (mit --continue oder --session)
--promptPrompt zur Verwendung
--model-mZu verwendendes Modell in der Form provider/model
--agentZu verwendender Agent
--portPort zum Abhören
--hostnameHostname zum Abhören

Befehle

Der CodeTutor CLI verfügt außerdem über die folgenden Befehle.


agent

Agenten für CodeTutor verwalten.

Terminal-Fenster
codetutor agent [command]

attach

Schließen Sie ein Terminal an einen bereits laufenden CodeTutor-Backend-Server an, der über die Befehle serve oder web gestartet wurde.

Terminal-Fenster
codetutor attach [url]

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

Terminal-Fenster
# Start the backend server for web/mobile access
codetutor web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
codetutor attach http://10.20.30.40:4096

Optionen

FlagKurzBeschreibung
--dirArbeitsverzeichnis zum Starten von TUI in
--continue-cLetzte Sitzung fortsetzen
--session-sSession-ID zum Fortfahren
--forkSitzung beim Fortsetzen abzweigen (mit --continue oder --session verwenden)
--password-pBasic-Auth-Passwort (standardmäßig CODETUTOR_SERVER_PASSWORD)
--username-uBasic-Auth-Benutzername (standardmäßig CODETUTOR_SERVER_USERNAME oder codetutor)

create

Erstellen Sie einen neuen Agenten mit benutzerdefinierter Konfiguration.

Terminal-Fenster
codetutor agent create

Dieser Befehl führt Sie durch die Erstellung eines neuen Agenten mit einer benutzerdefinierten Systemeingabeaufforderung und Toolkonfiguration.


list

Listen Sie alle verfügbaren Agenten auf.

Terminal-Fenster
codetutor agent list

auth

Befehl zum Verwalten von Anmeldeinformationen und Anmelden für Anbieter.

Terminal-Fenster
codetutor auth [command]

login

CodeTutor wird von der Anbieterliste bei Models.dev unterstützt, sodass Sie codetutor 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.

Terminal-Fenster
codetutor auth login

Wenn CodeTutor 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.


list

Listet alle authentifizierten Anbieter auf, wie in der Anmeldeinformationsdatei gespeichert.

Terminal-Fenster
codetutor auth list

Oder die Kurzversion.

Terminal-Fenster
codetutor auth ls

logout

Melden Sie sich von einem Anbieter ab, indem Sie ihn aus der Anmeldeinformationsdatei löschen.

Terminal-Fenster
codetutor auth logout

github

Verwalten Sie den GitHub-Agenten für die Repository-Automatisierung.

Terminal-Fenster
codetutor github [command]

install

Installieren Sie den GitHub-Agenten in Ihrem Repository.

Terminal-Fenster
codetutor github install

Dadurch wird der erforderliche GitHub-Aktionsworkflow eingerichtet und Sie durch den Konfigurationsprozess geführt. Learn more.


run

Führen Sie den GitHub-Agenten aus. Dies wird normalerweise in GitHub-Aktionen verwendet.

Terminal-Fenster
codetutor github run
Optionen
FlagBeschreibung
--eventGitHub Scheinereignis zum Ausführen des Agenten für
--tokenGitHub persönliches Zugriffstoken

mcp

Verwalten Sie Model Context Protocol-Server.

Terminal-Fenster
codetutor mcp [command]

add

Fügen Sie Ihrer Konfiguration einen MCP-Server hinzu.

Terminal-Fenster
codetutor mcp add

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


list

Listen Sie alle konfigurierten MCP-Server und deren Verbindungsstatus auf.

Terminal-Fenster
codetutor mcp list

Oder nutzen Sie die Kurzversion.

Terminal-Fenster
codetutor mcp ls

auth

Authentifizieren Sie sich mit einem OAuth-fähigen MCP-Server.

Terminal-Fenster
codetutor mcp auth [name]

Wenn Sie keinen Servernamen angeben, werden Sie aufgefordert, einen der verfügbaren OAuth-fähigen Server auszuwählen.

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

Terminal-Fenster
codetutor mcp auth list

Oder nutzen Sie die Kurzversion.

Terminal-Fenster
codetutor mcp auth ls

logout

Entfernen Sie OAuth-Anmeldeinformationen für einen MCP-Server.

Terminal-Fenster
codetutor mcp logout [name]

debug

Beheben Sie OAuth-Verbindungsprobleme für einen MCP-Server.

Terminal-Fenster
codetutor mcp debug <name>

models

Listen Sie alle verfügbaren Modelle der konfigurierten Anbieter auf.

Terminal-Fenster
codetutor models [provider]

Dieser Befehl zeigt alle bei Ihren konfigurierten Anbietern verfügbaren Modelle im Format provider/model an.

Dies ist nützlich, um die genauen Modellnamen herauszufinden, die in Ihrer Konfiguration verwendet werden sollen.

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

Terminal-Fenster
codetutor models anthropic

Optionen

FlagBeschreibung
--refreshAktualisieren Sie den Modellcache von models.dev
--verboseVerwenden Sie eine ausführlichere Modellausgabe (einschließlich Metadaten wie Kosten)

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 CodeTutor sehen möchten.

Terminal-Fenster
codetutor models --refresh

run

Führen Sie CodeTutor im nicht interaktiven Modus aus, indem Sie direkt eine Eingabeaufforderung übergeben.

Terminal-Fenster
codetutor run [message..]

Dies ist nützlich für die Skripterstellung, die Automatisierung oder wenn Sie eine schnelle Antwort wünschen, ohne das vollständige TUI zu starten. Zum Beispiel:

Terminal-Fenster
codetutor run Explain the use of context in Go

Sie können auch eine Verbindung zu einer laufenden codetutor serve-Instanz herstellen, um bei jedem Lauf Kaltstartzeiten für den MCP-Server zu vermeiden:

Terminal-Fenster
# Start a headless server in one terminal
codetutor serve
# In another terminal, run commands that attach to it
codetutor run --attach http://localhost:4096 "Explain async/await in JavaScript"

Optionen

FlagKurzBeschreibung
--commandDer auszuführende Befehl, Argumente als Nachricht verwenden
--continue-cSetzen Sie die letzte Sitzung fort
--session-sSession-ID zum Fortfahren
--forkSitzung beim Fortsetzen verzweigen (mit --continue oder --session verwenden)
--shareTeilen Sie die Sitzung
--model-mZu verwendendes Modell in der Form provider/model
--agentZu verwendender Agent
--file-fDatei(en) zum Anhängen an die Nachricht
--formatFormat: default (formatiert) oder json (rohe JSON-Ereignisse)
--titleTitel für die Sitzung (verwendet eine verkürzte Eingabeaufforderung, wenn kein Wert angegeben wird)
--attachAn einen laufenden CodeTutor-Server anschließen (z.B. http://localhost:4096)
--password-pBasic-Auth-Passwort (standardmäßig CODETUTOR_SERVER_PASSWORD)
--username-uBasic-Auth-Benutzername (standardmäßig CODETUTOR_SERVER_USERNAME oder codetutor)
--dirVerzeichnis für die Ausführung, oder Pfad auf dem Remote-Server beim Anhängen
--variantModellvariante (anbieterspezifischer Reasoning-Aufwand)
--thinkingDenkblöcke anzeigen
--portPort für den lokalen Server (standardmäßig zufälliger Port)

serve

Starten Sie einen Headless-CodeTutor-Server für den API-Zugriff. Sehen Sie sich die Server-Dokumentation für die vollständige HTTP-Schnittstelle an.

Terminal-Fenster
codetutor serve

Dadurch wird ein HTTP-Server gestartet, der API-Zugriff auf CodeTutor-Funktionalität ohne die TUI-Schnittstelle bietet. Legen Sie CODETUTOR_SERVER_PASSWORD fest, um die HTTP-Basisauthentifizierung zu aktivieren (Benutzername ist standardmäßig codetutor).

Optionen

FlagBeschreibung
--portPort zum Abhören
--hostnameHostname zum Abhören
--mdnsmDNS-Discovery aktivieren
--corsZusätzliche Browser-Ursprünge für CORS zulassen

session

CodeTutor-Sitzungen verwalten.

Terminal-Fenster
codetutor session [command]

list

Listen Sie alle CodeTutor-Sitzungen auf.

Terminal-Fenster
codetutor session list
Optionen
FlagKurzBeschreibung
--max-count-nBeschränken auf die N neuesten Sitzungen
--formatAusgabeformat: table oder json (table)

stats

Zeigen Sie Token-Nutzungs- und Kostenstatistiken für Ihre CodeTutor-Sitzungen an.

Terminal-Fenster
codetutor stats

Optionen

FlagBeschreibung
--daysStatistiken für die letzten N Tage anzeigen (alle Zeiten)
--toolsAnzahl der angebotenen Werkzeuge (alle)
--modelsAufschlüsselung der Modellnutzung anzeigen (standardmäßig ausgeblendet). Übergeben Sie eine Zahl, um die obersten N anzuzeigen
--projectNach Projekt filtern (alle Projekte, leere Zeichenfolge: aktuelles Projekt)

export

Sitzungsdaten als JSON exportieren.

Terminal-Fenster
codetutor export [sessionID]

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


import

Importieren Sie Sitzungsdaten aus einer JSON-Datei oder einer CodeTutor-Freigabe-URL.

Terminal-Fenster
codetutor import <file>

Sie können aus einer lokalen Datei oder einer CodeTutor-Freigabe-URL importieren.

Terminal-Fenster
codetutor import session.json
codetutor import https://opncd.ai/s/abc123

web

Starten Sie einen Headless-CodeTutor-Server mit einer Weboberfläche.

Terminal-Fenster
codetutor web

Dadurch wird ein HTTP-Server gestartet und ein Webbrowser geöffnet, um über eine Webschnittstelle auf CodeTutor zuzugreifen. Legen Sie CODETUTOR_SERVER_PASSWORD fest, um die HTTP-Basisauthentifizierung zu aktivieren (Benutzername ist standardmäßig codetutor).

Optionen

FlagBeschreibung
--portPort zum Abhören
--hostnameHostname zum Abhören
--mdnsmDNS-Discovery aktivieren
--corsZusätzliche Browser-Ursprünge für CORS zulassen

acp

Starten Sie einen ACP (Agent Client Protocol) Server.

Terminal-Fenster
codetutor acp

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

Optionen

FlagBeschreibung
--cwdArbeitsverzeichnis
--portPort zum Abhören
--hostnameHostname zum Abhören

uninstall

Deinstallieren Sie CodeTutor und entfernen Sie alle zugehörigen Dateien.

Terminal-Fenster
codetutor uninstall

Optionen

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

upgrade

Aktualisiert CodeTutor auf die neueste Version oder eine bestimmte Version.

Terminal-Fenster
codetutor upgrade [target]

Um auf die neueste Version zu aktualisieren:

Terminal-Fenster
codetutor upgrade

Um auf eine bestimmte Version zu aktualisieren.

Terminal-Fenster
codetutor upgrade v0.1.48

Optionen

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

Globale Flags

Der CodeTutor CLI akzeptiert die folgenden globalen Flags.

FlagKurzBeschreibung
--help-hHilfe anzeigen
--version-vVersionsnummer drucken
--print-logsProtokolle nach stderr drucken
--log-levelProtokollebene (DEBUG, INFO, WARN, ERROR)

Umgebungsvariablen

CodeTutor kann mithilfe von Umgebungsvariablen konfiguriert werden.

VariableTypBeschreibung
CODETUTOR_AUTO_SHAREboolescher WertSitzungen automatisch teilen
CODETUTOR_GIT_BASH_PATHZeichenfolgePfad zur ausführbaren Git Bash-Datei unter Windows
CODETUTOR_CONFIGZeichenfolgePfad zur Konfigurationsdatei
CODETUTOR_CONFIG_DIRZeichenfolgePfad zum Konfigurationsverzeichnis
CODETUTOR_CONFIG_CONTENTZeichenfolgeInline-JSON-Konfigurationsinhalt
CODETUTOR_DISABLE_AUTOUPDATEboolescher WertAutomatische Update-Prüfungen deaktivieren
CODETUTOR_DISABLE_PRUNEboolescher WertBereinigung alter Daten deaktivieren
CODETUTOR_DISABLE_TERMINAL_TITLEboolescher WertDeaktivieren Sie die automatische Aktualisierung von Terminaltiteln
CODETUTOR_PERMISSIONZeichenfolgeInline-JSON-Berechtigungskonfiguration
CODETUTOR_DISABLE_DEFAULT_PLUGINSboolescher WertStandard-Plugins deaktivieren
CODETUTOR_DISABLE_LSP_DOWNLOADboolescher WertAutomatische LSP-Server-Downloads deaktivieren
CODETUTOR_ENABLE_EXPERIMENTAL_MODELSboolescher WertExperimentelle Modelle aktivieren
CODETUTOR_DISABLE_AUTOCOMPACTboolescher WertAutomatische Kontextkomprimierung deaktivieren
CODETUTOR_DISABLE_CLAUDE_CODEboolescher WertDeaktivieren Sie das Lesen von .claude (Prompt + Skills)
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPTboolescher WertDeaktivieren Sie das Lesen von ~/.claude/CLAUDE.md
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLSboolescher WertDeaktivieren Sie das Laden von .claude/skills
CODETUTOR_DISABLE_MODELS_FETCHboolescher WertDeaktivieren Sie das Abrufen von Modellen aus Remote-Quellen
CODETUTOR_FAKE_VCSZeichenfolgeGefälschter VCS-Anbieter zu Testzwecken
CODETUTOR_CLIENTZeichenfolgeClient-ID (standardmäßig cli)
CODETUTOR_ENABLE_EXAboolescher WertExa-Websuchtools aktivieren
CODETUTOR_SERVER_PASSWORDZeichenfolgeAktivieren Sie die Basisauthentifizierung für serve/web
CODETUTOR_SERVER_USERNAMEZeichenfolgeBenutzernamen für die Basisauthentifizierung überschreiben (Standard codetutor)
CODETUTOR_MODELS_URLZeichenfolgeBenutzerdefinierte URL zum Abrufen der Modellkonfiguration

Experimentell

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

VariableTypBeschreibung
CODETUTOR_EXPERIMENTALboolescher WertExperimentelle Funktionen unter dem Sammelflag aktivieren
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERYboolescher WertSymbolerkennung aktivieren
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECTboolescher WertKopieren bei Auswahl in TUI deaktivieren
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSZahlStandard-Timeout für Bash-Befehle in ms
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAXZahlMaximale Ausgabetokens für LLM-Antworten
CODETUTOR_EXPERIMENTAL_FILEWATCHERboolescher WertDateiüberwachung für das gesamte Verzeichnis aktivieren
CODETUTOR_EXPERIMENTAL_OXFMTboolescher WertOxfmt-Formatierer aktivieren
CODETUTOR_EXPERIMENTAL_LSP_TOOLboolescher WertExperimentelles LSP-Tool aktivieren
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHERboolescher WertDateiüberwachung deaktivieren
CODETUTOR_EXPERIMENTAL_EXAboolescher WertExperimentelle Exa-Funktionen aktivieren
CODETUTOR_EXPERIMENTAL_LSP_TYboolescher WertTY LSP für Python-Dateien aktivieren
CODETUTOR_EXPERIMENTAL_PLAN_MODEboolescher WertPlanmodus aktivieren
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTSboolescher WertHintergrundaufgaben für Subagenten aktivieren
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEMboolescher WertExperimentelles Ereignissystem aktivieren
CODETUTOR_EXPERIMENTAL_NATIVE_LLMboolescher WertNativen LLM-Anfragepfad aktivieren
CODETUTOR_EXPERIMENTAL_PARALLELboolescher WertParallele Websuche aktivieren
CODETUTOR_EXPERIMENTAL_SCOUTboolescher WertScout-Subagent aktivieren
CODETUTOR_EXPERIMENTAL_WORKSPACESboolescher WertWorkspace-Unterstützung aktivieren