--- title: Exemples de commandes CLI Archbee slug: docs/fr/exemples-de-commandes-cli-archbee createdAt: 2026-08-25T09:37:14.516Z --- ## Exemples de commandes Archbee CLI Ce guide présente les flux de travail courants d’Archbee CLI avec des exemples de commandes pratiques. La plupart des commandes de développement local peuvent être exécutées sans authentification. Les commandes qui interagissent avec le contenu sur la plateforme Archbee nécessitent généralement à la fois une clé API et un ID d’espace. ## Développement local Utilisez ces commandes lors de la rédaction ou des tests de documentation en local. Prévisualisez votre documentation avec le rechargement en direct pendant le développement : ```bash archbee dev ``` Exemple de sortie : ```text Archbee local server running at http://localhost:3000 Watching files for changes... ``` Le site local s’exécute généralement à l’adresse suivante : ```text http://localhost:3000 ``` Validez la structure et la configuration de votre documentation : ```bash archbee validate ``` Exemple de sortie : ```text ✓ Configuration valid ✓ No structural issues found ``` Cette commande aide à détecter les fichiers de configuration manquants, les structures invalides et d’autres problèmes courants de configuration. Vérifiez les liens internes brisés : ```bash archbee broken-links ``` Exemple de sortie : ```text Scanning documentation... ✓ No broken links found ``` Cela est utile avant de publier des modifications. ## Gestion des documents La plupart des commandes de gestion des documents nécessitent : - `--api-key` - `--doc-space-id` Recherchez des documents dans un espace de documentation : ```bash archbee search-docs --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Exemple de sortie : ```text Found 12 matching documents ``` Récupérez un document par ID : ```bash archbee get-doc DOC_ID --format markdown --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Exemple de sortie : ```text Document exported successfully ``` L’option `--format` prend en charge des formats tels que markdown, html, json et source. Créez un nouveau document ou mettez à jour un document existant à partir d’un fichier markdown local : ```bash archbee create-doc ./doc.md --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Exemple de sortie : ```text Document created successfully ``` Supprimez un document d’un espace : ```bash archbee delete-doc DOC_ID --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Exemple de sortie : ```text Document deleted successfully ``` Utilisez les commandes de suppression avec précaution, car elles affectent directement la documentation publiée. ## Flux de travail OpenAPI Archbee CLI peut importer et synchroniser des spécifications OpenAPI pour générer une documentation de référence API. Synchronisez un fichier OpenAPI dans un espace de documentation : ```bash archbee sync-openapi openapi.yaml --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Exemple de sortie : ```text OpenAPI sync completed successfully ``` Récupérez des informations sur un arbre de documentation OpenAPI existant : ```bash archbee info-openapi TREE_ID --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Exemple de sortie : ```text OpenAPI tree contains 24 endpoints ``` Si la synchronisation échoue, validez le schéma OpenAPI avant de réessayer. ## Commandes du gestionnaire de fichiers Le CLI peut également gérer les fichiers téléversés directement depuis le terminal. Téléverser un fichier : ```bash archbee upload ./logo.png --api-key YOUR_API_KEY ``` Exemple de sortie : ```text File uploaded successfully ``` Lister les fichiers et dossiers téléversés : ```bash archbee list-files --api-key YOUR_API_KEY ``` Exemple de sortie : ```text Found 42 files ``` Remplacer un fichier existant tout en conservant la même URL publique : ```bash archbee replace-file FILE_ID ./new-logo.png --api-key YOUR_API_KEY ``` Exemple de sortie : ```text File replaced successfully ``` :::hint{type="info"} La commande `remplacer-le-fichier` met à jour un fichier tout en conservant la même URL publique, ce qui aide à éviter les liens brisés dans la documentation. ::: ## Publication des modifications Publier les mises à jour de la documentation en production : ```bash archbee publish-space --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Exemple de sortie : ```text Space published successfully ``` Assurez-vous que la clé API possède les permissions d’écriture avant la publication. ## Obtenir de l’aide sur les commandes Chaque commande CLI prend en charge le drapeau `--help`. ```bash archbee --help ``` Exemple : ```bash archbee create-doc --help ``` Exemple de sortie : ```text Usage: archbee create-doc [options] ``` Cela affiche tous les drapeaux, arguments et exemples d’utilisation pris en charge pour la commande sélectionnée. ## Ressources supplémentaires - [https://archbee.com/docs](https://archbee.com/docs) - [https://www.npmjs.com/package/@archbee/cli](https://www.npmjs.com/package/@archbee/cli)