> ## Documentation Index > Fetch the complete documentation index at: https://docs.olostep.com/llms.txt > Use this file to discover all available pages before exploring further. # Verwendung des Olostep CLI > Befehlsstruktur, Ausgabe, JSON, globale Flags, Umgebungsvariablen und Exit-Codes. ## Befehlsstruktur ```bash theme={null} olostep [arguments] [flags] ``` Befehle sind nach dem gruppiert, woran sie arbeiten, zum Beispiel `olostep keys list` oder `olostep monitors pause `. Die Haupt-Web-Daten-Befehle haben eine Kurzform, die ihren Erstellungsbefehl ausführt: | Kurzform | Führt aus | | - | - | | `olostep scrape ` | `olostep scrape create ` | | `olostep search ""` | `olostep search create ""` | | `olostep map ` | `olostep map create ` | | `olostep crawl ` | `olostep crawl create ` | | `olostep answer ""` | `olostep answer create ""` | | `olostep extract ` | `olostep extract run ` | `olostep whoami` ist dasselbe wie `olostep account info`. ## Hilfe erhalten ```bash theme={null} olostep --help # jede Befehlsgruppe olostep monitors --help # die Befehle in einer Gruppe olostep monitors create --help # Argumente und Flags eines Befehls olostep help export logs # Befehle nach ihrer Funktion finden ``` `olostep help ` listet die Befehle auf, deren Name oder Beschreibung jedes Wort enthält. Hilfe funktioniert ohne Anmeldung. ## Ausgabe Das CLI wählt seine Ausgabe basierend auf dem Zielort: | Wohin die Ausgabe geht | Was du bekommst | | - | - | | Ein Terminal | Formatiertes Markdown: Überschriften, Tabellen und Farben. Rot wird nur für Fehler verwendet. | | Eine Pipe oder eine Datei, oder `NO_COLOR` ist gesetzt | Dasselbe Markdown als Klartext, ohne Farben. | | Jedes Ziel, mit `--json` | Exaktes JSON, für Skripte und Agenten. | Fehler gehen an stderr, sodass das Piping von stdout sie nie in deine Daten mischt. Farben sind auch aus, wenn `FORCE_COLOR=0` oder `TERM=dumb` gesetzt ist: ```bash theme={null} NO_COLOR=1 olostep credits balance ``` ### JSON Füge `--json` zu jedem Befehl hinzu, der es in seiner Hilfe auflistet: ```bash theme={null} olostep scrape https://example.com -f markdown --json ``` Befehle, die Olostep aufrufen, geben ein JSON-Objekt zurück: ```json theme={null} { "operation": "", "mode": "executed", "data": {}, "warnings": [] } ``` | Feld | Beschreibung | | - | - | | `operation` | Die ausgeführte Operation. | | `mode` | Eines von `read`, `executed`, `dry_run`, `browser` oder `unavailable`. | | `data` | Das Ergebnis. Seine Struktur hängt vom Befehl ab. | | `warnings` | Alles, was du über das Ergebnis wissen solltest, wie z.B. unvollständige Daten. Leer, wenn nichts vorhanden ist. | Analysiere das JSON, nicht die menschenlesbare Ausgabe. Die menschliche Ausgabe kann sich zwischen Versionen ändern. ### Felder auswählen `--fields` behält nur die Felder, die du benennst. Trenne Felder mit Kommas und erreiche verschachtelte Felder mit einem Punkt. Jedes gewählte Feld wird unter dem angegebenen Pfad ausgegeben: ```bash theme={null} olostep whoami --json --fields mode,warnings ``` ```json theme={null} {"mode":"read","warnings":[]} ``` Um verschachtelte Felder auszuwählen, sieh dir einmal die vollständige `--json` Ausgabe an und benenne sie dann als `data.`. `--fields` funktioniert auch ohne `--json` und zeigt nur diese Felder in der Tabelle. ### In jq pipen ```bash theme={null} olostep credits balance --json | jq '.data' olostep crawl pages --json | jq '.data' ``` ## Werte übergeben | Art des Flags | Wie man es übergibt | Beispiel | | - | - | - | | Text oder Zahl | Nach dem Flag | `--country US`, `--max-pages 50` | | Wiederholbare Liste | Wiederhole das Flag oder trenne mit Kommas | `-f markdown -f html` oder `-f markdown,html` | | JSON | Inline JSON oder `@` und ein Dateipfad | `--metadata '{"project":"q3"}'` oder `--items @urls.json` | | Boolean | Nur das Flag | `--include-subdomain` | | Feste Auswahl | Einer der in der Hilfe gezeigten Werte | `--days 7`, `--format csv` | Positions-URLs und -Abfragen können auch als Flags übergeben werden, zum Beispiel `olostep scrape create --url-to-scrape https://example.com` oder `olostep search create --query "olostep"`. ## Befehle, die Dinge ändern Befehle, die etwas erstellen, ändern oder löschen oder Credits verwenden, geben dies in ihrer Hilfe an. Sie unterstützen: | Flag | Was es tut | | - | - | | `--dry-run` | Zeigt den Aufruf, den das CLI machen würde, und sendet nichts. | | `--preview` | Fordert Olostep auf, die Änderung vorzuschauen, ohne sie durchzuführen. | | `--yes` | Überspringt die Bestätigung. Befehle, die löschen oder überschreiben könnten, benötigen `--yes`, wenn kein Terminal zur Bestätigung vorhanden ist. Ohne es beenden sie mit Code `4`. | ```bash theme={null} olostep monitors delete --dry-run olostep monitors delete --yes ``` Befehle, die Credits verwenden, wie `scrape`, `search`, `map`, `crawl`, `answer`, `extract`, `batch create`, `monitors create`, `monitors run` und `agents run`, sagen `This consumes credits` oder `consumes credits` in ihrer Hilfe. ## Globale Flags Diese Flags funktionieren bei jedem Befehl: | Flag | Beschreibung | | - | - | | `-h`, `--help` | Druckt die Hilfe für den Befehl und beendet. | | `--server ` | Der Olostep CLI-Server, der verwendet werden soll. Standardmäßig `https://cli.olostep.com/mcp`. | | `--token ` | Verwende dieses Token anstelle der gespeicherten Anmeldung. Siehe [Authentifizierung](https://docs.olostep.com/cli/authentication.md#scripts-ci-and-agents). | | `--refresh-tools` | Ruft die aktuelle Liste der Befehle und ihrer Eingaben vom Server ab, anstatt die zwischengespeicherte Kopie zu verwenden. | Diese Flags funktionieren bei jedem Befehl, der sie in seiner Hilfe zeigt: | Flag | Beschreibung | | - | - | | `--json` | Druckt JSON: für Skripte und Agenten. | | `--fields ` | Nur diese Felder, kommagetrennt (`a.b` für verschachtelte). | | `--dry-run` | Zeigt den Aufruf, den es machen würde, und sendet nichts. | | `--preview` | Vorschau ohne Änderungen. | | `--yes` | Nicht zuerst fragen (erforderlich ohne Terminal). | ## Umgebungsvariablen | Variable | Beschreibung | | - | - | | `OLOSTEP_TOKEN` | Ein Token, das anstelle der gespeicherten Anmeldung verwendet wird. Dasselbe wie `--token`. | | `OLOSTEP_SERVER` | Die Server-URL. Dasselbe wie `--server`. | | `OLOSTEP_HOME` | Wo das Installationsskript das CLI ablegt. Standardmäßig `~/.olostep`. Muss ein absoluter Pfad sein. | | `NO_COLOR` | Jeder Wert schaltet Farben aus. | | `XDG_CONFIG_HOME` | Das CLI speichert seine Anmeldung in `$XDG_CONFIG_HOME/olostep`. Standardmäßig `~/.config/olostep`. | | `CI` | Schaltet die Update-Benachrichtigung aus. | ## Exit-Codes | Code | Bedeutung | | - | - | | `0` | Fertig. | | `1` | Der Befehl ist fehlgeschlagen. Die Nachricht steht in stderr. | | `2` | Falscher Befehl oder Argumente. | | `3` | Anmeldung erforderlich. Führe `olostep login` aus oder setze `OLOSTEP_TOKEN`. | | `4` | Der Befehl benötigt `--yes`. | | `5` | Der Server konnte nicht erreicht werden. | This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.