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.

Afficher toutes les commandes

Affiche toutes les commandes et leurs définitions. Pour en savoir plus sur une commande spécifique, ajoutez --help à la fin de la commande.

hs help

Installer l'ILC

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.  Pour procéder à une installation locale, omettez -g de la commande.

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.

Mettre à jour l'ILC

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.

Authentification

Les commandes suivantes vous permettent d'authentifier les comptes HubSpot avec l'ILC afin que vous puissiez interagir avec le compte. Si vous n'avez pas encore authentifié un compte avec l'ILC, vous devez d'abord exécuter hs init pour créer un fichier hubspot.config.yml, qui contiendra les détails d'authentification pour tous les comptes HubSpot connectés. Le reste des commandes mettra à jour ce fichier.

Découvrez-en davantage dans le guide Premiers pas avec le développement local.

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

Authentifier un compte

Générez une authentification pour un compte HubSpot en utilisant une clé d'accès 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

Lister les comptes authentifiés

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

Définir comme compte par défaut

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

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

Supprimer un compte

Supprimez un compte de votre fichier de configuration.

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

Identifiez le compte à supprimer par son nom (tel que défini dans le fichier de configuration) ou son ID.

Supprimer des comptes non valides

Supprime tous les comptes HubSpot désactivés de votre fichier de configuration.

hs accounts clean

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. Ces commandes vous permettent de créer localement de nouvelles ressources, telles que des modules et des thèmes, de les télécharger dans le compte, de répertorier des fichiers dans le compte HubSpot ou de télécharger des fichiers existants dans votre environnement local.

Lister les fichiers

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 les fichiers

Récupérez un fichier ou un répertoire et ses dossiers et fichiers enfants à partir du chemin d'accès. Copiez les fichiers de votre compte HubSpot dans votre environnement local.

Par défaut, la récupération n'écrasera pas les fichiers locaux existants. Pour écraser les fichiers locaux, ajoutez l'indicateur --overwrite.

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 des fichiers

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.

--clean

Un indicateur facultatif qui supprimera le répertoire de destination et son contenu avant le téléchargement.

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.

Configurer une commande watch pour le téléchargement automatique

Consultez votre répertoire local et chargez automatiquement les changements vers votre compte HubSpot lors de l'enregistrement. 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.
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 les fichiers

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 de nouveaux fichiers

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

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

Type de ressource. Types pris 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 des fichiers

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.

Ignorer les fichiers

Vous pouvez inclure un fichier .hsignore 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

Prévisualiser localement le thème

Lors du développement d'un thème, vous pouvez exécuter hs theme preview dans le répertoire racine du thème pour afficher un aperçu en direct de vos modifications sans télécharger de fichiers sur le compte. L'aperçu s'exécutera sur un serveur proxy local à l'adresse https://hslocal.net :3000/.

Une fois exécutée, cette commande lancera un processus de surveillance afin que toutes les modifications enregistrées soient rendues dans l'aperçu. 

Please note: to allow the local server to run on https, HubSpot must generate a self-signed SSL certificate and register it with your operating system. This will require entering your sudo password.

hs theme preview <src> <dest>
ArgumentDescription
src
Obligatoire

Chemin d'accès au fichier local, relatif à votre répertoire de travail actuel. Cette commande doit être exécutée dans le répertoire racine du thème.

dest
Obligatoire

Le chemin de l'aperçu. Cela peut être n'importe quelle valeur et n'est utilisé qu'en interne et à des fins d'affichage sur la page d'aperçu.

La page principale sur https://hslocal.net :3000/affichera une liste des modèles et des modules de votre thème, qui peuvent tous être prévisualisés individuellement en cliquant sur les liens fournis. Vous verrez également une liste des domaines connectés du compte, que vous pouvez utiliser pour prévisualiser le contenu de domaines spécifiques. Le domaine sera ajouté au domaine hslocal.net.

local-theme-preview-homepage

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.

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

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.

Commandes de fonction sans serveur

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

Créer une fonction

Crée une fonction sans serveur à l'aide de la commande create. L'exécution de cette commande vous guidera à travers les étapes de création de la fonction, telles que l'appellation de son fichier parent et de fonction ainsi que la définition de ses méthodes et de son chemin d'accès au point de terminaison.

hs create function

Lister les fonctions

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.

--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.

Obtenir des 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

