ZCLI

Herramienta de línea de comandos con utilidades para la creación, desarrollo y mantenimiento de proyectos con el Framework Zorraquino.

🚀 Instalación

npm install -g @zorraquino/zcli

Requisitos:

• Bun >= 1.0.0 (se instalará automáticamente si no está presente)
• Node.js >= 18 (para npm)
• Git

📖 Uso

zcli [command] [options]

Para ver la lista completa de comandos:

zcli --help

🎯 Comandos Principales

Creación de Proyectos

• create-app: Clonar e inicializar un nuevo proyecto completo del Framework Zorraquino

  zcli create-app

• init-app: Inicializar Framework Zorraquino en un directorio existente

  zcli init-app

• create-block: Crear un nuevo bloque/componente React

  zcli create-block

• create-template: Crear una nueva plantilla/layout

  zcli create-template

Desarrollo

• dev: Iniciar servidor de desarrollo Vite

  zcli dev

• dev:host: Iniciar servidores de desarrollo (PHP + Vite) con acceso desde red local

  zcli dev:host

• serve: Iniciar servidor de producción

  zcli serve --port 8000

Compilación

• build: Compilar proyecto para producción

  zcli build

• build:dev: Compilar proyecto en modo desarrollo

  zcli build:dev

• watch: Compilar y observar cambios (producción)

  zcli watch

• watch:dev: Compilar y observar cambios (desarrollo)

  zcli watch:dev

Calidad de Código

• test: Ejecutar tests con Vitest

  zcli test

• lint: Ejecutar linter en el proyecto

  zcli lint

• format: Formatear código con Prettier

  zcli format

• check: Verificar formateo sin modificar archivos

  zcli check

• react-scan: Analizar performance de aplicación React

  zcli react-scan

Mantenimiento

• backup: Crear backup de archivos multimedia (imágenes, documentos, vídeos)

  zcli backup

• cleanup: Limpiar archivos temporales y configurar permisos

  zcli cleanup

• update: Actualizar proyecto a la última versión del Framework Zorraquino

  zcli update

• upgrade: Actualizar ZCLI a la última versión

  zcli upgrade

📚 Documentación Completa

Para documentación detallada, consulta:

• Documentación de Usuario y Desarrollador: Índice completo de documentación
• Guía del Desarrollador: Cómo contribuir y extender ZCLI
• Arquitectura: Detalles técnicos de la arquitectura
• Reglas de Contexto para AI: Contexto para Cursor AI y asistentes similares

🔧 Workflow Típico

Crear un Nuevo Proyecto

# 1. Crear proyecto
zcli create-app

# 2. Navegar al directorio
cd mi-proyecto

# 3. Iniciar desarrollo
zcli dev:host

# 4. En otra terminal, observar cambios
zcli watch:dev

Añadir un Nuevo Bloque

# 1. Crear bloque
zcli create-block

# 2. El proyecto se compila automáticamente

# 3. El bloque ya está disponible en el CMS

Antes de Deploy

# 1. Formatear código
zcli format

# 2. Verificar linting
zcli lint

# 3. Ejecutar tests
zcli test

# 4. Compilar para producción
zcli build

# 5. Verificar build localmente
zcli serve

🐛 Troubleshooting

Bun no está instalado

El CLI detectará automáticamente si Bun no está instalado y ofrecerá instalarlo.

Puerto ya en uso

# Encontrar proceso usando el puerto
lsof -i :5173

# Matar proceso
kill -9 <PID>

Build falla

# Ejecutar Vite directamente para ver error completo
bunx --bun vite build --mode=development

Para más soluciones, consulta la Guía de Troubleshooting

🤝 Contribuir

Las contribuciones son bienvenidas! Por favor:

1. Fork del repositorio
2. Crea una rama para tu feature: git checkout -b feature/mi-feature
3. Commit tus cambios: git commit -m "feat: descripción"
4. Push a la rama: git push origin feature/mi-feature
5. Crea un Pull Request

Ver la Guía del Desarrollador para más detalles.

📦 Releases

Para publicar una nueva versión:

# Asegúrate de estar en master y tener todos los cambios commiteados
npm run release [patch|minor|major]

El script automáticamente:

• Incrementa la versión en package.json
• Actualiza el CHANGELOG.md con los commits desde el último release
• Crea un tag de git
• Hace push a GitHub
• GitHub Actions se encarga de publicar en npm y crear el release

📜 Licencia

MIT © Zorraquino Comunicación SLU

🔗 Enlaces

• GitHub: https://github.com/Zorraquino/zcli
• npm: https://www.npmjs.com/package/@zorraquino/zcli
• Framework Zorraquino: https://github.com/Zorraquino/z-cms (si está disponible) o https://gitlab.com/zorraquino-dev/cms/z-cms
• Documentación: ./docs/README.md

Versión: 1.0.0 | Última actualización: Octubre 2025