Comandos de la CLI de HubSpot

Last updated:

La CLI de HubSpot conecta tus herramientas locales de desarrollo con HubSpot, permitiéndote desarrollar en el CMS de HubSpot con control de versiones, tu editor de texto favorito y varias tecnologías de desarrollo web.

Si eres nuevo en el desarrollo de HubSpot, echa un vistazo a nuestra guía de inicio rápido, donde te guiarás a través de la instalación de la CLI hasta la publicación de una página en vivo.

Quick start to CMS Hub development

Utiliza esta guía como referencia para los comandos disponibles y las opciones de formato de archivo para la herramienta de desarrollo local de HubSpot. Para conocer cómo utilizar estas herramientas, consulta el tutorial de primeros pasos con el desarrollo local

Si lo prefieres, puedes utilizar Yarn ejecutando comandos con el prefijo yarn. No se requiere Homebrew, pero se recomienda para facilitar la instalación.

Instalar

Puedes instalar las herramientas de desarrollo local de HubSpot de forma global (recomendado) o local. Para instalar las herramientas de HubSpot globalmente, en tu línea de comandos ejecuta el siguiente comando.  Más información sobre la instalación de paquetes de forma global o local.

npm install -g @hubspot/cli

Instalar solo en el directorio actual

Para instalar las herramientas solo en tu directorio actual, ejecuta el siguiente comando. No es necesario instalar localmente si ya tienes la CLI instalada globalmente.

npm install @hubspot/cli

¿Se produce un error de EACCES al instalar?
Consulta NPM Resolver errores de permisos EACCESS al instalar paquetes de forma global.

Aumentar de nivel

La CLI se actualiza regularmente. Para actualizar a la última versión de las herramientas locales, ejecuta

npm install -g @hubspot/cli@latest

La CLI ha cambiado de @hubspot/cms-cli a @hubspot/cli. Si todavía estás utilizando el antiguo cms-cli tendrás que desinstalarlo antes de instalar la nueva versión.

Para ver en qué versión estás, ejecuta:

hs --version

Si tu número de versión es inferior a la 3.0.0, estás en la versión antigua.

Para desinstalar la versión antigua ejecuta:

npm uninstall -g @hubspot/cms-cli

Comandos generales

help

Mostrar todos los comandos.

hs help

Para obtener más información sobre un comando específico, introduce el comando y --help.

init

Crea tu archivo hubspot.config.yml en el directorio actual y configura la autenticación de una cuenta. Si estás agregando la autenticación para una nueva cuenta a un archivo de configuración existente, ejecuta el comando auth. Cuando se te pida un nombre para la cuenta, el nombre no puede contener espacios.

hs init

auth

Generar la autenticación de una cuenta de HubSpot utilizando una clave de acceso personal de CMS. Puedes generar tu clave de acceso aquí. Si ya tienes un archivo hubspot.config.yml puedes usar este comando para agregar credenciales para cuentas adicionales. Por ejemplo, puedes utilizar tu cuenta de entorno de pruebas como entorno de desarrollo. Cuando se te pida un nombre para la cuenta, el nombre no puede contener espacios.

hs auth

accounts list

Muestra el nombre, el ID y el tipo de autentificación de cada cuenta en tu archivo de configuración. Si no ves las cuentas que esperas, puede que tengas que ejecutar el comando auth para agregar cuentas a tu archivo de configuración.

hs accounts list

accounts use

Establece la cuenta predeterminada en tu archivo de configuración.

hs accounts use accountNameOrID
Use this table to describe parameters / fields
ParameterDescription
accountNameOrID

Identificar la nueva cuenta predeterminada por su nombre (como se establece en el archivo de configuración) o ID

Interacción con el sistema de archivos del desarrollador

Utilizando la CLI, puedes interactuar con el sistema de archivos del desarrollador, que es el sistema de archivos del Administrador de diseño.

list

Indica los archivos almacenados en el sistema de archivos del desarrollador por ruta o desde la raíz. Funciona de forma similar al uso de ls estándar para ver el directorio actual en tu computadora.

