Commandes d'ILC HubSpot

Last updated:

L'ILC HubSpot connecte vos outils de développement locaux à HubSpot, ce qui vous permet de développer sur le CMS HubSpot avec le contrôle de version, votre éditeur de texte préféré et diverses technologies de développement web.

Si vous êtes novice en matière de développement sur HubSpot, consultez notre guide de démarrage rapide qui vous accompagnera de l'installation de l'ILC à la publication d'une page réelle.

Quick start to CMS Hub development

Utilisez ce guide comme référence pour les commandes disponibles et les options de formatage des fichiers pour l'outil de développement local de HubSpot. Pour une présentation de l'utilisation de ces outils, consultez le tutoriel sur l'initiation au développement local. 

Vous pouvez également utiliser Yarn en exécutant des commandes comprenant le préfixe yarn. Homebrew n'est pas obligatoire, mais recommandé pour faciliter l'installation.

Installer

Vous pouvez installer les outils de développement local HubSpot de manière globale (recommandé) ou locale. Pour installer les outils HubSpot de manière globale, dans votre ligne de commande, exécutez la commande ci-dessous.  En savoir plus sur l'installation globale ou locale des paquets.

npm install -g @hubspot/cli

Installer uniquement dans le répertoire actuel

Pour installer les outils uniquement dans votre répertoire actuel à la place, exécutez la commande ci-dessous. Il n'est pas nécessaire de procéder à une installation locale si l'ILC est déjà installée globalement.

npm install @hubspot/cli

Vous obtenez une erreur EACCES lors de l'installation ?
Voir NPM Résoudre les erreurs de permissions EACCESS lors de l'installation globale de paquets.

Mise à niveau

L'ILC est mise à niveau régulièrement. Pour passer à la dernière version des outils locaux, exécutez :

npm install -g @hubspot/cli@latest

L'ILC est passée de @hubspot/cms-cli à @hubspot/cli. Si vous utilisez toujours cms-cli, vous devrez le désinstaller avant d'installer la nouvelle version.

Pour voir quelle version vous utilisez, exécutez :

hs --version

Si votre numéro de version est inférieur à 3.0.0, vous êtes sur l'ancienne version.

Pour désinstaller l'ancienne version, exécutez :

npm uninstall -g @hubspot/cms-cli

Commandes générales

help

Afficher toutes les commandes.

hs help

Pour en savoir plus sur une commande spécifique, saisissez la commande suivie de --help.

init

Crée votre fichier hubspot.config.yml dans le répertoire actuel et configure l'authentification pour un compte. Si vous ajoutez l'authentification pour un nouveau compte à un fichier de configuration existant, exécutez la commande auth. Le nom requis pour le compte ne doit pas contenir d'espaces.

hs init

auth

Générer une authentification pour un compte HubSpot en utilisant une clé d'accès CMS personnelle. Vous pouvez générer votre clé d'accès ici. Si vous avez déjà un fichier hubspot.config.yml, vous pouvez utiliser cette commande pour ajouter des identifiants pour des comptes supplémentaires. Par exemple, vous pouvez utiliser votre compte sandbox comme environnement de développement. Le nom requis pour le compte ne doit pas contenir d'espaces.

hs auth

accounts list

Liste le nom, l'ID, et le type d'authentification pour chaque compte dans votre fichier de configuration. Si vous ne voyez pas les comptes attendus, vous devrez peut-être exécuter la commande auth pour ajouter des comptes à votre fichier de configuration.

hs accounts list

accounts use

Définissez le compte par défaut dans votre fichier de configuration.

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

Identifier le nouveau compte par défaut par son nom (tel que défini dans le fichier de configuration) ou son ID

Interagir avec le système de fichiers du développeur

À l'aide de l'ILC, vous pouvez interagir avec le système de fichiers du développeur, qui est le système de fichiers du gestionnaire de conception.

list

Liste les fichiers stockés dans le système de fichiers du développeur par chemin d'accès ou par la racine. Fonctionne de manière similaire à l'utilisation de la fonction ls standard pour afficher le répertoire actuel sur votre ordinateur.

hs ls [path] hs list [path]
ArgumentDescription
dest
Facultatif

Chemin d'accès au répertoire du système de fichiers du développeur distant pour lequel vous souhaitez répertorier les fichiers. Si elle n'est pas définie, la valeur par défaut est la racine du compte.