Le nom du point de terminaison tel que défini dans votre fichier serverless.json. (et non le chemin vers le fichier de fonction).

--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 : ATTENTION : 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 un 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.

Remarque : En raison de la mise en cache, il peut s'écouler environ une minute pour que les valeurs secrètes se mettent à jour. Si vous venez de mettre à jour un secret mais que vous voyez toujours l'ancienne valeur, vérifiez à nouveau au bout d'une minute environ.
hs secrets update <secret-name>
ArgumentDescription
secret-name
Obligatoire

Le nom du secret, que vous utiliserez ultérieurement pour y faire référence. Il peut s'agir de n'importe quelle valeur unique, bien qu'il soit recommandé de rester simple pour faciliter son utilisation.

Supprimer un 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.

Lister les 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

Évaluer les thèmes et les modèles pour le SEO et l'accessibilité

Utilise les outils Lighthouse de Google pour évaluer la qualité de vos thèmes et modèles en fonction de leur adhésion aux catégories suivantes :

  • Accessibilité
  • Bonnes pratiques web
  • Performance
  • PWA
  • Le SEO

Les types de modèles suivants sont notés :

  • Pages de destination
  • Pages de site web
  • Articles de blog
  • Page de listing de blog

Si des modèles ne parviennent pas à générer un score en raison d'erreurs de Lighthouse, une liste de ces modèles sera fournie.  

hs cms lighthouse-score --theme=path
Use this table to describe parameters / fields
ParameterDescription
--theme-path
Obligatoire

Chemin d'accès à un thème dans le gestionnaire de conception.

--verbose
  • Lorsque ce paramètre est exclu, le score renvoyé est une moyenne de tous les modèles du thème (par défaut).
  • Lorsque ce paramètre est inclus, les scores de modèle individuels sont affichés. Vous recevrez également des liens de rapport Lighthouse pour chaque modèle.
--target

Vous pouvez consulter les scores respectifs sur ordinateur ou sur mobile. Par défaut, la cible est la version de bureau. 

Générer des sélecteurs de champ de thème pour la mise en évidence dans l'application

Lorsque vous créez un thème, utilisez la commande suivante pour générer un fichier editor-preview.json qui mappe les sélecteurs CSS aux champs du thème. Cela permet aux créateurs de contenu de voir quels éléments du thème seront impactés par les mises à jour des options de style d'un champ.

Après avoir exécuté la commande, vous devrez examiner et affiner le fichier editor-preview.json pour vous assurer que les champs et les sélecteurs sont mappés correctement. Si cette commande fera une supposition rudimentaire sur les champs qui affectent les sélecteurs, vous devrez apporter des corrections en fonction de la façon dont votre thème est construit. Par exemple, cette commande ne peut pas détecter si des modules remplacent le style ou si vous utilisez des macros. Découvrez-en davantage sur la mise en évidence des champs de l'éditeur de thème.

hs theme generate-selectors <theme-directory-path>

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.

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_CLIENT_ID

L'ID du client OAuth.

HUBSPOT_CLIENT_SECRET

Le secret OAuth.

Remarque : Depuis le 30 novembre 2022, les clés d'API HubSpot ne sont plus prises en charge. L'utilisation continue des clés d'API HubSpot constitue un risque pour la sécurité de votre compte et de vos données. Pendant cette phase, HubSpot peut désactiver votre clé à tout moment.

Veillez plutôt à vous authentifier à l'aide d'un jeton d'accès d'application privée ou d'OAuth. 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.

Avant de pouvoir valider un thème, vous devez d'abord le télécharger sur votre compte avec hs upload. Ensuite, exécutez la commande suivante pour valider le thème téléchargé.

hs theme marketplace-validate <src>
ArgumentDescription
src
Obligatoire

Chemin d'accès relatif à la racine du dossier de thème dans le gestionnaire de conception. 

Valider un module

Semblable à la validation de thème, cette commande vous permet d'exécuter rapidement des tests automatisés sur un module afin d'identifier les problèmes qui doivent être corrigés avant la soumission sur le marketplace des ressources. 

Avant de pouvoir valider un module, vous devez d'abord le télécharger sur votre compte avec hs upload. Ensuite, exécutez la commande suivante pour valider le module téléchargé.

hs module marketplace-validate <src>
ArgumentDescription
src
Obligatoire

Chemin d'accès relatif à la racine du dossier de module dans le gestionnaire de conception. 


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é.