larksuite/lark-whiteboard-cli

¿Qué hace lark-whiteboard-cli?

Utilice esta skill cuando el usuario solicite o necesite dibujar diagramas de arquitectura, diagramas de flujo, mapas mentales, diagramas de secuencia u otros gráficos visuales en la pizarra de Feishu (Lark), como guía para usar whiteboard-cli en el diseño de la disposición de los diagramas.

Introducción

whiteboard-cli es una herramienta de línea de comandos que permite crear y gestionar contenido en la pizarra de Feishu (Lark) de manera eficiente. Con ella, puede:

• Dibujar diagramas de arquitectura
• Crear diagramas de flujo
• Diseñar mapas mentales
• Elaborar diagramas de secuencia
• Generar otros tipos de gráficos visuales

Requisitos previos

• Tener instalado Node.js (versión 14 o superior)
• Contar con una cuenta de Feishu (Lark)
• Obtener un token de acceso para la API de Feishu

Instalación

npm install -g @feishu/whiteboard-cli

Configuración inicial

Antes de usar la herramienta, configure las credenciales de autenticación:

whiteboard-cli config set --app-id <your-app-id> --app-secret <your-app-secret>

Comandos principales

Crear un nuevo diagrama

whiteboard-cli create --type <tipo> --name "Nombre del diagrama"

Tipos disponibles:

• architecture: Diagrama de arquitectura
• flowchart: Diagrama de flujo
• mindmap: Mapa mental
• sequence: Diagrama de secuencia

Añadir elementos al diagrama

whiteboard-cli add --type rectangle --position x,y --width 200 --height 100 --text "Descripción"

Conectar elementos

whiteboard-cli connect --from <id1> --to <id2> --label "Conexión"

Exportar el diagrama

whiteboard-cli export --format png --output ./diagrama.png

Buenas prácticas

1. Planifique el diseño antes de empezar a dibujar
2. Use colores y formas consistentes para representar diferentes tipos de elementos
3. Mantenga el diagrama simple evitando demasiados detalles en una sola vista
4. Agregue etiquetas claras a las conexiones y elementos
5. Use capas para organizar elementos complejos

Ejemplo de uso

Crear un diagrama de arquitectura simple:

# Crear el diagrama
whiteboard-cli create --type architecture --name "Arquitectura del sistema"

# Agregar componentes
whiteboard-cli add --type rectangle --position 100,100 --width 200 --height 80 --text "Frontend"
whiteboard-cli add --type rectangle --position 400,100 --width 200 --height 80 --text "Backend"
whiteboard-cli add --type rectangle --position 250,300 --width 200 --height 80 --text "Base de datos"

# Conectar componentes
whiteboard-cli connect --from 1 --to 2 --label "API"
whiteboard-cli connect --from 2 --to 3 --label "SQL"

Solución de problemas

• Error de autenticación: Verifique que el app-id y app-secret sean correctos
• Elementos no visibles: Asegúrese de que las coordenadas estén dentro del área de la pizarra
• Exportación fallida: Compruebe que la ruta de salida tenga permisos de escritura

Referencia

Para más información, consulte la documentación oficial de Feishu:

• API de Feishu
• Guía de whiteboard-cli