CLI

El CLI es un pequeño script de Shell para Linux o macOS que permite acceder a funciones internas de una instalación de Osumi Framework. Tiene su propio repositorio en Osumi Framework CLI.

Este script es independiente de un proyecto, de modo que con instalar el script en un lugar comun dentro del PATH, puede servir para multiples proyectos en la misma máquina.

El framework ofrece una serie de tareas internas (para crear módulos o componentes, realizar copias de seguridad...) e incluso se pueden crear tareas personalizadas para ejecutar desde línea de comandos, y este script es la manera de acceder a ellos.

Instalación

La instalación es realmente sencilla, solo es necesario el archivo ofw del repositorio. Se trata de un script bash creado para sistemas Debian (no ha sido probado en otras distribuciones).

Requisitos:

• git
• php
• curl
• coreutils-7

Instalación

Descarga el archivo ofw a la carpeta /usr/local/bin (u otra ruta de tu elección que esté en el PATH).

Dale permisos 755, de modo que cualquier usuario pueda verlo o ejecutarlo, pero solo un administrador pueda modificarlo.

Ejecución

Al estar instalado en una ruta del PATH, simplemente ejecuta:

ofw <opción>

• new Crea un nuevo proyecto en blanco con la última versión del Osumi Framework. En el caso de querer usar un nombre complejo (espacios, caracteres raros...), debe indicarse entre comillas dobles y se creará una carpeta cuyo nombre será un slug del nombre indicado. Por ejemplo: ofw new "esto es una prueba" creará un nuevo proyecto vacío en la carpeta esto-es-una-prueba.
• cliUpdateCheck Comprueba si se está usando la última versión disponible del CLI.
• cliUpdate Actualiza el CLI a la última versión disponible. Es necesario ejecutarlo como root o con sudo.
• Tareas propias del framework además de las opciones propias del CLI, este ejecutable permite acceder a las tareas propias del framework: generateModel, updateUrls, add, version... Ver Tareas.
• Tareas personalizadas creadas para un proyecto concreto. Por ejemplo para ejecutar una tarea llamada sendEmail que se encuentra en app/task/sendEmail.task.php, simplemente hay que ejecutar el comando ofw sendEmail.