Archbee CLI-Befehlsbeispiele

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.

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:

Beispielausgabe:

Die lokale Website läuft typischerweise unter:

Validieren Sie Ihre Dokumentationsstruktur und Konfiguration:

Beispielausgabe:

Dieser Befehl hilft dabei, fehlende Konfigurationsdateien, ungültige Strukturen und andere häufige Einrichtungsprobleme zu erkennen.

Prüfen Sie auf fehlerhafte interne Links:

Beispielausgabe:

Dies ist vor dem Veröffentlichen von Änderungen nützlich.

Die meisten Befehle zur Dokumentverwaltung erfordern:

Suchen Sie nach Dokumenten innerhalb eines Dokumentationsbereichs:

Beispielausgabe:

Rufen Sie ein Dokument anhand seiner ID ab:

Beispielausgabe:

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:

Beispielausgabe:

Löschen Sie ein Dokument aus einem Bereich:

Beispielausgabe:

Verwenden Sie Löschbefehle vorsichtig, da sie veröffentlichte Dokumentation direkt beeinflussen.

Die Archbee CLI kann OpenAPI-Spezifikationen importieren und synchronisieren, um API-Referenzdokumentation zu generieren.

Synchronisieren Sie eine OpenAPI-Datei in einen Dokumentationsbereich:

Beispielausgabe:

Rufen Sie Informationen über eine vorhandene OpenAPI-Dokumentationsstruktur ab:

Beispielausgabe:

Wenn die Synchronisierung fehlschlägt, validieren Sie das OpenAPI-Schema, bevor Sie es erneut versuchen.

Die CLI kann hochgeladene Dateien auch direkt über das Terminal verwalten.

Eine Datei hochladen:

Beispielausgabe:

Hochgeladene Dateien und Ordner auflisten:

Beispielausgabe:

Eine vorhandene Datei ersetzen und dabei dieselbe öffentliche URL beibehalten:

Beispielausgabe:

Veröffentlichen Sie Dokumentationsaktualisierungen in der Produktionsumgebung:

Beispielausgabe:

Stellen Sie sicher, dass der API-Schlüssel vor der Veröffentlichung über Schreibberechtigungen verfügt.

Jeder CLI-Befehl unterstützt das Flag --help.

Beispiel:

Beispielausgabe:

Dadurch werden alle unterstützten Flags, Argumente und Verwendungsbeispiele für den ausgewählten Befehl angezeigt.