Archbee CLI-Installation & Einrichtung
Anforderungen
Bevor Sie die Archbee CLI installieren, stellen Sie sicher, dass Sie Folgendes haben:
- Node.js 18 oder neuer
- installiertes npm
- Zugriff auf Ihren Archbee-Workspace, wenn Sie API-Befehle verwenden
Archbee CLI erfordert Node.js 18 oder neuer. Ältere Node.js-Versionen können Installations- oder Laufzeitprobleme verursachen.
Installationsablauf
Installieren Sie die Archbee CLI global mit npm.
Erstellen Sie ein neues Dokumentationsprojekt oder öffnen Sie ein bestehendes Docs-Repository.
Starten Sie den lokalen Entwicklungsserver mit archbee dev.
Validieren Sie Dokumentationsänderungen und veröffentlichen Sie Aktualisierungen, wenn alles bereit ist.
Installieren Sie die CLI
npm install -g @archbee/cliÜberprüfen Sie die Installation:
archbee versionBeispielausgabe:
@archbee/cli 1.0.0Erstellen Sie ein neues Dokumentationsprojekt
archbee new my-docs
cd my-docs
archbee devBeispielausgabe:
Archbee local server running at http://localhost:3000Der lokale Vorschau-Server startet unter:
http://localhost:3000Verwenden Sie die CLI mit bestehenden Docs
Die CLI erkennt unterstützte Konfigurationsdateien automatisch.
Format | Konfigurationsdatei |
|---|---|
Archbee | archbee.json |
Docusaurus | docusaurus.config.js oder .ts |
Beispiel:
cd your-existing-docs-project
archbee devBeispielausgabe:
Detected Docusaurus project
Starting development server...Häufige Einrichtungsfehler
"archbee: Befehl nicht gefunden"
Versuchen Sie eine erneute globale Installation:
npm install -g @archbee/cliStarten Sie anschließend Ihr Terminal neu.
"Keine Konfigurationsdatei gefunden"
Stellen Sie sicher, dass Ihr Projekt eine der unterstützten Konfigurationsdateien enthält:
- archbee.json
- docusaurus.config.js
- docusaurus.config.ts
Probleme mit der Node.js-Version
Überprüfen Sie Ihre installierte Node-Version:
node -vAktualisieren Sie bei Bedarf auf Node.js 18+.