hs ls [path] hs list [path]
ArgumentosDescription
dest
Opcional

Ruta de acceso al directorio del sistema de archivos del desarrollador remoto para el que desea indicar los archivos. Si se omite, el valor predeterminado es la raíz de la cuenta.

fetch

Obtener un archivo, o directorio y sus carpetas y archivos secundarios por ruta.

Esto toma los archivos de tu cuenta de HubSpot y los lleva a tu entorno local. El <src> debe ser la ruta de acceso desde tus herramientas de diseño de HubSpot. El <dest> es el directorio local en el que deseas agregar estos archivos.

Como precaución, la recuperación no sobrescribe por opción predeterminada los archivos locales existentes, puedes utilizar --overwrite cuando desees hacerlo.

hs fetch --account=<name> <src> [dest] hs filemanager fetch --account=<name> <src> [dest]
ArgumentosDescription
src
Requerido

Ruta en las herramientas de diseño de HubSpot

dest
Opcional

Ruta de acceso al directorio local en el que deseas colocar los archivos, en relación con tu directorio de trabajo actual. Si se omite, este argumento será por opción predeterminada tu directorio de trabajo actual.

OpcionesDescription
--account

Especifica un accountId o un nombre para obtenerlo

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

--overwrite

Sobrescribir los archivos existentes con los archivos obtenidos.

--mode

Especifica si se obtiene un borrador o una versión publicada de un archivo de HubSpot. Haz clic aquí para obtener más información

upload

Sube un nuevo activo local a tu cuenta de HubSpot. Los cambios cargados a través de este comando se activarán inmediatamente. 

hs upload --account=<name> <src> <dest> hs filemanager upload --account=<name> <src> <dest>
ArgumentosDescription
src
Requerido

Ruta de acceso al archivo local, relativa a tu directorio de trabajo actual.

dest
Requerido

La ruta en HubSpot Design Tools, puede ser una nueva ruta neta.

OpcionesDescription
--account

Especifica un accountId o un nombre para obtenerlo.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

--mode

Especifica si los archivos subidos se publican en HubSpot. Consulta "modos" para obtener más información.

SubcomandosDescription
filemanager

Sube el directorio src especificado al Administrador de archivos, en lugar de al sistema de archivos del desarrollador en el Administrador de diseño.

Nota: Los archivos subidos se establecerán como públicos, por lo que podrán ser vistos por cualquier persona con la URL. Consulta nuestra documentación de ayuda para obtener más detalles sobre la configuración de la visibilidad de los archivos.

watch

Vigila tu directorio local y sube automáticamente los cambios a tu cuenta de HubSpot al guardar los archivos. Cualquier cambio realizado al guardar se hará efectivo inmediatamente.

Ten en cuenta lo siguiente cuando utilices watch:

  • La eliminación de los archivos vigilados localmente no los eliminará automáticamente de HubSpot. Para eliminar archivos, utiliza --remove.
  • Al cambiar el nombre de una carpeta localmente, se cargará una nueva carpeta en HubSpot con el nuevo nombre. La carpeta existente en HubSpot no se eliminará automáticamente. Para eliminar la carpeta, utiliza --remove.

En el pasado, el comando watch cargaba el directorio actual de inmediato y luego comenzaba a vigilar los cambios. Esto se cambió en la v2.0 a simplemente watch.

hs watch --account=<name> <src> <dest>
ArgumentosDescription
src
Requerido

Ruta de acceso al directorio local en el que se encuentran tus archivos, en relación con tu directorio de trabajo actual

dest
Requerido

La ruta en Herramientas de diseño de HubSpot, puede ser una nueva ruta neta.

OpcionesDescription
--account

Especifica un accountId o un nombre para obtenerlo

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

--mode

Especifica si los archivos subidos se publican o se guardan como borradores en HubSpot. Más información sobre cómo usar modos.

--initial-upload

