--- title: Archbee CLI-Befehlsbeispiele slug: docs/de/archbee-cli-befehlsbeispiele docTags: createdAt: 2026-08-25T09:37:14.516Z --- ## Beispiele für Archbee CLI-Befehle Dieser Leitfaden zeigt gängige Archbee CLI-Workflows mit praktischen Befehlsbeispielen. Die meisten lokalen Entwicklungsbefehle können ohne Authentifizierung ausgeführt werden. Befehle, die mit Inhalten auf der Archbee-Plattform interagieren, benötigen normalerweise sowohl einen API-Schlüssel als auch eine Space-ID. ## Lokale Entwicklung Verwenden Sie diese Befehle, während Sie Dokumentation lokal schreiben oder testen. Zeigen Sie während der Entwicklung eine Vorschau Ihrer Dokumente mit Live-Reload an: ```bash archbee dev ``` Beispielausgabe: ```text Archbee local server running at http://localhost:3000 Watching files for changes... ``` Die lokale Website läuft typischerweise unter: ```text http://localhost:3000 ``` Validieren Sie Ihre Dokumentationsstruktur und Konfiguration: ```bash archbee validate ``` Beispielausgabe: ```text ✓ Configuration valid ✓ No structural issues found ``` Dieser Befehl hilft dabei, fehlende Konfigurationsdateien, ungültige Strukturen und andere häufige Einrichtungsprobleme zu erkennen. Prüfen Sie auf fehlerhafte interne Links: ```bash archbee broken-links ``` Beispielausgabe: ```text Scanning documentation... ✓ No broken links found ``` Dies ist vor dem Veröffentlichen von Änderungen nützlich. ## Dokumente verwalten Die meisten Befehle zur Dokumentverwaltung erfordern: - `--api-key` - `--doc-space-id` Suchen Sie nach Dokumenten innerhalb eines Dokumentationsbereichs: ```bash archbee search-docs --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Beispielausgabe: ```text Found 12 matching documents ``` Rufen Sie ein Dokument anhand seiner ID ab: ```bash archbee get-doc DOC_ID --format markdown --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Beispielausgabe: ```text Document exported successfully ``` Das `--format`-Flag unterstützt Formate wie markdown, html, json und source. Erstellen Sie ein neues Dokument oder aktualisieren Sie ein vorhandenes aus einer lokalen Markdown-Datei: ```bash archbee create-doc ./doc.md --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Beispielausgabe: ```text Document created successfully ``` Löschen Sie ein Dokument aus einem Bereich: ```bash archbee delete-doc DOC_ID --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Beispielausgabe: ```text Document deleted successfully ``` Verwenden Sie Löschbefehle vorsichtig, da sie veröffentlichte Dokumentation direkt beeinflussen. ## OpenAPI-Workflows Die Archbee CLI kann OpenAPI-Spezifikationen importieren und synchronisieren, um API-Referenzdokumentation zu generieren. Synchronisieren Sie eine OpenAPI-Datei in einen Dokumentationsbereich: ```bash archbee sync-openapi openapi.yaml --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Beispielausgabe: ```text OpenAPI sync completed successfully ``` Rufen Sie Informationen über eine vorhandene OpenAPI-Dokumentationsstruktur ab: ```bash archbee info-openapi TREE_ID --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Beispielausgabe: ```text OpenAPI tree contains 24 endpoints ``` Wenn die Synchronisierung fehlschlägt, validieren Sie das OpenAPI-Schema, bevor Sie es erneut versuchen. ## Dateimanager-Befehle Die CLI kann hochgeladene Dateien auch direkt über das Terminal verwalten. Eine Datei hochladen: ```bash archbee upload ./logo.png --api-key YOUR_API_KEY ``` Beispielausgabe: ```text File uploaded successfully ``` Hochgeladene Dateien und Ordner auflisten: ```bash archbee list-files --api-key YOUR_API_KEY ``` Beispielausgabe: ```text Found 42 files ``` Eine vorhandene Datei ersetzen und dabei dieselbe öffentliche URL beibehalten: ```bash archbee replace-file FILE_ID ./new-logo.png --api-key YOUR_API_KEY ``` Beispielausgabe: ```text File replaced successfully ``` :::hint{type="info"} Der Befehl `Datei ersetzen` aktualisiert eine Datei unter Beibehaltung derselben öffentlichen URL, was hilft, defekte Links in der Dokumentation zu vermeiden. ::: ## Änderungen veröffentlichen Veröffentlichen Sie Dokumentationsaktualisierungen in der Produktionsumgebung: ```bash archbee publish-space --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Beispielausgabe: ```text Space published successfully ``` Stellen Sie sicher, dass der API-Schlüssel vor der Veröffentlichung über Schreibberechtigungen verfügt. ## Hilfe zu Befehlen abrufen Jeder CLI-Befehl unterstützt das Flag `--help`. ```bash archbee --help ``` Beispiel: ```bash archbee create-doc --help ``` Beispielausgabe: ```text Usage: archbee create-doc [options] ``` Dadurch werden alle unterstützten Flags, Argumente und Verwendungsbeispiele für den ausgewählten Befehl angezeigt. ## Zusätzliche Ressourcen - [https://archbee.com/docs](https://archbee.com/docs) - [https://www.npmjs.com/package/@archbee/cli](https://www.npmjs.com/package/@archbee/cli)