Récupérer

Récupérer un fichier, ou un répertoire et ses dossiers et fichiers enfants à partir du chemin d'accès.

Cette fonction permet de récupérer les fichiers de votre compte HubSpot et les rend disponibles dans votre environnement local.  <src> doit être le chemin d'accès de vos outils de conception HubSpot.  <dest> est le répertoire local dans lequel vous pouvez ajouter ces fichiers.

Par précaution, la récupération de fichiers n'écrase pas par défaut vos fichiers locaux existants. Utilisez --overwrite pour écraser les fichiers locaux existants si vous le souhaitez.

hs fetch --account=<name> <src> [dest] hs filemanager fetch --account=<name> <src> [dest]
ArgumentDescription
src
Obligatoire

Chemin d'accès aux outils de conception HubSpot

dest
Facultatif

Chemin d'accès au répertoire local dans lequel vous souhaitez que les fichiers soient placés, par rapport à votre répertoire de travail actuel. S'il est omis, cet argument sera utilisé par défaut dans votre répertoire de travail actuel.

OptionsDescription
--account

Entrez un accountId ou un nom à partir duquel récupérer les fichiers.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

--overwrite

Écraser les fichiers existants avec les fichiers récupérés.

--mode

Indiquez si vous souhaitez récupérer une version préliminaire ou publiée d'un fichier à partir de HubSpot. Cliquez ici pour obtenir des informations complémentaires.

Charger

Chargez une nouvelle ressource locale sur votre compte HubSpot. Les changements chargés par cette commande sont mis en ligne immédiatement. 

hs upload --account=<name> <src> <dest> hs filemanager upload --account=<name> <src> <dest>
ArgumentDescription
src
Obligatoire

Chemin d'accès au fichier local, relatif à votre répertoire de travail actuel.

dest
Obligatoire

Chemin d'accès dans HubSpot Design Tools, peut être un chemin d'accès supplémentaire.

OptionsDescription
--account

Entrez un accountId ou un nom à partir duquel récupérer les fichiers.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

--mode

Indiquez si les fichiers téléchargés sont publiés dans HubSpot. Voir « Modes » pour obtenir des informations complémentaires.

Sous-commandesDescription
filemanager

Charge le répertoire src spécifié dans le Gestionnaire de fichiers, plutôt que dans le système de fichiers du développeur dans le gestionnaire de conception.

Remarque : Les fichiers chargés sont définis comme publics et sont donc consultables par toute personne disposant de l'URL. Consultez notre documentation d'aide pour plus de détails sur les paramètres de visibilité des fichiers.

Consulter

Consultez votre répertoire local et chargez automatiquement les changements vers votre compte HubSpot lors de l'enregistrement des fichiers. Tout changement effectué lors de la sauvegarde sera immédiatement mis en ligne.

Gardez les points suivants à l'esprit lorsque vous utilisez la commande watch :

  • la suppression des fichiers consultés localement ne les supprimera pas automatiquement de HubSpot. Pour supprimer des fichiers, utilisez --remove.
  • En renommant un dossier localement, un nouveau dossier sera chargé sur HubSpot avec le nouveau nom. Le dossier existant dans HubSpot ne sera pas supprimé automatiquement. Pour supprimer le dossier, utilisez --remove.

Par le passé, la commande consulter chargeait le répertoire courant immédiatement, puis commençait à consulter les changements. La v2.0 simplifie désormais ce processus de consultation.

hs watch --account=<name> <src> <dest>
ArgumentDescription
src
Obligatoire

Chemin d'accès vers le répertoire local dans lequel se trouvent vos fichiers, par rapport à votre répertoire de travail actuel

dest
Obligatoire

Chemin d'accès dans HubSpot Design Tools, peut être un chemin d'accès supplémentaire.

OptionsDescription
--account

Entrez un accountId ou un nom à partir duquel récupérer les fichiers

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

--mode

Indiquez si les fichiers téléchargés doivent être publiés ou enregistrés comme brouillons dans HubSpot. Découvrez comment utiliser les modes.

--initial-upload

Déclenche un chargement initial avant que les fichiers ne soient sauvegardés. Prend en charge un alias de -i

--remove

La consultation supprimera les fichiers introuvables localement dans votre compte HubSpot.

--notify=<path/to/file>

