--- title: Ejemplos de comandos de Archbee CLI slug: docs/es/ejemplos-de-comandos-de-archbee-cli docTags: createdAt: 2026-08-25T09:37:14.516Z --- ## 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. ## Desarrollo local Use estos comandos mientras escribe o prueba documentación localmente. Previsualice su documentación con recarga en vivo durante el desarrollo: ```bash archbee dev ``` Salida de ejemplo: ```text Archbee local server running at http://localhost:3000 Watching files for changes... ``` El sitio local normalmente se ejecuta en: ```text http://localhost:3000 ``` Valide la estructura y configuración de su documentación: ```bash archbee validate ``` Salida de ejemplo: ```text ✓ Configuration valid ✓ No structural issues found ``` 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: ```bash archbee broken-links ``` Salida de ejemplo: ```text Scanning documentation... ✓ No broken links found ``` Esto es útil antes de publicar cambios. ## Administración de documentos La mayoría de los comandos de administración de documentos requieren: - `--api-key` - `--doc-space-id` Busque documentos dentro de un espacio de documentación: ```bash archbee search-docs --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Salida de ejemplo: ```text Found 12 matching documents ``` Recupere un documento por ID: ```bash archbee get-doc DOC_ID --format markdown --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Salida de ejemplo: ```text Document exported successfully ``` La bandera `--format` admite formatos como markdown, html, json y source. Cree un nuevo documento o actualice uno existente desde un archivo markdown local: ```bash archbee create-doc ./doc.md --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Salida de ejemplo: ```text Document created successfully ``` Elimine un documento de un espacio: ```bash archbee delete-doc DOC_ID --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Salida de ejemplo: ```text Document deleted successfully ``` Use los comandos de eliminación con cuidado porque afectan directamente la documentación publicada. ## Flujos de trabajo de OpenAPI 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: ```bash archbee sync-openapi openapi.yaml --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Salida de ejemplo: ```text OpenAPI sync completed successfully ``` Recupere información sobre un árbol de documentación OpenAPI existente: ```bash archbee info-openapi TREE_ID --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Ejemplo de salida: ```text OpenAPI tree contains 24 endpoints ``` Si la sincronización falla, valide el esquema OpenAPI antes de reintentar. ## Comandos del Administrador de Archivos El CLI también puede administrar archivos cargados directamente desde la terminal. Cargar un archivo: ```bash archbee upload ./logo.png --api-key YOUR_API_KEY ``` Ejemplo de salida: ```text File uploaded successfully ``` Listar archivos y carpetas cargados: ```bash archbee list-files --api-key YOUR_API_KEY ``` Ejemplo de salida: ```text Found 42 files ``` Reemplazar un archivo existente manteniendo la misma URL pública: ```bash archbee replace-file FILE_ID ./new-logo.png --api-key YOUR_API_KEY ``` Ejemplo de salida: ```text File replaced successfully ``` :::hint{type="info"} El comando `reemplazar archivo` actualiza un archivo mientras conserva la misma URL pública, lo que ayuda a evitar enlaces rotos en la documentación. ::: ## Publicación de Cambios Publicar actualizaciones de documentación en producción: ```bash archbee publish-space --api-key YOUR_API_KEY --doc-space-id SPACE_ID ``` Ejemplo de salida: ```text Space published successfully ``` Asegúrese de que la clave API tenga permisos de escritura antes de publicar. ## Obtener Ayuda de Comandos Todos los comandos del CLI admiten la bandera `--help`. ```bash archbee --help ``` Ejemplo: ```bash archbee create-doc --help ``` Ejemplo de salida: ```text Usage: archbee create-doc [options] ``` Esto muestra todas las banderas, argumentos y ejemplos de uso compatibles para el comando seleccionado. ## Recursos Adicionales - [https://archbee.com/docs](https://archbee.com/docs) - [https://www.npmjs.com/package/@archbee/cli](https://www.npmjs.com/package/@archbee/cli)