The AOC Framework
Documentación
TOOLS
aoc-cli #
El paquete npm aoc-cli es un programa de línea de comandos que le ayudará con tareas de generación de código automática.
Instalación de aoc-cli #
Para instalar la última versión de aoc-cli ejecute esta línea de comandos:
npm install -g @atlantis-of-code/aoc-cli
Lista de comandos #
| Comando / Argumentos | Alias | Descripción | Por defecto |
|---|---|---|---|
| generate entities | g e | Genera modelos, entidades, y configuraciones de modelos, y escribe los archivos resultantes | |
| --baseDir | -b | * Ruta (carpeta) en la que se encuentan los archivos de configuración | ruta actual |
| --config | -c | * Lista de archivos json de configuración que se mezclar desde el último hasta el primero. Puede usar rutas absolutas o relativas. | aoc-entities-config.json,aoc-entities-secrets.json |
| generate database | g db | Ejecuta los scripts sql que se encuentran en el directorio sql o en una ruta | |
| --name | -n | * Nombre de la base de datos (debería ser igual al nombre de la aplicación, si es de tenencia individual) | |
| --path | -p | * Ruta del directorio que tiene los archivos sql que se ejecutarán en orden alfanumérico ascendente | |
| --config | -c | * Ruta de un archivo json que tiene un objeto con una propiedad "db", con los campos "host", "port", "user", "password", "database" (no use el nombre de la base de datos que quiere crear, use el nombre postgres o cualquier otro usuario de administración). | db-secrets.json |
| --noConfirm | * No pedir confirmación | false | |
| --connectionString | -s | * String de conexión a la Postresql en forma de "postgresql://user:pass@localhost:5432/postgres". Use postgres como base de datos o cualquier base de datos ya existente para ejecutar los comandos (tiene preferencia sobre --config) | |
| --dropDb | * Eliminar (drop) la base de datos destino si existe antes de ejecutar los comandos sql | false | |
| --skipDbCreation | * Omitir la creación de la base de datos | false | |
| new app | n a | Crea una nueva aplicación (cliente, servidor, common y base de datos) | |
| --name | -n | * Nombre de la aplicación en formato kebab-case (palabras en minúsculas separadas por un guion medio) | app-template |
| --noConfirm | * No pedir confirmación | false | |
| --companionAocSrc | * Si es verdadero la aplicación hará referencia al código fuente de aoc en lugar de usar los módulos aoc de node_modules | false | |
| --connectionString | -s | * String de conexión a la Postresql en forma de "postgresql://user:pass@localhost:5432/postgres". Use postgres como base de datos o cualquier base de datos ya existente para ejecutar los comandos | |
| --dropDb | * Eliminar (drop) la base de datos destino si existe antes de ejecutar los comandos sql | false | |
| --skipNpmInstalls | * Omitir la instalación automática de los paquetes node_modules después de haber creado la aplicación | false | |
| --skipDb | * Omitir la creación de la base de datos y cualquier operación relacionada con la base de datos | false |
Puede ver descripciones completas añadiendo --help al final de cada comando.
aoc-cli --help
aoc-cli generate --help
aoc-cli generate entities --help
Por favor, busque en Issues y Discussions en Github para más información
© 2024 Atlantis of Code. All rights reserved.
All trademarks are the property of their respective owners.