Enregistrement dans le fichier spécifié lorsqu'une tâche de consultation est déclenchée et une fois que les collaborateurs ont terminé leurs tâches en cours.

déplacer

Cette commande est actuellement en version bêta. Faites-nous part de vos commentaires dans l'espace dédié aux développeurs ou en formulant une question sur le github pour l'LC.

Déplace les fichiers du système de fichiers du développeur d'un répertoire à un autre. N'affecte pas les fichiers stockés localement.

hs mv --account=<name> <src> <dest>
ArgumentDescription
src
Obligatoire

Chemin d'accès au répertoire du système de fichiers du développeur distant dans lequel se trouvent vos fichiers.

dest
Obligatoire

Chemin vers lequel déplacer les ressources dans le système de fichiers du développeur.

OptionsDescription
--account

Entrez un accountId ou un nom vers lequel déplacer les fichiers.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

Créer

Crée la structure du dossier/fichier lorsque vous ajoutez une nouvelle ressource.

hs create <type> <name> [dest]
ArgumentDescription
type
Obligatoire

Type de ressource. Ressources prises en charge :

name
Obligatoire

Nom de la nouvelle ressource

dest
Facultatif

Dossier de destination de la nouvelle ressource, par rapport à votre répertoire de travail actuel. S'il est omis, il s'agira par défaut de votre répertoire de travail actuel.

Supprimer

Supprime les fichiers, ou les dossiers et leurs fichiers, de votre compte HubSpot. Cela ne supprime pas les fichiers et dossiers stockés localement. Cette commande dispose d'un alias de rm.

hs remove --account=<name> <path>
ArgumentDescription
path
Obligatoire

Chemin d'accès aux outils de conception HubSpot

OptionsDescription
--account

Entrez un accountId ou un nom à partir duquel supprimer les fichiers.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

Commandes HubDB

Les commandes HubDB sont actuellement en version préliminaire pour développeurs. Elles sont utilisables dès maintenant, mais sont sujettes à modification.  Les conditions relatives aux versions bêta s'appliquent aux versions préliminaires pour développeurs.

Utilisez ces commandes pour créer, supprimer, récupérer et effacer toutes les lignes d'une table HubDB. Le compte HubSpot doit avoir accès à HubDB pour utiliser ces commandes.

Créer une table HubDB

Créez une nouvelle table HubDB dans le compte HubSpot. 

hs hubdb create <src>
ArgumentDescription
src
Obligatoire

Fichier JSON local à utiliser pour générer la table HubDB.

OptionsDescription
--account

Entrez un accountId ou un nom avec lequel créer la table HubDB.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

Récupérer la table HubDB

Téléchargez les données d'une table HubDB sur votre ordinateur.

hs hubdb fetch <tableId> <dest>
ArgumentDescription
tableId
Obligatoire

Identifiant de la table HubDB trouvé dans le tableau de bord HubDB.

dest

Destination du chemin local pour stocker le fichier hubdb.json.

OptionsDescription
--account

Entrez un accountId ou un nom à partir duquel récupérer la table HubDB.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

Effacer les lignes d'une table HubDB

Effacer toutes les lignes d'une table HubDB.

hs hubdb clear <tableId>
ArgumentDescription
tableId
Obligatoire

Identifiant de la table HubDB trouvé dans le tableau de bord HubDB.

OptionsDescription
--account

Entrez un accountId ou un nom à partir duquel effacer les lignes de la table HubDB.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

Supprimer la table HubDB

Supprime la table HubDB spécifiée du compte.

hs hubdb delete <tableId>
ArgumentDescription
tableId
Obligatoire

Identifiant de la table HubDB trouvé dans le tableau de bord HubDB.

OptionsDescription
--account

Entrez un accountId ou un nom à partir duquel supprimer la table HubDB.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

Table HubDB JSON

Lorsque vous récupérez une table HubDB, les données sont stockées sous le nom : tablename.hubdb.json. Lorsque vous créez une nouvelle table, vous devez spécifier un fichier JSON source. Vous trouverez ci-dessous un exemple de table au format 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" } } ] }

Commandes de fonction sans serveur

Utilisez ces commandes pour créer et déboguer des fonctions sans serveur (CMS Hub Entreprise uniquement).

fonctions liste

Imprime une liste de toutes les fonctions du compte, leurs points de terminaison, leurs méthodes, les noms des secrets utilisés et la date de la dernière mise à jour.

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