Hace que se produzca una carga inicial antes de que se hayan guardado los archivos. Admite un alias de -i

--remove

Hará que watch elimine los archivos de tu cuenta de HubSpot que no se encuentren localmente.

--notify=<path/to/file>

registrar en el archivo especificado cuando se desencadena una tarea de vigilancia y después de que los trabajadores se hayan quedado inactivos.

move

Este comando está actualmente en fase beta. Haznos saber si tienes comentarios a través de nuestro slack para desarrolladores o utilizando una inquietud en el github para la CLI.

Mueve los archivos del sistema de archivos del desarrollador de un directorio a otro. No afecta a los archivos almacenados localmente.

hs mv --account=<name> <src> <dest>
ArgumentosDescription
src
Requerido

Ruta de acceso al directorio del sistema de archivos del desarrollador remoto en el que se encuentran tus archivos.

dest
Requerido

Ruta a la que mover los materiales dentro del sistema de archivos del desarrollador.

OpcionesDescription
--account

Especifica un accountId o un nombre para mover los archivos.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

create

Crea la estructura de carpetas/archivos de un nuevo material.

hs create <type> <name> [dest]
ArgumentosDescription
type
Requerido

Tipo de material. Tipos admitidos:

name
Requerido

El nombre del material nuevo

dest
Opcional

La carpeta de destino para el nuevo material, relativa a tu directorio de trabajo actual. Si se omite, se utilizará por opción predeterminada el directorio de trabajo actual.

remove

Elimina archivos, o carpetas y sus archivos, de tu cuenta de HubSpot. Esto no elimina los archivos y carpetas almacenados localmente. Este comando tiene un alias de rm.

hs remove --account=<name> <path>
ArgumentosDescription
path
Requerido

Ruta en las herramientas de diseño de HubSpot

OpcionesDescription
--account

Especifica un accountId o un nombre para eliminar un archivo.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

Comandos de HubDB

Los comandos de HubDB están actualmente en la versión preliminar para desarrolladores. Ya están disponibles para su uso, pero entiende que están sujetos a cambios.  Las versiones preliminares para desarrolladores están sujetas a nuestros términos de beta para desarrolladores.

Utiliza estos comandos para crear, eliminar, recuperar y borrar todas las filas de una tabla de HubDB. La cuenta de HubSpot debe tener acceso a HubDB para utilizar estos comandos.

Crear tabla de HubDB

Crea una nueva tabla de HubDB en la cuenta de HubSpot. 

hs hubdb create <src>
ArgumentosDescription
src
Requerido

El archivo JSON local que se utilizará para generar la tabla de HubDB.

OpcionesDescription
--account

Especifica un accountId o nombre para crear HubDB.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

Recuperar la tabla de HubDB

Descarga los datos de una tabla de HubDB en tu ordenador.

hs hubdb fetch <tableId> <dest>
ArgumentosDescription
tableId
Requerido

ID de la tabla HubDB que se encuentra en el panel de HubDB.

dest

El destino de la ruta local para almacenar el hubdb.json archivo.

OpcionesDescription
--account

Especifica un accountId o un nombre para obtener HubDB.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

Borrar filas en una tabla de HubDB

Borra todas las filas de una tabla de HubDB.

hs hubdb clear <tableId>
ArgumentosDescription
tableId
Requerido

ID de la tabla HubDB que se encuentra en el panel de HubDB.

OpcionesDescription
--account

Especifica un accountId o un nombre para borrar las filas de HubDB.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

Eliminar la tabla de HubDB

Elimina la tabla de HubDB especificada de la cuenta.

hs hubdb delete <tableId>
ArgumentosDescription
tableId
Requerido

ID de la tabla HubDB que se encuentra en el panel de HubDB.

OpcionesDescription
--account

Especifica un accountId o nombre para eliminar HubDB.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

Tabla JSON de HubDB

Cuando obtienes un HubDB los datos se almacenan como tablename.hubdb.json. Cuando se crea una nueva tabla se debe especificar un archivo JSON de origen. A continuación se muestra un ejemplo de tabla en formato JSON.

