@modyo/cli

Modyo CLI Command line to expose local development tools

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@modyo/cli
3.1.273 months ago5 years agoMinified + gzip package size for @modyo/cli in KB

Readme

Modyo Cli (modyo-cli)
=========
La interfaz de línea de comandos de Modyo (CLI) es una herramienta de línea de comandos basada en dos principios de aceleración e integración, y estos principios tienen un comando get y push respectivamente.
English, Spanish
npm (scoped) NPM Coverage

Introducción

Primero, necesita traer la CLI de Modyo en su máquina local para tener disponible el comando modyo-cli, esto le permitirá inicializar un proyecto con algunas decisiones arquitectónicas de front-end ya tomadas, o usar para inicializar un widget desde catálogo si tiene acceso.
Para usar el CLI de Modyo, tiene las siguientes opciones.
Instalación global en su maquina local
npm i -g @modyo/cli #via npm
yarn global add @modyo/cli #via yarn

Este comando hará que el comando modyo-cli esté disponible en la sesión de terminal globalmente

A través de NPX, sin instalación
npx @modyo/cli #via npx
npx @modyo/cli@version #via npx - versión específica

Uso

Los comandos disponibles son get, push y help
- Introducción - Uso
- [`modyo-cli (-v|--version|version)`](#modyo-cli--v--versionversion)
- [`modyo-cli help [COMMAND]`](#modyo-cli-help-command)
- [`modyo-cli get NAME [DIRECTORY]`](#modyo-cli-get-name-directory)
- [`modyo-cli push NAME`](#modyo-cli-push-name)

modyo-cli (-v|--version|version)

Disponibiliza la versión del modyo-cli
$ modyo-cli (-v|--version|version)
modyo-cli/3.0.6 darwin-x64 node-v12.13.1

modyo-cli help [COMMAND]

USAGE
  $ modyo-cli help [COMMAND]

ARGUMENTS
  get   Pull a widget from our catalog into a new directory
  help  Display help for modyo-cli
  push  Push widget to Modyo platform

modyo-cli get NAME [DIRECTORY]

En general, el comando get se usa para obtener una plantilla de widget. Si tiene un token proporcionado por Modyo, puede usar el mismo comando para extraer cualquiera de nuestros widgets premium de nuestra Biblioteca de widgets:
USAGE
  $ modyo-cli get NAME [DIRECTORY]

ARGUMENTS
  NAME       The name of the widget
  DIRECTORY  Name of directory to init

OPTIONS
  -f, --force                      Override folder if it exist
  -h, --help                       Output usage information
  -o, --organization=organization  [default: modyo] Github Organization
  -x, --no-install                 Don't install packages

EXAMPLE
  $ modyo-cli get name [directory]

>Hay algunas plantillas de widgets públicos a los que se puede acceder a través de este comando >El CLI de Modyo está diseñado para funcionar en base a una arquitectura de micro front-end y acelerará el proceso de inicialización de un widget, con decisiones modyo.
EJEMPLOS
  $ modyo-cli get modyo-widgets-template-vue [DIRECTORY] #to initialize a widget
  $ modyo-cli get modyo-widgets-project-vue [DIRECTORY] #to initialize a base project library

>Desde este comando y en adelante, puede continuar utilizando el widget como cualquier otro widget vue-cli.
Su organización puede crear sus propias plantillas personalizadas para inicializar nuevos widgets y utilizarlas con la opción organization
EXAMPLE
$ modyo-cli get --organization=myOrganization my-custom-template-repo [DIRECTORY]
$ modyo-cli get -o myOrganization my-custom-template-repo [DIRECTORY]

modyo-cli push NAME

El comando push es el encargado del principio de integración, utilizado para enviar el widget al sitio seleccionado en la plataforma modyo.
Utilizará un argumento llamado nombre para cargar el widget en la plataforma y algunos indicadores requeridos como token sitebase id o host para identificar la plataforma ®Modyo que aloja el widget y tienen un indicador adicional para evitar el flujo de proceso manual de la publicación del widget.
USAGE
  $ modyo-cli push NAME

ARGUMENTS
  NAME  The name of the widget

OPTIONS
  -b, --build-command=build-command                 [default: build] Build command in package.json
  -d, --build-directory=build-directory             [default: dist] Build directory path
  -l, --disable-liquid                              Disable liquid parse in Modyo for all the files
  -f, --disable-liquid-regex=disable-liquid-regex   Disable liquid parse in Modyo for all the files that match a regex
  -h, --help                                        Output usage information
  -i, --site-id=site-id                             Id of the site where the widget will be pushed
  -n, --site-host=site-host                         Host of the site where the widget will be pushed
  -p, --publish                                     Force widget publication
  -t, --token=token                                 (required) Modyo Api token
  -u, --account-url=account-url                     (required) URL of your ®Modyo account ex("https://account.modyo.com")
  -v, --version=8|9                                 [default: 9] Version of Modyo platform

EXAMPLE
  $ modyo-cli push <NAME>

>Muchas de las opciones se pueden definir como variables de entorno o dentro de un archivo .env que se recomienda para evitar la publicación en el registro de github porque puede contener información delicada
MODYO_BUILD_DIRECTORY=buildDirectoryPath
MODYO_VERSION=version
MODYO_TOKEN=token
MODYO_ACCOUNT_URL=account-url
MODYO_SITE_ID=siteId
MODYO_SITE_HOST=siteHost
MODYO_BUILD_COMMAND=buildCommand
MODYO_REGEX_EXCLUDE=regexToExcludeFiles
MODYO_DISABLE_LIQUID_REGEX=regexToDisableLiquidOnFiles