Nom interne du compte HubSpot figurant dans hubspot.config. Ce paramètre est requis si vous n'avez pas de defaultAccount dans votre hubspot.config.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

--compact

Affiche uniquement les noms et les méthodes des points de terminaison.

--json

Sortie JSON dans la ligne de commande avec des données sur toutes les fonctions. Les données JSON comprennent l'identifiant du portail HubSpot, l'identifiant de la fonction, l'itinéraire, le chemin d'accès de la ressource brute, la méthode, les secrets, et les dates de création et de dernière modification.

Fichiers journaux

Imprime un fichier journal à partir de votre fonction sans serveur. Affiche les console.logs contenus dans votre fonction après exécution. Les fichiers journaux comprennent également le délai d'exécution. Les fichiers journaux sont conservés pendant 90 jours. 

hs logs <endpoint-name> --account=<name> --follow
ArgumentDescription
endpoint-name
Obligatoire

Nom du point de terminaison tel que défini dans votre fichier serverless.json. Ce n'est pas le chemin d'accès à votre fichier de fonction.

OptionsDescription
--file

Affiche les fichiers journaux dans function.log

--follow

Consultez les fichiers journaux pour obtenir une mise à jour en direct pendant que vous exécutez vos fonctions sans serveur.

--latest

Afficher uniquement le fichier journal le plus récent

--account

Le nom interne du compte HubSpot figurant dans votre hubspot.config. Ce paramètre est requis si vous n'avez pas de defaultPortal dans votre hubspot.config.

Prend en charge un alias de --portal pour une rétrocompatibilité avec les anciennes versions de l'ILC.

--compact

Cache les résultats ou les informations relatives aux fichiers journaux. Renvoie les erreurs ou la réussite de l'opération et le délai d'exécution.

--limit=<number>

 limiter le nombre de fichiers journaux affichés en sortie

Si vous recevez ce message d'erreur : Une erreur serveur s'est produite : Avertissement : Les fichiers journaux relatifs à cette fonction ont dépassé la limite de 4 Ko. La taille du journal est trop importante. Cela peut être dû au fait que l'on essaie d'enregistrer en console un objet très volumineux, ou à un grand nombre d'enregistrements en console séparés. Pour résoudre ce problème, réduisez la quantité de données que vous essayez d'enregistrer, touchez votre point de terminaison, puis exécutez à nouveau la commande.

Ajouter un secret

Ajoutez un secret à votre compte qui peut être utilisé dans les fonctions sans serveur. Après avoir exécuté la commande, vous serez invité à saisir la valeur du secret.

Pour exposer le secret à votre fonction, mettez à jour votre fichier serverless.json avec le nom du secret, soit pour les points de terminaison spécifiques dans lesquels vous voulez l'utiliser, soit globalement pour le rendre disponible à tous.

hs secrets add <secret-name>
ArgumentDescription
secret-name
Obligatoire

Nom du secret.

secret-value
Obligatoire