// store_locations.hubdb.json { "name": "store_locations", "useForPages": true, "label": "Store locations", "allowChildTables": false, "allowPublicApiAccess": true, "dynamicMetaTags": { "DESCRIPTION": 3, "FEATURED_IMAGE_URL": 7 }, "enableChildTablePages": false, "columns": [ { "name": "name", "label": "Name", "type": "TEXT" }, { "name": "physical_location", "label": "Physical Location", "type": "LOCATION" }, { "name": "street_address", "label": "Street address", "type": "TEXT" }, { "name": "city", "label": "City", "type": "TEXT" }, { "name": "state", "label": "State", "options": [ { "id": 1, "name": "Wisconsin", "type": "option", "order": null }, { "id": 2, "name": "Minnesota", "type": "option", "order": null }, { "id": 3, "name": "Maine", "type": "option", "order": null }, { "id": 4, "name": "New York", "type": "option", "order": null }, { "id": 5, "name": "Massachusetts ", "type": "option", "order": null }, { "id": 6, "name": "Mississippi", "type": "option", "order": null }, { "id": 7, "name": "Arkansas", "type": "option", "order": null }, { "id": 8, "name": "Texas", "type": "option", "order": null }, { "id": 9, "name": "Florida", "type": "option", "order": null }, { "id": 10, "name": "South Dakota", "type": "option", "order": null }, { "id": 11, "name": "North Dakota", "type": "option", "order": null }, { "id": 12, "name": "n/a", "type": "option", "order": null } ], "type": "SELECT", "optionCount": 12 }, { "name": "phone_number", "label": "Phone Number", "type": "TEXT" }, { "name": "photo", "label": "Store Photo", "type": "IMAGE" } ], "rows": [ { "path": "super_store", "name": "Super Store", "isSoftEditable": false, "values": { "name": "Super Store", "physical_location": { "lat": 43.01667, "long": -88.00608, "type": "location" }, "street_address": "1400 75th Greenfield Ave", "city": "West Allis", "state": { "id": 1, "name": "Wisconsin", "type": "option", "order": 0 }, "phone_number": "(123) 456-7890" } }, { "path": "store_123", "name": "Store #123", "isSoftEditable": false, "values": { "name": "Store #123", "physical_location": { "lat": 32.094803, "long": -166.85889, "type": "location" }, "street_address": "Pacific Ocean", "city": "at sea", "state": { "id": 12, "name": "n/a", "type": "option", "order": 11 }, "phone_number": "(123) 456-7891" } } ] }

Funciones sin servidor

Utiliza estos comandos para crear y depurar funciones sin servidor (solo CMS Hub Enterprise).

indicar funciones

Imprime una lista de todas las funciones de la cuenta, sus puntos finales, métodos, los nombres de los secretos que utilizan y la última fecha de actualización.

hs functions ls --account=<name> hs functions list --account=<name>
ArgumentosDescription
--account

El apodo de la cuenta de HubSpot de tu hubspot.config. Este parámetro es necesario si no tienes una defaultAccount en tu hubspot.config.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

--compact

muestra solo los nombres de los puntos de terminación y los métodos.

--json

Salida JSON en la línea de comandos con los datos de todas las funciones. Los datos JSON incluyen, el id del portal, el id de la función, la ruta, la ruta de materiales sin procesar, el método, los secretos, las fechas de creación y de última modificación.

registros

Imprime un registro de su función sin servidor. Muestra cualquier console.logs contenido dentro de tu función después de la ejecución. Los registros también incluyen el tiempo de ejecución. Los registros se conservan durante 90 días. 

hs logs <endpoint-name> --account=<name> --follow
ArgumentosDescription
endpoint-name
Requerido

El nombre del punto de terminación definido en tu archivo serverless.json. No es la ruta de acceso a tu archivo de funciones.

OpcionesDescription
--file

Envía los registros a function.log

--follow

