docs: CLI docs for current commands and flags (#25399)

This commit is contained in:
OpeOginni 2026-05-02 18:07:22 +02:00 committed by GitHub
commit 0d0ec7dc46
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 1676 additions and 1413 deletions

View file

@ -29,16 +29,16 @@ opencode [project]
#### Optionen
| Flag | Kurz | Beschreibung |
| ------------ | ---- | ---------------------------------------------------------------------- |
| `--continue` | `-c` | Setzen Sie die letzte Sitzung fort |
| `--session` | `-s` | Session-ID zum Fortfahren |
| `--fork` | | Sitzung beim Fortsetzen verzweigen (mit `--continue` oder `--session`) |
| `--prompt` | | Prompt zur Verwendung |
| `--model` | `-m` | Zu verwendendes Modell in der Form provider/model |
| `--agent` | | Zu verwendender Agent |
| `--port` | | Port zum Abhören |
| `--hostname` | | Hostname zum Abhören |
| Flag | Kurz | Beschreibung |
| ---------------------------------------- | ---- | ---------------------------------------------------------------------- |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Setzen Sie die letzte Sitzung fort |
| <nobr><code>{"--session"}</code></nobr> | `-s` | Session-ID zum Fortfahren |
| <nobr><code>{"--fork"}</code></nobr> | | Sitzung beim Fortsetzen verzweigen (mit `--continue` oder `--session`) |
| <nobr><code>{"--prompt"}</code></nobr> | | Prompt zur Verwendung |
| <nobr><code>{"--model"}</code></nobr> | `-m` | Zu verwendendes Modell in der Form provider/model |
| <nobr><code>{"--agent"}</code></nobr> | | Zu verwendender Agent |
| <nobr><code>{"--port"}</code></nobr> | | Port zum Abhören |
| <nobr><code>{"--hostname"}</code></nobr> | | Hostname zum Abhören |
---
@ -78,10 +78,14 @@ opencode attach http://10.20.30.40:4096
#### Optionen
| Flag | Kurz | Beschreibung |
| ----------- | ---- | ----------------------------------------- |
| `--dir` | | Arbeitsverzeichnis zum Starten von TUI in |
| `--session` | `-s` | Session-ID zum Fortfahren |
| Flag | Kurz | Beschreibung |
| ---------------------------------------- | ---- | ---------------------------------------------------------------------------------- |
| <nobr><code>{"--dir"}</code></nobr> | | Arbeitsverzeichnis zum Starten von TUI in |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Letzte Sitzung fortsetzen |
| <nobr><code>{"--session"}</code></nobr> | `-s` | Session-ID zum Fortfahren |
| <nobr><code>{"--fork"}</code></nobr> | | Sitzung beim Fortsetzen abzweigen (mit `--continue` oder `--session` verwenden) |
| <nobr><code>{"--password"}</code></nobr> | `-p` | Basic-Auth-Passwort (standardmäßig `OPENCODE_SERVER_PASSWORD`) |
| <nobr><code>{"--username"}</code></nobr> | `-u` | Basic-Auth-Benutzername (standardmäßig `OPENCODE_SERVER_USERNAME` oder `opencode`) |
---
@ -187,10 +191,10 @@ opencode github run
##### Optionen
| Flag | Beschreibung |
| --------- | --------------------------------------------------- |
| `--event` | GitHub Scheinereignis zum Ausführen des Agenten für |
| `--token` | GitHub persönliches Zugriffstoken |
| Flag | Beschreibung |
| ------------------------------------- | --------------------------------------------------- |
| <nobr><code>{"--event"}</code></nobr> | GitHub Scheinereignis zum Ausführen des Agenten für |
| <nobr><code>{"--token"}</code></nobr> | GitHub persönliches Zugriffstoken |
---
@ -296,10 +300,10 @@ opencode models anthropic
#### Optionen
| Flag | Beschreibung |
| ----------- | ------------------------------------------------------------------------------------- |
| `--refresh` | Aktualisieren Sie den Modellcache von models.dev |
| `--verbose` | Verwenden Sie eine ausführlichere Modellausgabe (einschließlich Metadaten wie Kosten) |
| Flag | Beschreibung |
| --------------------------------------- | ------------------------------------------------------------------------------------- |
| <nobr><code>{"--refresh"}</code></nobr> | Aktualisieren Sie den Modellcache von models.dev |
| <nobr><code>{"--verbose"}</code></nobr> | Verwenden 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 OpenCode sehen möchten.
@ -335,20 +339,25 @@ opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"
#### Optionen
| Flag | Kurz | Beschreibung |
| ------------ | ---- | --------------------------------------------------------------------------------------------------- |
| `--command` | | Der auszuführende Befehl, Argumente als Nachricht verwenden |
| `--continue` | `-c` | Setzen Sie die letzte Sitzung fort |
| `--session` | `-s` | Session-ID zum Fortfahren |
| `--fork` | | Sitzung beim Fortsetzen verzweigen (mit `--continue` oder `--session` verwenden) |
| `--share` | | Teilen Sie die Sitzung |
| `--model` | `-m` | Zu verwendendes Modell in der Form provider/model |
| `--agent` | | Zu verwendender Agent |
| `--file` | `-f` | Datei(en) zum Anhängen an die Nachricht |
| `--format` | | Format: default (formatiert) oder json (rohe JSON-Ereignisse) |
| `--title` | | Titel für die Sitzung (verwendet eine verkürzte Eingabeaufforderung, wenn kein Wert angegeben wird) |
| `--attach` | | An einen laufenden OpenCode-Server anschließen (z.B. http://localhost:4096) |
| `--port` | | Port für den lokalen Server (standardmäßig zufälliger Port) |
| Flag | Kurz | Beschreibung |
| ---------------------------------------- | ---- | --------------------------------------------------------------------------------------------------- |
| <nobr><code>{"--command"}</code></nobr> | | Der auszuführende Befehl, Argumente als Nachricht verwenden |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Setzen Sie die letzte Sitzung fort |
| <nobr><code>{"--session"}</code></nobr> | `-s` | Session-ID zum Fortfahren |
| <nobr><code>{"--fork"}</code></nobr> | | Sitzung beim Fortsetzen verzweigen (mit `--continue` oder `--session` verwenden) |
| <nobr><code>{"--share"}</code></nobr> | | Teilen Sie die Sitzung |
| <nobr><code>{"--model"}</code></nobr> | `-m` | Zu verwendendes Modell in der Form provider/model |
| <nobr><code>{"--agent"}</code></nobr> | | Zu verwendender Agent |
| <nobr><code>{"--file"}</code></nobr> | `-f` | Datei(en) zum Anhängen an die Nachricht |
| <nobr><code>{"--format"}</code></nobr> | | Format: default (formatiert) oder json (rohe JSON-Ereignisse) |
| <nobr><code>{"--title"}</code></nobr> | | Titel für die Sitzung (verwendet eine verkürzte Eingabeaufforderung, wenn kein Wert angegeben wird) |
| <nobr><code>{"--attach"}</code></nobr> | | An einen laufenden OpenCode-Server anschließen (z.B. http://localhost:4096) |
| <nobr><code>{"--password"}</code></nobr> | `-p` | Basic-Auth-Passwort (standardmäßig `OPENCODE_SERVER_PASSWORD`) |
| <nobr><code>{"--username"}</code></nobr> | `-u` | Basic-Auth-Benutzername (standardmäßig `OPENCODE_SERVER_USERNAME` oder `opencode`) |
| <nobr><code>{"--dir"}</code></nobr> | | Verzeichnis für die Ausführung, oder Pfad auf dem Remote-Server beim Anhängen |
| <nobr><code>{"--variant"}</code></nobr> | | Modellvariante (anbieterspezifischer Reasoning-Aufwand) |
| <nobr><code>{"--thinking"}</code></nobr> | | Denkblöcke anzeigen |
| <nobr><code>{"--port"}</code></nobr> | | Port für den lokalen Server (standardmäßig zufälliger Port) |
---
@ -364,12 +373,12 @@ Dadurch wird ein HTTP-Server gestartet, der API-Zugriff auf OpenCode-Funktionali
#### Optionen
| Flag | Beschreibung |
| ------------ | ----------------------------------------------- |
| `--port` | Port zum Abhören |
| `--hostname` | Hostname zum Abhören |
| `--mdns` | mDNS-Discovery aktivieren |
| `--cors` | Zusätzliche Browser-Ursprünge für CORS zulassen |
| Flag | Beschreibung |
| ---------------------------------------- | ----------------------------------------------- |
| <nobr><code>{"--port"}</code></nobr> | Port zum Abhören |
| <nobr><code>{"--hostname"}</code></nobr> | Hostname zum Abhören |
| <nobr><code>{"--mdns"}</code></nobr> | mDNS-Discovery aktivieren |
| <nobr><code>{"--cors"}</code></nobr> | Zusätzliche Browser-Ursprünge für CORS zulassen |
---
@ -393,10 +402,10 @@ opencode session list
##### Optionen
| Flag | Kurz | Beschreibung |
| ------------- | ---- | ---------------------------------------- |
| `--max-count` | `-n` | Beschränken auf die N neuesten Sitzungen |
| `--format` | | Ausgabeformat: table oder json (table) |
| Flag | Kurz | Beschreibung |
| ----------------------------------------- | ---- | ---------------------------------------- |
| <nobr><code>{"--max-count"}</code></nobr> | `-n` | Beschränken auf die N neuesten Sitzungen |
| <nobr><code>{"--format"}</code></nobr> | | Ausgabeformat: table oder json (table) |
---
@ -410,12 +419,12 @@ opencode stats
#### Optionen
| Flag | Beschreibung |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `--days` | Statistiken für die letzten N Tage anzeigen (alle Zeiten) |
| `--tools` | Anzahl der angebotenen Werkzeuge (alle) |
| `--models` | Aufschlüsselung der Modellnutzung anzeigen (standardmäßig ausgeblendet). Übergeben Sie eine Zahl, um die obersten N anzuzeigen |
| `--project` | Nach Projekt filtern (alle Projekte, leere Zeichenfolge: aktuelles Projekt) |
| Flag | Beschreibung |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| <nobr><code>{"--days"}</code></nobr> | Statistiken für die letzten N Tage anzeigen (alle Zeiten) |
| <nobr><code>{"--tools"}</code></nobr> | Anzahl der angebotenen Werkzeuge (alle) |
| <nobr><code>{"--models"}</code></nobr> | Aufschlüsselung der Modellnutzung anzeigen (standardmäßig ausgeblendet). Übergeben Sie eine Zahl, um die obersten N anzuzeigen |
| <nobr><code>{"--project"}</code></nobr> | Nach Projekt filtern (alle Projekte, leere Zeichenfolge: aktuelles Projekt) |
---
@ -460,12 +469,12 @@ Dadurch wird ein HTTP-Server gestartet und ein Webbrowser geöffnet, um über ei
#### Optionen
| Flag | Beschreibung |
| ------------ | ----------------------------------------------- |
| `--port` | Port zum Abhören |
| `--hostname` | Hostname zum Abhören |
| `--mdns` | mDNS-Discovery aktivieren |
| `--cors` | Zusätzliche Browser-Ursprünge für CORS zulassen |
| Flag | Beschreibung |
| ---------------------------------------- | ----------------------------------------------- |
| <nobr><code>{"--port"}</code></nobr> | Port zum Abhören |
| <nobr><code>{"--hostname"}</code></nobr> | Hostname zum Abhören |
| <nobr><code>{"--mdns"}</code></nobr> | mDNS-Discovery aktivieren |
| <nobr><code>{"--cors"}</code></nobr> | Zusätzliche Browser-Ursprünge für CORS zulassen |
---
@ -481,11 +490,11 @@ Dieser Befehl startet einen ACP-Server, der über stdin/stdout unter Verwendung
#### Optionen
| Flag | Beschreibung |
| ------------ | -------------------- |
| `--cwd` | Arbeitsverzeichnis |
| `--port` | Port zum Abhören |
| `--hostname` | Hostname zum Abhören |
| Flag | Beschreibung |
| ---------------------------------------- | -------------------- |
| <nobr><code>{"--cwd"}</code></nobr> | Arbeitsverzeichnis |
| <nobr><code>{"--port"}</code></nobr> | Port zum Abhören |
| <nobr><code>{"--hostname"}</code></nobr> | Hostname zum Abhören |
---
@ -499,12 +508,12 @@ opencode uninstall
#### Optionen
| Flag | Kurz | Beschreibung |
| --------------- | ---- | --------------------------------------------------- |
| `--keep-config` | `-c` | Konfigurationsdateien behalten |
| `--keep-data` | `-d` | Sitzungsdaten und Snapshots aufbewahren |
| `--dry-run` | | Zeigt, was entfernt werden würde, ohne zu entfernen |
| `--force` | `-f` | Bestätigungsaufforderungen überspringen |
| Flag | Kurz | Beschreibung |
| ------------------------------------------- | ---- | --------------------------------------------------- |
| <nobr><code>{"--keep-config"}</code></nobr> | `-c` | Konfigurationsdateien behalten |
| <nobr><code>{"--keep-data"}</code></nobr> | `-d` | Sitzungsdaten und Snapshots aufbewahren |
| <nobr><code>{"--dry-run"}</code></nobr> | | Zeigt, was entfernt werden würde, ohne zu entfernen |
| <nobr><code>{"--force"}</code></nobr> | `-f` | Bestätigungsaufforderungen überspringen |
---
@ -530,9 +539,9 @@ opencode upgrade v0.1.48
#### Optionen
| Flag | Kurz | Beschreibung |
| ---------- | ---- | ------------------------------------------------------------------- |
| `--method` | `-m` | Die zu verwendende Installationsmethode; curl, npm, pnpm, bun, brew |
| Flag | Kurz | Beschreibung |
| -------------------------------------- | ---- | ------------------------------------------------------------------- |
| <nobr><code>{"--method"}</code></nobr> | `-m` | Die zu verwendende Installationsmethode; curl, npm, pnpm, bun, brew |
---
@ -540,12 +549,12 @@ opencode upgrade v0.1.48
Der OpenCode CLI akzeptiert die folgenden globalen Flags.
| Flag | Kurz | Beschreibung |
| -------------- | ---- | ----------------------------------------- |
| `--help` | `-h` | Hilfe anzeigen |
| `--version` | `-v` | Versionsnummer drucken |
| `--print-logs` | | Protokolle nach stderr drucken |
| `--log-level` | | Protokollebene (DEBUG, INFO, WARN, ERROR) |
| Flag | Kurz | Beschreibung |
| ------------------------------------------ | ---- | ----------------------------------------- |
| <nobr><code>{"--help"}</code></nobr> | `-h` | Hilfe anzeigen |
| <nobr><code>{"--version"}</code></nobr> | `-v` | Versionsnummer drucken |
| <nobr><code>{"--print-logs"}</code></nobr> | | Protokolle nach stderr drucken |
| <nobr><code>{"--log-level"}</code></nobr> | | Protokollebene (DEBUG, INFO, WARN, ERROR) |
---