# Dokumentation im Terminal durchsuchen Verwenden Sie das Dokumentations-Plug-in der Stripe-CLI, um die Stripe-Dokumentation und die API-Dokumentation direkt in Ihrem Terminal zu lesen. Weitere Informationen finden Sie im [Referenzdokument für das Stripe CLI](https://docs.stripe.com/cli.md). Mit dem `stripe docs`-Plug-in müssen Sie keinen Browser öffnen, um die Stripe-Dokumentation und die API-Dokumentation zu lesen. Über die Befehlszeile können Sie auf eine interaktive Terminal-Nutzeroberfläche (TUI) zugreifen, die Ihnen die Navigation durch Leitfäden, einen API-Dokumentations-Browser, einen Webhook-Ereignis-Explorer und eine einheitliche Suche ermöglicht. ## Before you begin - Installieren Sie die [Stripe-CLI](https://docs.stripe.com/stripe-cli/install.md) Version 1.11.3 oder höher - Installieren Sie das Dokumentations-Plug-in: ```bash stripe plugin install docs ``` Falls Sie das Plug-in aktualisieren müssen, führen Sie Folgendes aus: ```bash stripe plugin upgrade docs ``` ## Leitfäden durchsuchen Führen Sie `stripe docs` ohne Argumente aus, um den interaktiven TUI-Startbildschirm zu öffnen. Der Startbildschirm zeigt zuletzt besuchte Seiten und verfügbare Themen, sortiert nach einer Kombination aus Häufigkeit und Aktualität. ```bash stripe docs ``` Um ein bestimmtes Thema direkt zu öffnen, übergeben Sie seinen Namen als Argument: ```bash stripe docs payments stripe docs webhooks stripe docs checkout ``` Das Plug-in verwendet Fuzzy-Matching, sodass auch Teilnamen und Synonyme funktionieren: ```bash stripe docs customer # matches the Customers guide stripe docs refund # matches the Refunds guide ``` ## API-Dokumentation durchsuchen Verwenden Sie den Unterbefehl `api`, um die Stripe-API-Dokumentation zu erkunden: ```bash stripe docs api # browse all resources stripe docs api customers # show a resource stripe docs api customers create # show a specific operation stripe docs api customers#email # deep-link to a specific field ``` ## Dokumentation durchsuchen Verwenden Sie den Unterbefehl `search`, um gleichzeitig Leitfäden und die API-Dokumentation zu durchsuchen: ```bash stripe docs search webhooks stripe docs search "payment methods" stripe docs search refund ``` Lassen Sie die Abfrage weg, um die interaktive Such-TUI zu öffnen, die auch einen Vorschaubereich enthält: ```bash stripe docs search ``` ## Webhook-Ereignisse erkunden Verwenden Sie den Unterbefehl `events`, um Webhook-Ereignistypen und deren Nutzlaststruktur zu erkunden: ```bash stripe docs events # browse all event types stripe docs events charge.succeeded # show payload structure stripe docs events checkout.session.completed # show payload structure ``` ## In Browser öffnen Fügen Sie das Flag `--web` (oder `-w`) zu einem beliebigen Befehl hinzu, um die entsprechende Seite auf docs.stripe.com statt im Terminal zu öffnen: ```bash stripe docs --web payments stripe docs api customers --web stripe docs events charge.succeeded --web ``` ## Mit Tastaturkürzeln navigieren Beim Anzeigen einer Seite in der interaktiven TUI können Sie mit den folgenden Tasten navigieren und mit Inhalten interagieren: | Taste | Aktion | | ---------- | -------------------------------------------------------------------- | | `j` / `k` | Zeilenweise scrollen | | `d` / `u` | Eine halbe Seite nach unten/oben scrollen | | `f` / `b` | Eine ganze Seite nach unten/oben scrollen | | `n` / `N` | Zum nächsten/vorherigen Abschnitt springen | | `gg` / `G` | Zum Anfang/Ende der Seite springen | | `B` | Breadcrumb-Teleport (zu beliebiger Ebene im Ansichts-Stack wechseln) | | `Esc` | Zurück | | `q` | Beenden | | `/` | Einheitliche Suche | | `y` | Fokussierten Code-Block kopieren | | `Tab` | Zwischen Sprach-Tabs wechseln | | `L` | Sprachauswahl öffnen | | `o` | Aktuelle Seite im Browser öffnen | | `R` | Inhalte von docs.stripe.com aktualisieren | | `x` | Fokussierten CLI-Befehl ausführen | | `?` | Alle Tastenbelegungen anzeigen | ## Strukturierte Ausgabeformate verwenden Das Flag `--format` ändert die Art der Ausgabe von Inhalten. Verwenden Sie es für Scripting, das Weiterleiten von Ausgaben oder die Integration mit KI-Coding-Agenten. | Format | Beschreibung | | --------- | ---------------------------------------------------------------------------------------------------- | | `json` | Vollständige maschinenlesbare JSON-Ausgabe | | `compact` | Token-effizienter Klartext, gut für LLM-Kontext | | `toon` | TOON-Format, ca. 40 % weniger Token als JSON | | `tool` | Tool-Definition nach JSON Schema (für MCP und Function Calling). Erfordert `api` plus einen Vorgang. | ```bash stripe docs api customers --format=json stripe docs api customers --format=compact stripe docs api customers create --format=tool stripe docs events charge.succeeded --format=json ``` Verwenden Sie das Flag `--sections`, um die Ausgabe auf bestimmte Abschnitte zu beschränken: ```bash stripe docs api customers --format=json --sections=fields,operations stripe docs api customers create --format=compact --sections=parameters ``` Verwenden Sie `--filter=required`, um nur Pflichtfelder oder -parameter anzuzeigen: ```bash stripe docs api customers create --filter=required ``` ## Inhaltsquelle steuern Das Plug-in stellt Inhalte aus drei Quellen bereit: - **LOCAL**: Im Plug-in enthaltene gebündelte Inhalte (Standard für die meisten Seiten). - **CACHED**: Inhalte, die zuvor von docs.stripe.com abgerufen wurden (24 Stunden lang wiederverwendet). - **LIVE**: Frisch von docs.stripe.com abgerufene Inhalte. Erzwingen Sie einen Live-Abruf mit `--refresh` oder verwenden Sie das Flag `--source`, um die Quelle zu steuern: ```bash stripe docs webhooks --refresh # fetch fresh content stripe docs webhooks --source=live # always fetch latest stripe docs webhooks --source=local # use bundled content only (offline) ``` Drücken Sie im TUI **R**, um die aktuelle Seite zu aktualisieren, und **U**, um eine Aktualisierung rückgängig zu machen. ## Verwendung in nicht-interaktiven Umgebungen Verwenden Sie `--no-pager` oder `-N`, um die Ausgabe direkt nach stdout zu drucken, ohne die TUI oder einen Pager zu starten. Verwenden Sie dies in Scripts, CI-Pipelines und KI-Agentensitzungen: ```bash stripe docs -N payments # print guide to stdout stripe docs api customers -N # print API resource to stdout stripe docs search "refund" --no-pager # print search results to stdout ``` ## Verwendung mit Coding-Agenten Das Plug-in `stripe docs` wurde speziell für die Verwendung mit KI-Coding-Agenten entwickelt. Es bietet strukturierte, token-effiziente Ausgabeformate und nicht-interaktive Modi, damit Agenten die Stripe-Dokumentation programmgesteuert nutzen können – ohne Browser, HTML-Parsing oder interaktive Aufforderungen. > Kombinieren Sie bei allen Agentenworkflows immer `-N` (nicht-interaktiv) mit einem Flag `--format`. So ist eine saubere stdout-Ausgabe ohne TUI-Escape-Codes oder Pager-Aufforderungen gewährleistet. ### Flags für Agentenworkflows auswählen | Flag | Zweck | | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `-N` oder `--non-interactive` | TUI und Pager deaktivieren. Ausgabe direkt nach stdout drucken. | | `--no-pager` | Nur den Pager deaktivieren (bei Kombination mit `--format` wird TUI weiterhin übersprungen). | | `--format=compact` | Token-effizienter Klartext, optimiert für LLM-Kontextfenster. | | `--format=json` | Vollständig maschinenlesbares JSON. Am besten für programmgesteuertes Parsing geeignet. | | `--format=toon` | TOON-Format – verwendet im Vergleich zu JSON ca. 40 % weniger Token, behält aber die Struktur bei. | | `--format=tool` | Gibt eine Tool-Definition nach JSON Schema aus, die mit MCP und Function-Calling-Frameworks kompatibel ist. Erfordert eine `api`-Ressource und einen Vorgang. | | `--filter=required` | Zeigt nur Pflichtfelder und -parameter an. Dadurch wird die Ausgabegröße bei Erstellungs- und Aktualisierungsvorgängen erheblich reduziert. | | `--sections=` | Kommagetrennte Liste der einzuschließenden Abschnitte (z. B. `parameters`, `fields`, `operations`, `request`). So können Agenten nur das anfordern, was sie benötigen. | | `--language=` | Schränkt Codebeispiele auf eine einzige Sprache ein (z. B. `python`, `ruby`, `node`, `go`, `java`, `curl`). Dadurch werden irrelevante Beispiele weggelassen. | | `--source=local` | Verwendet ausschließlich gebündelte Inhalte und erfordert keine Netzwerkaufrufe. Gewährleistet schnelle, deterministische Ausgaben. | ### Tool-Definitionen für Function Calling generieren Das Flag `--format=tool` erzeugt eine Definition nach JSON Schema, die die Parameter, Typen und Einschränkungen eines API-Vorgangs beschreibt. Sie können diese Ausgabe direkt als Tool in MCP-Servern, beim OpenAI-Function-Calling oder in einem beliebigen Agenten-Framework registrieren, das JSON Schema akzeptiert: ```bash stripe docs api customers create --format=tool stripe docs api payment_intents create --format=tool stripe docs api subscriptions update --format=tool ``` Verwenden Sie das, um einen Agenten mit der Fähigkeit auszustatten, Stripe-APIs mit korrekten Parameterschemata aufzurufen. ### Kontext für LLM-Aufforderungen aufbauen Verwenden Sie `--format=compact`, um token-effiziente Dokumentation zu erstellen, die sich für die Einbindung in ein LLM-Kontextfenster eignet: ```bash # Get a compact summary of the Customers resource (fields + operations) stripe docs api customers -N --format=compact # Get only the required parameters for creating a PaymentIntent stripe docs api payment_intents create -N --format=compact --filter=required # Get a guide in compact format, in a single language stripe docs -N payments --format=compact --language=python # Combine sections filter to get only what matters stripe docs api subscriptions create -N --format=compact --sections=parameters --filter=required ``` ### In Scripts suchen und erkunden Agenten können den vollständigen Dokumentationsindex durchsuchen und strukturierte Ergebnisse erhalten: ```bash # Search and get JSON results an agent can iterate over stripe docs search "webhook signature verification" -N --format=json # Search for a concept and get compact results stripe docs search "idempotency" -N --format=compact # Explore event types for a resource stripe docs events payment_intent -N --format=json ``` ### Webhook-Ereignisnutzlasten untersuchen Wenn ein Agent verstehen muss, welche Daten in einem Webhook ankommen, kann er die vollständig typisierte Nutzlast abrufen: ```bash # Get the payload structure for a specific event stripe docs events checkout.session.completed -N --format=json # Get a compact summary of all fields in the event's data.object stripe docs events invoice.payment_succeeded -N --format=compact ``` ### Erweiterte Beispiele ausprobieren Kombinieren Sie Flags für präzise, minimale Ausgaben, die auf spezifische Agentenaufgaben zugeschnitten sind: ```bash # Agent building a Checkout integration: get only required params in Python stripe docs api checkout/sessions create -N --format=compact --filter=required --language=python # Agent needs to know all operations available on a resource stripe docs api payment_intents -N --format=json --sections=operations # Agent generating type definitions: get full field schema stripe docs api customers -N --format=json --sections=fields # Deep-link to a single field for type information stripe docs api customers#email -N --format=json # Get the full event catalog as JSON for dynamic webhook routing stripe docs events -N --format=json # Offline mode for deterministic, fast responses (no network) stripe docs api charges -N --format=compact --source=local # Pipe compact output into another tool or clipboard stripe docs api refunds create -N --format=compact --filter=required | pbcopy ``` ### Einen beispielhaften Agentenworkflow prüfen Ein typisches Muster für die Agentenintegration sieht folgendermaßen aus: 1. **Discover**: Der Agent sucht mithilfe von `stripe docs search` nach relevanter Dokumentation. 1. **Read**: Der Agent ruft mithilfe von `--format=compact` oder `--format=json` spezifische API-Ressourcen oder Leitfadeninhalte ab. 1. **Act**: Der Agent ruft die Stripe-API mit den erlernten Parametern auf. 1. **Register tools**: Der Agent verwendet `--format=tool`, um Stripe-Vorgänge dynamisch als aufrufbare Tools zu registrieren. ```bash # Step 1: Agent searches for how to create a subscription stripe docs search "create subscription" -N --format=json # Step 2: Agent reads the operation details with only required params stripe docs api subscriptions create -N --format=compact --filter=required --language=node # Step 3: Agent uses the learned parameters to make the API call stripe subscriptions create --customer=cus_123 --items[0][price]=price_456 # Register as a tool: agent adds this operation to its tool registry stripe docs api subscriptions create --format=tool ``` ## Befehlsreferenz | Befehl | Beschreibung | | ---------------------------------------- | ----------------------------------------------------------------------- | | `stripe docs` | Interaktiven TUI-Startbildschirm öffnen | | `stripe docs ` | Einen Leitfaden öffnen oder eine Abfrage mit Fuzzy-Matching durchführen | | `stripe docs api` | Gesamte API-Dokumentation durchsuchen | | `stripe docs api ` | Spezifische API-Ressource anzeigen | | `stripe docs api ` | Spezifischen API-Vorgang anzeigen | | `stripe docs api #` | Deep-Link zu einem bestimmten Feld | | `stripe docs events` | Alle Webhook-Ereignistypen durchsuchen | | `stripe docs events ` | Nutzlaststruktur für einen Ereignistyp anzeigen | | `stripe docs search` | Interaktive Such-TUI öffnen | | `stripe docs search ` | Leitfäden und API-Dokumentation durchsuchen | | `stripe docs version` | Plug-in-Version drucken |