Skip to content

Latest commit

 

History

History
209 lines (108 loc) · 5.29 KB

README-ES.md

File metadata and controls

209 lines (108 loc) · 5.29 KB

masv-portal

English

Nombre

masv-portal -- Una herramienta de línea de comandos para listar, crear y eliminar Portales MASV.

Tabla de contenidos

Sinopsis

masv-portal ls [ --team ID-del-equipo ] [IDs o subdominios ...]

masv-portal new --subdomain subdominio --name nombre --message mensaje --recipients destinatarios [...] [ --access_code código de acceso ] [ --download_password contraseña de descarga ] [ --tag etiqueta ]

masv-portal rm ID [...]

Requisitos

Para usar esta herramienta, necesitarás lo siguiente:

  • Node.js, versión 18.19.0 o posterior
  • npm, versión 9.2.0 o posterior

Configuración

Antes de usar masv-portal, configura tus credenciales de MASV. Puedes hacerlo con variables de entorno o un archivo .env en el mismo directorio que la herramienta masv-portal. Consulta Entorno y Archivos.

Descripción

La herramienta masv-portal lista, crea y elimina Portales MASV. Te ofrece una forma de automatizar tu flujo de trabajo de transferencia de archivos.

Y es de código abierto y extensible, así que puedes agregar otras órdenes, opciones y mejoras.

Opciones globales

Estas opciones están disponibles para todos los comandos:

-v, --verbose

Muestra información de diagnóstico en la salida de error estándar.

-V, --version

Muestra la versión de esta herramienta.

-h, --help

Muestra información de uso. También puedes usar esta opción con cada comando.

masv-portal ls

Lista los Portales en tu equipo. Para cada ID de Portal o subdominio coincidente, muestra el ID del Portal, la fecha de creación, la etiqueta y el subdominio. Sin IDs o subdominios, lista todos los Portales en un equipo.

-t ID, --equipo ID

Opcional. Sustituye el ID de equipo especificado por MASV_TEAM. La clave API que utilices debe darte acceso a este equipo.

masv-portal new

Crea uno o más Portales nuevos.

--subdomain subdominio

Requerido. El subdominio debe ser único entre todos los subdominios en MASV, no solo en tu Equipo.

--name nombre

Requerido. Un nombre amigable para el Portal.

--message mensaje

Requerido. Una descripción corta y amigable del Portal.

--recipients destinatario [...]

Requerido. Una lista de una o más direcciones de correo electrónico.

-t ID, --team ID

Opcional. Sustituye el ID de equipo especificado por MASV_TEAM. La clave API que utilices debe darte acceso a este equipo.

--access_code código_de_acceso

Opcional. Contraseña para acceder a la página del Portal.

--download_password contraseña_de_descarga

Opcional. Contraseña para descargar paquetes de este Portal.

--tag etiqueta

Opcional. Nombre de la etiqueta para asociar con paquetes que se cargan en este Portal. Si la etiqueta no existe para este Equipo, MASV la creará.

masv-portal rm

Elimina Portales con IDs coincidentes.

Advertencia: Esto no se puede deshacer.

Entorno

Si las siguientes variables no están configuradas en el entorno, entonces la herramienta utiliza sus definiciones en el archivo .env.

MASV_API_KEY

Una clave API que has creado.

MASV_TEAM

El Equipo predeterminado a utilizar. El usuario MASV asociado con la API debe ser miembro de este equipo. La opción -t sobrescribe esta variable.

Archivos

.env

Un archivo de entorno en el mismo directorio que esta herramienta. Define las variables de entorno que utiliza esta herramienta.

Un ejemplo de archivo .env:

MASV_API_KEY=CLAVEEJEMPLO123
MASV_TEAM=IDEQUIPOEJEMPLO321

Estado de salida

0

Éxito.

1

Ocurrió un error. La herramienta también muestra un mensaje de error en la salida de error estándar.

Ejemplos

Listar todos los Portales:

masv-portal ls

Crear un Portal llamado "Mi nuevo portal" con el subdominio "minuevoportal" y [email protected] como destinatario. Usa la etiqueta del Portal para registrar un número de trabajo, JOB-2024-03:

masv-portal new \
--name "Mi nuevo portal" \
--message "¡Bienvenido a mi nuevo Portal!"  \
--subdomain minuevoportal \
--recipients "[email protected]" \
--tag "JOB-2024-03"

Eliminar un Portal:

masv-portal rm E1XSATMHPWLSESDJFQHGW4HKHJ

Eliminar un Portal con etiqueta JOB-2024-03:

masv_portal rm $(node . ls | awk '$3=="\"JOB-2024-03\"" { print $1 }')

Obtener ayuda

Algunos enlaces útiles para aprender más sobre cómo trabajar con los Portales MASV:


Hecho con ♥ en Canadá