Sigue los registros para obtener una actualización en vivo mientras ejecuta tus funciones sin servidor.

--latest

Envía solo el registro más reciente

--account

El apodo de la cuenta de HubSpot de tu hubspot.config. Este parámetro es necesario si no tienes un defaultPortal en su hubspot.config.

Admite un alias de --portal para la compatibilidad con versiones anteriores de la CLI.

--compact

oculta la salida/información del registro. Devuelve éxito/error y tiempo de ejecución.

--limit=<number>

 limitar la cantidad de registros mostrados en la salida

Si recibes este error: A server error occurred: WARNING: The logs for this function have exceeded the 4KB limit, tu registro es demasiado grande. Esto puede ser causado por tratar de registrar en la consola un objeto muy grande, o por muchos de registros de consola separados. Para resolver esto, reduce la cantidad que estás tratando de registrar, alcanza tu punto de terminación, y luego ejecuta el comando de nuevo.

agregar secreto

Agrega un secreto a tu cuenta que puede ser utilizado dentro de las funciones sin servidor. Después de ejecutar el comando se te pedirá que introduzcas el valor del secreto.

Para exponer el secreto a tu función, actualiza tu archivo serverless.json con el nombre del secreto, ya sea para los puntos de terminación específicos en los que quieras usarlo o globalmente para que esté disponible para todos.

hs secrets add <secret-name>
ArgumentosDescription
secret-name
Requerido

Nombre del secreto.

secret-value
Requerido

El valor del secreto (detalle de autenticación, o de otro modo).

secreto de actualización

Actualiza el valor de un secreto en tu cuenta que puede ser utilizado dentro de las funciones sin servidor. A continuación, se te pedirá que introduzcas el valor del secreto.

hs secrets update <secret-name>
ArgumentosDescription
secret-name
Requerido

Nombre del secreto.

secret-value
Requerido

El valor del secreto (detalle de autenticación, o de otro modo).

eliminar secreto

Elimina un secreto de tu cuenta, haciendo que ya no se pueda utilizar dentro de las funciones sin servidor. Después de ejecutar este comando, edita tu archivo serverless.json para eliminar el nombre del secreto.

hs secrets delete <secret-name>
ArgumentosDescription
secret-name
Requerido

Nombre del secreto que deseas eliminar.

enumerar secretos

Enumera los secretos dentro de tu cuenta para saber qué has almacenado ya utilizando el comando de agregar secretos.

hs secrets list

Abrir los accesos directos del navegador

Hay muchas partes de la aplicación de HubSpot a las que los desarrolladores necesitan acceder con frecuencia. Para facilitar el acceso a estas herramientas, puede abrirlas directamente desde la línea de comandos. Tu argumento defaultAccount o --account se utilizará para abrir la herramienta asociada a esa cuenta.

abiertos

hs open <shortcut-name or alias>
ArgumentosDescription
shortcut
Requerido

Proporciona el nombre completo del atajo o el alias del atajo que deseas abrir en tu navegador.

hs open --list
ArgumentosDescription
--list
Requerido

Enumera todos los accesos directos, sus alias y destinos.

Finalización de comando

Si utilizas la CLI con frecuencia, puede ser útil poder tabular para autocompletar comandos.

hs completion >> ~/.bashrc

Para Mac OS X

hs completion >> ~/.bash_profile

Formato de la plantilla local

Para conocer las anotaciones del formato de la plantilla local, consulta la documentación de las plantillas y ve las plantillas en el boilerplate del tema CMS

Formato del módulo local

Los módulos locales están formateados en una serie de archivos, cada uno de los cuales especifica varios componentes de un módulo. Para aprender a desarrollar módulos localmente, consulta la Referencia sobre el desarrollo de módulos locales.

.hsignore

Puedes incluir un archivo .hsignore en tu proyecto para especificar los archivos que no deben tener seguimiento cuando se utiliza la CLI. Este archivo funciona de forma similar a como lo hacen los archivos .gitignore.   Los archivos que coinciden con los patrones especificados en el archivo .hsignore no se subirán a HubSpot cuando se utilicen los comandos upload o watch.

