Comandos de la CLI de HubSpot

Last updated: mayo 4, 2023

Use this table to describe parameters / fields
Parameter	Description
`accountNameOrID`	Identificar la nueva cuenta predeterminada por su nombre (como se establece en el archivo de configuración) o ID


Argumentos	Description
`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.


Argumentos	Description
`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.


Opciones	Description
`--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


Argumentos	Description
`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.


Opciones	Description
`--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.


Subcomandos	Description
`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.

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.


Argumentos	Description
`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.


Opciones	Description
`--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.


Argumentos	Description
`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.


Opciones	Description
`--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.


Argumentos	Description
`type` Requerido	Tipo de material. Los tipos admitidos incluyen: `module` `template` `website-theme` `function` `webpack-serverless` `react-app` `vue-app`
`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.


Argumentos	Description
`path` Requerido	Ruta en las herramientas de diseño de HubSpot


Opciones	Description
`--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.


Argumentos	Description
`src` Requerido	El archivo JSON local que se utilizará para generar la tabla de HubDB.


Opciones	Description
`--account`	Especifica un `accountId` o nombre para crear HubDB. Admite un alias de `--portal` para la compatibilidad con versiones anteriores de la CLI.


Argumentos	Description
`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.


Opciones	Description
`--account`	Especifica un `accountId` o un nombre para obtener HubDB. Admite un alias de `--portal` para la compatibilidad con versiones anteriores de la CLI.


Argumentos	Description
`tableId` Requerido	ID de la tabla HubDB que se encuentra en el panel de HubDB.


Opciones	Description
`--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.


Argumentos	Description
`tableId` Requerido	ID de la tabla HubDB que se encuentra en el panel de HubDB.


Opciones	Description
`--account`	Especifica un `accountId` o nombre para eliminar HubDB. Admite un alias de `--portal` para la compatibilidad con versiones anteriores de la CLI.

// 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" } } ] }


Argumentos	Description
`--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.
`--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.


Argumentos	Description
`endpoint-name` Requerido	El nombre del punto de terminación definido en tu archivo serverless.json (no es la ruta al archivo de función).
`--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


Argumentos	Description
`secret-name` Requerido	Nombre del secreto.
`secret-value` Requerido	El valor del secreto (detalle de autentificación, o de otro modo).


Argumentos	Description
`secret-name` Requerido	Nombre del secreto.
`secret-value` Requerido	El valor del secreto (detalle de autentificación, o de otro modo).


Argumentos	Description
`secret-name` Requerido	Nombre del secreto que deseas eliminar.


Argumentos	Description
`shortcut` Requerido	Proporciona el nombre completo del atajo o el alias del atajo que deseas abrir en tu navegador.


Argumentos	Description
`--list` Requerido	Enumera todos los accesos directos, sus alias y destinos.

Use this table to describe parameters / fields
Parameter	Description
`--theme-path` Requerido	Ruta a un tema en el Administrador de diseño.
`--verbose`	Cuando se excluye este parámetro, la puntuación devuelta es una media de todas las plantillas del tema (predeterminado). Cuando se incluye este parámetro, se muestran las puntuaciones de las plantillas individuales. También recibirás enlaces de informes de Lighthouse para cada plantilla.
`--target`	Esto puede ser de escritorio o móvil para ver las puntuaciones respectivas. Por opción predeterminada, el destino es el escritorio.

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

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:

El uso de --mode en un comando anulará todos los demás ajustes.
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.
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.
El comportamiento predeterminado de --mode es publicar

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'


Nombre	Description
`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


Nombre	Description
`portalId` obligatorio	El ID de la cuenta para la que estás configurando la autentificación.
`authType` obligatorio	Qué forma de autenticación está utilizando una entrada determinada. `personalaccesskey` o `apikey`. NOTA: debes establecer un parámetro de configuración para el valor de tus métodos de autentificació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.


Nombre	Description
`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_CLIENT_ID`	El ID del cliente OAuth.
`HUBSPOT_CLIENT_SECRET`	El secreto de OAuth.

Nota: desde el 30 de noviembre de 2022, las claves de API de HubSpot están obsoletas y ya no son compatibles. El uso continuado de las claves de API de HubSpot es un riesgo de seguridad para tu cuenta y tus datos. Durante esta fase de obsolescencia, HubSpot puede desactivar tu clave en cualquier momento.

En su lugar, debes autentificarte usando un token de acceso de una aplicación privada u OAuth. Más información sobre este cambio y cómo migrar una integración de claves de API para usar una aplicación privada en su lugar.

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.

Antes de poder validar un tema, primero deberás cargarlo a tu cuenta con hs upload. Luego, ejecuta el siguiente comando para validar el tema cargado.


Argumentos	Description
`src` Requerido	Ruta relativa de raíz a la carpeta de tema en el administrador de diseño.


Argumentos	Description
`src` Requerido	Ruta relativa de raíz a la carpeta de módulo en el administrador de diseño.

Comparte tu opinión

¿Te resultó útil este artículo? Sí No

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.

Apps & Integrations

CMS

References

Community

App Marketplace New

CMS Asset Marketplace

App Partner Program

CMS Reference Docs

Comandos de la CLI de HubSpot

Instalar

Instalar solo en el directorio actual

Aumentar de nivel

Comandos generales

help

init

auth

accounts list

accounts use

Interacción con el sistema de archivos del desarrollador

list

fetch

upload

watch

move

create

remove

Comandos de HubDB

Crear tabla de HubDB

Recuperar la tabla de HubDB

Borrar filas en una tabla de HubDB

Eliminar la tabla de HubDB

Tabla JSON de HubDB

Funciones sin servidor

Crear una función

Mostrar lista de funciones

Get logs

Agregar un secreto

Actualizar un secreto

Eliminar un secreto

Mostrar lista de secretos

Abrir los accesos directos del navegador

abiertos

Finalización de comando

Evaluar temas y plantillas para SEO y accesibilidad

Formato de la plantilla local

Formato del módulo local

.hsignore

Modes

Autentificación

Parámetros de configuración de nivel superior

Parámetros de configuración de la cuenta

Environment variables

Validación de materiales del mercado

Validar el tema

Validar módulo

Comparte tu opinión