Exemples de commandes CLI Archbee

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.

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 :

Exemple de sortie :

Le site local s’exécute généralement à l’adresse suivante :

Validez la structure et la configuration de votre documentation :

Exemple de sortie :

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 :

Exemple de sortie :

Cela est utile avant de publier des modifications.

La plupart des commandes de gestion des documents nécessitent :

Recherchez des documents dans un espace de documentation :

Exemple de sortie :

Récupérez un document par ID :

Exemple de sortie :

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 :

Exemple de sortie :

Supprimez un document d’un espace :

Exemple de sortie :

Utilisez les commandes de suppression avec précaution, car elles affectent directement la documentation publiée.

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 :

Exemple de sortie :

Récupérez des informations sur un arbre de documentation OpenAPI existant :

Exemple de sortie :

Si la synchronisation échoue, validez le schéma OpenAPI avant de réessayer.

Le CLI peut également gérer les fichiers téléversés directement depuis le terminal.

Téléverser un fichier :

Exemple de sortie :

Lister les fichiers et dossiers téléversés :

Exemple de sortie :

Remplacer un fichier existant tout en conservant la même URL publique :

Exemple de sortie :

Publier les mises à jour de la documentation en production :

Exemple de sortie :

Assurez-vous que la clé API possède les permissions d’écriture avant la publication.

Chaque commande CLI prend en charge le drapeau --help.

Exemple :

Exemple de sortie :

Cela affiche tous les drapeaux, arguments et exemples d’utilisation pris en charge pour la commande sélectionnée.