Por opción predeterminada hay algunas reglas que HubSpot aplica automáticamente. No hay forma de anular estos valores predeterminados.

Los siguientes son siempre ignorados:

  • hubspot.config.yml/hubspot.config.yaml
  • node_modules - dependencias
  • .* - archivos/carpetas ocultos
  • *.log - registro de errores de NPM
  • *.swp - archivo de intercambio para el estado de Vim
  • Icon\\r - icono personalizado del Finder de Mac OS
  • __MACOSX - bifurcación de recursos de Mac
  • ~ archivo de copia de seguridad de Linux
  • Thumbs.db - caché de archivos de imagen de Windows
  • ehthumbs.db - archivo de configuración de la carpeta de Windows
  • Desktop.ini - información de atributos de carpetas personalizadas de Windows
  • @eaDir - carpeta "oculta" de Windows Synology diskstation donde el servidor almacena las miniaturas.
Shell script
# ignore all files within a specific directory
/ignore/ignored
# ignore a specific file
/ignore/ignore.md
# ignore all .txt files
*.txt
# ignore all log files - useful if you commonly output serverless function logs as files.
*.log

Modes

La opción --mode permite determinar si los cambios locales se publican cuando se suben a HubSpot. Esta opción puede utilizarse en cada comando o establecerse por opción predeterminada en tu archivo hubspot.config.yml .

Las dos opciones para --mode son --mode=draft y --mode=publish.

El siguiente es el orden de precedencia para configurar --mode:

  1. El uso de --mode en un comando anulará todos los demás ajustes.
  2. Al establecer un defaultMode para cada cuenta en tu archivo hubspot.config.yml, se elimina la necesidad de utilizar --mode  en cada comando. Anulará la configuración de nivel superior.
  3. Estableciendo un defaultMode en el nivel superior de tuarchivo hubspot.config.yml, establece un modo por defecto para todas las cuentas. Anulará el comportamiento predeterminado.
  4. El comportamiento predeterminado de --mode es publicar

Autentificación

El archivo hubspot.config.yml  contiene las credenciales de tus cuentas de HubSpot. Consulta la Guía de los primeros pasos para la configuración, o ejecuta el comando auth para actualizar un archivo de configuración existente

Si ejecutaste hs init mientras utilizabas la versión v1.0.10 (publicada el 10 de marzo de 2020) hasta la v1.0.11 de la CLI, tu archivo de configuración se encuentra en /Users//hubspot<username>.config.yml.

Hemos vuelto a colocar tu archivo de configuración en la carpeta desde la que ejecutaste el comando, para que sea obvio dónde está el archivo. No tienes que mover tu archivo de configuración, seguirá funcionando bien. Si prefieres mantener tu archivo con los archivos de tu proyecto, es seguro mover tu archivo de este directorio a tu carpeta de proyecto. No envíes este archivo al control de versiones, ya que contiene tus credenciales de autentificación.

Si ejecutaste el comando usando cualquier otra versión del CMS-CLI, tu archivo de configuración se coloca en la carpeta desde la que ejecutaste el comando.

defaultPortal: DEV portals: # Sample apikey entry, manually entered - name: DEV portalId: 123 defaultMode: 'publish' authType: apikey apiKey: xxxxxx-xxxxx-xxxxx-xxxxx-xxxxx # Sample personal access key entry, generated from running hs auth personalaccesskey or hs init - name: PROD portalId: 456 authType: personalaccesskey personalAccessKey: >- xxxxx-xxxxxx-xxxxxxx-xxxxxx-xxxxx-xxxxxxx-xxxxxxxx auth: tokenInfo: accessToken: >- xxxxx-xxxxxx-xxxxxxx-xxxxxx-xxxxx-xxxxxxx-xxxxxxxx expiresAt: '2020-01-01T00:00:00.000Z'

Parámetros de configuración de nivel superior