La valeur du secret (détail de l'authentification ou autre).

mettre à jour le secret

Mettez à jour la valeur d'un secret dans votre compte qui peut être utilisé dans les fonctions sans serveur. Vous serez ensuite invité à saisir la valeur du secret.

hs secrets update <secret-name>
ArgumentDescription
secret-name
Obligatoire

Nom du secret.

secret-value
Obligatoire

La valeur du secret (détail de l'authentification ou autre).

supprimer le secret

Supprimez un secret de votre compte, pour qu'il ne soit plus utilisable dans les fonctions sans serveurs. Après avoir exécuté cette commande, modifiez votre fichier serverless.json pour supprimer le nom du secret.

hs secrets delete <secret-name>
ArgumentDescription
secret-name
Obligatoire

Nom du secret que vous voulez supprimer.

liste des secrets

Liste les secrets de votre compte pour savoir ce que vous avez déjà stocké en utilisant la commande d'ajout de secrets.

hs secrets list

Ouvrir les raccourcis du navigateur

Il y a de nombreuses parties de l'application HubSpot auxquelles les développeurs doivent accéder fréquemment. Pour faciliter l'accès à ces outils, vous pouvez les ouvrir directement à partir de la ligne de commande. Votre argument defaultAccount ou --account sera utilisé pour ouvrir l'outil associé à ce compte.

ouvert

hs open <shortcut-name or alias>
ArgumentDescription
shortcut
Obligatoire

Indiquez le nom complet du raccourci ou l'alias du raccourci que vous souhaitez ouvrir dans votre navigateur.

hs open --list
ArgumentDescription
--list
Obligatoire

Répertorie tous les raccourcis, leurs alias et leurs destinations.

Achèvement de la commande

Si vous utilisez fréquemment l'ILC, utilisez la tabulation pour compléter automatiquement les commandes.

hs completion >> ~/.bashrc

Pour Mac OS X

hs completion >> ~/.bash_profile

Format du modèle local

Pour en savoir plus sur les annotations de format des modèles locaux, reportez-vous à la documentation sur les modèles et consultez les modèles dans le boilerplate du thème CMS

Format du module local

Les modules locaux sont formatés dans une série de fichiers, chacun spécifiant les différents composants d'un module. Pour en savoir plus sur le développement de modules en local, consultez l'Aide sur les modules de développement en local.

.hsignore

Vous pouvez inclure un fichier .hsignore dans votre projet pour spécifier les fichiers qui ne doivent pas être suivis lors de l'utilisation de l'ILC. Ce fichier fonctionne de la même manière que les fichiers .gitignore.  Les fichiers correspondant aux modèles spécifiés dans le fichier .hsignore ne seront pas chargés vers HubSpot lors de l'utilisation des commandes charger ou consulter.

Par défaut, HubSpot applique automatiquement certaines règles. Ces valeurs par défaut ne peuvent pas être remplacées.

Les éléments suivants sont toujours ignorés :

  • hubspot.config.yml/hubspot.config.yaml
  • node_modules - dépendances
  • .* - fichiers/dossiers cachés
  • *.log - Journal des erreurs NPM
  • *.swp - Fichier de permutation pour l'état de Vim
  • Icon\\r - Icône du Finder personnalisée de Mac OS
  • __MACOSX - Fourchette de ressources Mac
  • ~ fichier de sauvegarde Linux
  • Thumbs.db - Cache des fichiers d'images Windows
  • ehthumbs.db - Fichier de configuration du dossier Windows
  • Desktop.ini - Informations sur les attributs des dossiers personnalisés de Windows
  • @eaDir - Dossier « caché » de Windows Synology diskstation où le serveur stocke les vignettes.
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

L'option --mode vous permet de déterminer si les modifications locales sont publiées lorsqu'elles sont téléchargées vers HubSpot. Cette option peut être utilisée dans chaque commande ou définie par défaut dans votre fichier hubspot.config.yml .

Les deux options pour --mode sont --mode=draft et --mode=publish.

Ci-dessous l'ordre de précédence pour le paramétrage de --mode :

  1. L'utilisation de --mode dans une commande écrase tous les autres paramètres.
  2. La définition d'un defaultMode pour chaque compte dans votre fichier hubspot.config.yml supprime la nécessité d'utiliser --mode dans chaque commande. Cela écrase le paramètre de niveau supérieur.
  3. La définition d'un defaultMode au niveau supérieur dans votre fichier hubspot.config.yml, définit un mode par défaut pour tous les comptes. Cela écrase le comportement par défaut.
  4. Le comportement par défaut de --mode est publish.

Authentification

Le fichierhubspot.config.yml contient les informations d'identification de vos comptes HubSpot. Voir le Guide de démarrage pour l'installation, ou exécuter la commande auth pour mettre à jour un fichier de configuration existant. 

Si vous avez exécuté hs init en utilisant les versions v1.0.10 (publiée le 10 mars 2020) ou v1.0.11 de l'ILC, votre fichier de configuration est placé dans /Users//hubspot<username>.config.yml.

Nous avons décidé de replacer votre fichier de configuration dans le dossier à partir duquel vous avez exécuté la commande, afin que l'emplacement du fichier soit plus logique. Vous n'avez pas besoin de déplacer votre fichier de configuration, il continuera à fonctionner correctement. Si vous préférez conserver votre fichier avec vos fichiers de projet, vous pouvez sans risque déplacer votre fichier de ce répertoire vers votre dossier de projet. N'insérez pas ce fichier dans le contrôle de version, il contient vos informations d'authentification.

Si vous avez exécuté la commande en utilisant une autre version du CMS-ILC, votre fichier de configuration est placé dans le dossier à partir duquel vous avez exécuté la commande.

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'

Paramètres de configuration de haut niveau

NomDescription
defaultPortal
facultatif

Remplace la nécessité d'exécuter des commandes en utilisant --account= pour spécifier le compte avec lequel vous interagissez. Si --account n'est pas spécifié lors de l'exécution d'une commande, le defaultPortal sera utilisé.

defaultMode
facultatif

Quel mode doit être utilisé pour un compte, brouillon ou publication ? 

allowUsageTracking
facultatif

Spécifie si HubSpot a la permission de suivre l'utilisation des outils de développement locaux. La valeur par défaut est true. Définir false pour désactiver tout suivi. 

Paramètres de configuration du compte

NomDescription
portalId
obligatoire

L'ID du compte pour lequel vous configurez l'authentification.

authType
obligatoire

Quelle forme d'authentification est utilisée par une entrée ? personalaccesskey ou apikey. Note : Vous devez en outre définir un paramètre de configuration pour la valeur de vos méthodes d'authentification. Consultez l'exemple de fichier de configuration ci-dessus pour savoir comment définir votre personalAccessKey ou apiKey en plus de spécifier le authType.

name
facultatif

Pour spécifier le nom d'un compte, qui peut être utilisé pour indiquer le compte avec lequel une commande doit interagir. ex .--account=123 et --account=DEV interagiront tous deux avec l'ID de compte 123 selon l'exemple ci-dessus. Ce nom ne peut pas contenir d'espaces.

defaultMode
facultatif

Quel mode doit être utilisé pour un compte, brouillon ou publication ? 

Environment variables

L'ILC de HubSpot prend en charge l'utilisation de variables d'environnement, ce qui peut être particulièrement utile lors de la création d'automatisations comme une action GitHub.

Exécutez n'importe quelle commande en utilisant l'indicateur --use-env pour utiliser les variables d'environnement au lieu du fichier hubspot.config.yml.

hs upload example-project example-project-remote --use-env
NomDescription
HUBSPOT_PORTAL_ID
Obligatoire

L'ID du compte HubSpot.

HUBSPOT_PERSONAL_ACCESS_KEY
Recommandé

La clé d'accès personnelle d'un utilisateur sur le compte HubSpot. Toutes les modifications effectuées seront associées à cet utilisateur.

HUBSPOT_API_KEY

La clé d'API HubSpot associée au compte HubSpot.

HUBSPOT_CLIENT_ID

L'ID du client OAuth.

HUBSPOT_CLIENT_SECRET

Le secret OAuth.

Remarque : À compter du 30 novembre 2022, les clés d'API HubSpot ne pourront plus être utilisées comme méthode d'authentification pour accéder aux API HubSpot. En outre, à compter du 15 juillet 2022, les comptes sans clé d'API HubSpot déjà générée ne pourront plus en créer.

Au lieu de cela, vous devrez utiliser un jeton d'accès d'application privée ou OAuth pour authentifier les appels d'API. Découvrez-en davantage sur cette modification et sur la migration d'une intégration de clé d'API pour utiliser une application privée à la place.

Validation des ressources du Marketplace

 L'ILC fournit une série de tests automatisés que vous pouvez effectuer sur vos ressources pour les rendre conformes aux exigences du marketplace avant de les soumettre. Réussir tous les tests automatisés ne signifie pas que vous passerez à coup sûr le processus d'examen, un examen plus approfondi est réalisé pour garantir une qualité dépassant ce qui peut être facilement automatisé.

Valider le thème

La commande de validation de thème vous permet d'exécuter rapidement des tests automatisés sur votre thème afin d'identifier les problèmes qui doivent être corrigés avant la soumission sur le marketplace des ressources. Ces messages seront renvoyés dans votre ILC sous la forme d'une liste de messages d'[erreur] et de [réussite] séparés en groupes qui représentent les types de ressources d'un thème.

hs theme marketplace-validate <src>
ArgumentDescription
src
Obligatoire

Chemin d'accès au dossier du thème local, par rapport à votre répertoire de travail actuel.


Cet article vous a-t-il été utile ?
Ce formulaire est destiné à recueillir les avis sur la documentation pour les développeurs. Si vous souhaitez faire part de votre avis sur les produits HubSpot, veuillez le partager sur le forum des idéesde la communauté.