Ejemplos de comandos de Archbee CLI

Esta guía muestra flujos de trabajo comunes de Archbee CLI con ejemplos prácticos de comandos.

La mayoría de los comandos de desarrollo local pueden ejecutarse sin autenticación. Los comandos que interactúan con contenido en la plataforma Archbee normalmente requieren tanto una clave API como un ID de espacio.

Use estos comandos mientras escribe o prueba documentación localmente.

Previsualice su documentación con recarga en vivo durante el desarrollo:

Salida de ejemplo:

El sitio local normalmente se ejecuta en:

Valide la estructura y configuración de su documentación:

Salida de ejemplo:

Este comando ayuda a detectar archivos de configuración faltantes, estructuras no válidas y otros problemas comunes de configuración.

Verifique enlaces internos rotos:

Salida de ejemplo:

Esto es útil antes de publicar cambios.

La mayoría de los comandos de administración de documentos requieren:

Busque documentos dentro de un espacio de documentación:

Salida de ejemplo:

Recupere un documento por ID:

Salida de ejemplo:

La bandera --format admite formatos como markdown, html, json y source.

Cree un nuevo documento o actualice uno existente desde un archivo markdown local:

Salida de ejemplo:

Elimine un documento de un espacio:

Salida de ejemplo:

Use los comandos de eliminación con cuidado porque afectan directamente la documentación publicada.

Archbee CLI puede importar y sincronizar especificaciones OpenAPI para generar documentación de referencia de API.

Sincronice un archivo OpenAPI en un espacio de documentación:

Salida de ejemplo:

Recupere información sobre un árbol de documentación OpenAPI existente:

Ejemplo de salida:

Si la sincronización falla, valide el esquema OpenAPI antes de reintentar.

El CLI también puede administrar archivos cargados directamente desde la terminal.

Cargar un archivo:

Ejemplo de salida:

Listar archivos y carpetas cargados:

Ejemplo de salida:

Reemplazar un archivo existente manteniendo la misma URL pública:

Ejemplo de salida:

Publicar actualizaciones de documentación en producción:

Ejemplo de salida:

Asegúrese de que la clave API tenga permisos de escritura antes de publicar.

Todos los comandos del CLI admiten la bandera --help.

Ejemplo:

Ejemplo de salida:

Esto muestra todas las banderas, argumentos y ejemplos de uso compatibles para el comando seleccionado.