NombreDescription
defaultPortal
opcional

Sustituye la necesidad de ejecutar comandos con --account= para especificar con qué cuenta se está interactuando. Si --account= no se especifica al ejecutar un comando, el defaultPortal se utilizará.

defaultMode
opcional

Qué modo debe utilizarse para una cuenta, borrador o publicación. 

allowUsageTracking
opcional

Especifica si HubSpot tiene permiso para hacer seguimiento del uso de las herramientas de desarrollo local. El valor predeterminado es true. Establecer false para desactivar todo el seguimiento

Parámetros de configuración de la cuenta

NombreDescription
portalId
obligatorio

El ID de la cuenta para la que estás configurando la autenticación.

authType
obligatorio

Qué forma de autenticación está utilizando una entrada determinada. personalaccesskey o apikey. NOTA: Además, debes establecer un parámetro de configuración para el valor de tus métodos de autenticación. Consulta el archivo de configuración de ejemplo anterior para saber cómo establecer tu personalAccessKey o apiKey además de especificar el authType.

name
opcional

Un medio para especificar el nombre de una cuenta, que puede utilizarse para indicar con qué cuenta debe interactuar un comando. Ejemplo: --account=123 y --account=DEV interactuarán con la cuenta ID 123 según el ejemplo anterior. Este nombre no puede contener espacios.

defaultMode
opcional

Qué modo debe utilizarse para una cuenta, borrador o publicación. 

Environment variables

La CLI de HubSpot soporta el uso de variables de entorno, esto puede ser especialmente útil cuando se crean automatizaciones como una Acción GitHub.

Ejecuta cualquier comando utilizando la bandera --use-env para utilizar las variables de entorno en lugar del hubspot.config.yml.

hs upload example-project example-project-remote --use-env
NombreDescription
HUBSPOT_PORTAL_ID
Requerido

El ID de la cuenta de HubSpot.

HUBSPOT_PERSONAL_ACCESS_KEY
Recomendado

La clave de acceso personal de un usuario en la cuenta de HubSpot. Todas las actualizaciones realizadas se asociarán a este usuario.

HUBSPOT_API_KEY

La clave de API de HubSpot asociada a la cuenta de HubSpot.

HUBSPOT_CLIENT_ID

El ID del cliente OAuth.

HUBSPOT_CLIENT_SECRET

El secreto de OAuth.

Nota: a partir del 30 de noviembre de 2022, las claves de API de HubSpot ya no podrán usarse como un método de autenticación para acceder a las API de HubSpot. Además, a partir del 15 de julio de 2022, las cuentas sin una clave de API de HubSpot ya generada ya no podrán crear una.

En cambio, deberás usar un token de acceso a aplicaciones privadas o usar OAuth para autenticar llamadas de API. Más información sobre este cambio y cómo migrar una integración de claves de API para usar una aplicación privada.

Validación de materiales del mercado

 La CLI ofrece un conjunto de pruebas automatizadas que puedes realizar en tus materiales para que se ajusten a los requisitos del mercado antes de enviarlos. Pasar todas las pruebas automatizadas no significa que vayas a pasar con seguridad el proceso de revisión, se realizan más revisiones para garantizar la calidad más allá de lo que se puede automatizar fácilmente.

Validar el tema

El comando de validación de temas te permite ejecutar rápidamente pruebas automatizadas en tu tema para identificar los problemas que deben ser corregidos antes de su envío al mercado de materiales. Estos serán devueltos en tu CLI como una lista de mensajes de [error] y [éxito] separados en grupos que representan tipos de materiales dentro de un tema.

hs theme marketplace-validate <src>
ArgumentosDescription
src
Requerido

Ruta de acceso a la carpeta local del tema, relativa a tu directorio de trabajo actual.


¿Te resultó útil este artículo?
Con este formulario puedes enviar tu opinión sobre nuestros documentos para desarrolladores. Si tienes comentarios sobre el producto de HubSpot, puedes enviarlos al Foro de ideas.