Comandos CLI de Osumi Framework
Osumi Framework incluye un conjunto de tareas CLI que permiten realizar diversas operaciones relacionadas con el desarrollo y mantenimiento de aplicaciones. A continuación, se describe la lista de comandos disponibles:
Comandos disponibles
add
Descripción: Permite crear nuevas acciones, servicios, tareas, componentes del modelo, componentes o filtros.
Uso:
php of add [tipo] [nombre]
- tipo: Tipo del elemento a crear (
action,service,task,modelComponent,component,filter). - nombre: Nombre del elemento a crear.
Ejemplo:
php of add --option action --name MyAction
backupAll
Descripción: Genera una copia de seguridad completa de la aplicación, incluyendo la base de datos y el código.
Uso:
php of backupAll
Notas: Este comando invoca internamente las tareas backupDB y extractor.
backupDB
Descripción: Crea una copia de seguridad de la base de datos con la herramienta mysqldump.
Uso:
php of backupDB [opciones]
- opciones:
silent: Si se incluye, el comando no mostrará mensajes en la consola.
Ejemplo:
php of backupDB silent
extractor
Descripción: Exporta toda la aplicación a un único archivo PHP autoextraíble.
Uso:
php of extractor
Notas: Exporta toda la aplicación a un único archivo PHP autoextraíble.
generateModel
Descripción: Genera un archivo SQL para crear todas las tablas de la base de datos basadas en los modelos definidos por el usuario.
Uso:
php of generateModel
Notas: El archivo SQL se genera en el directorio de exportación.
generateModelFrom
Descripción: Genera todos los modelos a partir de un archivo JSON proporcionado.
Uso:
php of generateModelFrom [archivo]
- archivo: Ruta al archivo JSON que contiene las definiciones del modelo.
Ejemplo:
php of generateModelFrom models.json
generateModelFromDB
Descripción: Genera todos los modelos a partir de una conexión a una base de datos existente.
Uso:
php of generateModelFromDB
Notas: Se conecta a la base de datos configurada y genera los modelos correspondientes.
reset
Descripción: Limpia todos los datos que no pertenecen al framework, útil para nuevas instalaciones.
Uso:
php of reset
Notas: Elimina carpetas y archivos generados por el usuario y restaura la configuración y estructura predeterminadas.
version
Descripción: Muestra información sobre la versión actual del framework.
Uso:
php of la versión
Notas: Incluye enlaces al repositorio oficial y a la cuenta X (anteriormente Twitter) del proyecto.
Notas adicionales
- Todos los comandos deben ejecutarse desde la raíz del proyecto.
- Asegúrese de que las configuraciones necesarias estén definidas en el archivo
Config.jsonantes de ejecutar comandos relacionados con la base de datos o las exportaciones.