Descripción

Projex CLI es una herramienta de línea de comandos para gestionar flujos de trabajo de proyectos con comandos de Git, VTEX y Bash. Permite automatizar tareas comunes de desarrollo, versionado, despliegue y documentación, facilitando la colaboración y la estandarización en equipos.

Tabla de Contenido

• Descripción
• Tabla de Contenido
• Instalación
• Comandos Principales
• Desarrollo Local
• Publicación en npm
• Documentación Detallada
• Autocompletado de Comandos
• Estructura de Carpetas y Módulos
• Contribuir
• Licencia

Instalación

npm i projex
# o global
npm i -g projex

Comandos Principales

Consulta todos los comandos disponibles con:

projex --help

Ejemplo de comandos destacados:

| Comando | Descripción | | ------------------------------------ | ------------------------------------------------------------------------------ | | projex git init | Inicializa archivos base para documentación y versionado en un repositorio Git | | projex git setup conventional | Configura commits convencionales con Husky y Commitlint | | projex git setup devops template | Añade archivos y carpetas necesarios para Azure DevOps | | projex git update changelog | Actualiza el changelog con los últimos cambios | | projex git clone | Clona los repositorios indicados | | projex git release | Bump de versión, commit y push automático | | projex pull-request labels suggest | Sugiere etiquetas para PRs según cambios detectados | | projex bash run | Ejecuta un comando en uno o varios directorios | | projex vtex login | Login en VTEX usando API key/token | | projex vtex cms backup | Descarga archivos de checkout VTEX | | projex vtex cms deploy | Despliega archivos locales en checkout VTEX | | projex vtex run | Ejecuta comandos aceptando preguntas "Yes/No" automáticamente | | projex vtex run-script | Ejecuta scripts desde manifest.json o package.json |

Desarrollo Local

npm run dev
# Para vincular el CLI localmente
sudo npm link

Publicación en npm

npm run postrelease

Documentación Detallada

La documentación completa se encuentra en la carpeta docs/:

• Arquitectura General: Patrones de diseño y estructura del sistema
• Etiquetas de Pull Request: Sugerencia automática de etiquetas para PRs
• Azure DevOps: Integración CI/CD y troubleshooting
• Gestión de Releases Git: Versionado y changelog automatizado
• Workflows VTEX: Automatización para la plataforma VTEX
• Automatización Bash: Ejecución de comandos en múltiples directorios
• Setup Git & Commits Convencionales: Estándares de commits y configuración de repositorios
• APIs y Utilidades Core: APIs internas y utilidades compartidas

Autocompletado de Comandos

Projex CLI soporta autocompletado para bash, zsh y fish usando el plugin oficial de oclif.

Para habilitar el autocompletado, ejecuta:

projex autocomplete

Sigue las instrucciones específicas para tu shell.

Estructura de Carpetas y Módulos

Los comandos se encuentran en src/commands/ y la lógica en src/modules/ y src/shared/. Consulta la documentación para detalles de arquitectura y patrones de diseño.

Contribuir

¿Quieres contribuir? Lee la documentación y sigue los estándares de commits convencionales.

Licencia

Este proyecto está bajo la licencia MIT. Consulta el archivo LICENSE para más detalles.