Installation et configuration de l’interface fr-CA ligne de commande Archbee
Prérequis
Avant d’installer l’Archbee CLI, assurez-vous d’avoir :
- Node.js 18 ou une version plus récente
- npm installé
- Accès à votre espace de travail Archbee si vous utilisez des commandes API
Archbee CLI nécessite Node.js 18 ou une version plus récente. Les anciennes versions de Node.js peuvent provoquer des problèmes d’installation ou d’exécution.
Flux de travail d’installation
Installez Archbee CLI globalement à l’aide de npm.
Créez un nouveau projet de documentation ou ouvrez un dépôt de documentation existant.
Démarrez le serveur de développement local avec archbee dev.
Validez les modifications de la documentation et publiez les mises à jour lorsqu’elles sont prêtes.
Installer la CLI
npm install -g @archbee/cliVérifiez l’installation :
archbee versionExemple de sortie :
@archbee/cli 1.0.0Créer un nouveau projet de documentation
archbee new my-docs
cd my-docs
archbee devExemple de sortie :
Archbee local server running at http://localhost:3000Le serveur d’aperçu local démarre à l’adresse suivante :
http://localhost:3000Utiliser la CLI avec une documentation existante
La CLI détecte automatiquement les fichiers de configuration pris en charge.
Format | Fichier de configuration |
|---|---|
Archbee | archbee.json |
Docusaurus | docusaurus.config.js ou .ts |
Exemple :
cd your-existing-docs-project
archbee devExemple de sortie :
Detected Docusaurus project
Starting development server...Erreurs de configuration courantes
"archbee : commande introuvable"
Essayez de réinstaller globalement :
npm install -g @archbee/cliEnsuite, redémarrez votre terminal.
"Aucun fichier de configuration trouvé"
Assurez-vous que votre projet contient l’un des fichiers de configuration pris en charge :
- archbee.json
- docusaurus.config.js
- docusaurus.config.ts
Problèmes de version de Node.js
Vérifiez votre version installée de Node :
node -vPassez à Node.js 18+ si nécessaire.