Commandes d'ILC HubSpot
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.
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.
Affiche toutes les commandes et leurs définitions. Pour en savoir plus sur une commande spécifique, ajoutez --help
à la fin de la commande.
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. Découvrez-en davantage sur l'installation globale ou locale des paquets.
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.
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.
L'ILC est mise à niveau régulièrement. Pour passer à la dernière version des outils locaux, exécutez :
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
.
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.
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.
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.
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.
Définissez le compte par défaut dans votre fichier de configuration.
Parameter | Description |
---|---|
accountNameOrID
| Identifiez le nouveau compte par défaut par son nom (tel que défini dans le fichier de configuration) ou son ID. |
Supprimez un compte de votre fichier de configuration.
Parameter | Description |
---|---|
accountNameOrID
| Identifiez le compte à supprimer par son nom (tel que défini dans le fichier de configuration) ou son ID. |
Supprime tous les comptes HubSpot désactivés de votre fichier de configuration.
À 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.
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.
Argument | Description |
---|---|
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é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
.
Argument | Description |
---|---|
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. |
Options | Description |
---|---|
--account
| Entrez un Prend en charge un alias de |
--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. |
Chargez une nouvelle ressource locale sur votre compte HubSpot. Les changements chargés par cette commande sont mis en ligne immédiatement.
Argument | Description |
---|---|
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. |
Options | Description |
---|---|
--account
| Entrez un Prend en charge un alias de |
--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-commandes | Description |
---|---|
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. |
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
.
Argument | Description |
---|---|
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. |
Options | Description |
---|---|
--account
| Entrez un Prend en charge un alias de |
--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 |
--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é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.
Argument | Description |
---|---|
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. |
Options | Description |
---|---|
--account
| Entrez un Prend en charge un alias de |
Crée la structure du dossier/fichier lorsque vous ajoutez une nouvelle ressource.
Argument | Description |
---|---|
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. |
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.
Argument | Description |
---|---|
path
Obligatoire
| Chemin d'accès aux outils de conception HubSpot |
Options | Description |
---|---|
--account
| Entrez un Prend en charge un alias de |
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 LinuxThumbs.db
- Cache des fichiers d'images Windowsehthumbs.db
- Fichier de configuration du dossier WindowsDesktop.ini
- Informations sur les attributs des dossiers personnalisés de Windows@eaDir
- Dossier « caché » de Windows Synology diskstation où le serveur stocke les vignettes.
# 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
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éez une nouvelle table HubDB dans le compte HubSpot.
Argument | Description |
---|---|
src
Obligatoire
| Fichier JSON local à utiliser pour générer la table HubDB. |
Options | Description |
---|---|
--account
| Entrez un Prend en charge un alias de |
Téléchargez les données d'une table HubDB sur votre ordinateur.
Argument | Description |
---|---|
tableId
Obligatoire
| Identifiant de la table HubDB trouvé dans le tableau de bord HubDB. |
dest
| Destination du chemin local pour stocker le fichier |
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.
Effacer toutes les lignes d'une table HubDB.
Argument | Description |
---|---|
tableId
Obligatoire
| Identifiant de la table HubDB trouvé dans le tableau de bord HubDB. |
Options | Description |
---|---|
--account
| Entrez un Prend en charge un alias de |
Supprime la table HubDB spécifiée du compte.
Argument | Description |
---|---|
tableId
Obligatoire
| Identifiant de la table HubDB trouvé dans le tableau de bord HubDB. |
Options | Description |
---|---|
--account
| Entrez un Prend en charge un alias de |
Utilisez ces commandes pour créer et déboguer des fonctions sans serveur (CMS Hub Entreprise uniquement).
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.
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.
Argument | Description |
---|---|
--account
| Nom interne du compte HubSpot figurant dans hubspot.config. Ce paramètre est requis si vous n'avez pas de defaultAccount dans votre Prend en charge un alias de |
--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. |
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.
Argument | Description |
---|---|
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 |
--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.
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.
Argument | Description |
---|---|
secret-name
Obligatoire
| Nom du secret. |
secret-value
Obligatoire
| La valeur du secret (détail de l'authentification ou autre). |
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.
Argument | Description |
---|---|
secret-name
Obligatoire
| Nom du secret. |
secret-value
Obligatoire
| La valeur du secret (détail de l'authentification ou autre). |
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.
Argument | Description |
---|---|
secret-name
Obligatoire
| Nom du secret que vous voulez supprimer. |
Liste les secrets de votre compte pour savoir ce que vous avez déjà stocké en utilisant la commande d'ajout de secrets.
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.
Argument | Description |
---|---|
shortcut
Obligatoire
| Indiquez le nom complet du raccourci ou l'alias du raccourci que vous souhaitez ouvrir dans votre navigateur. |
Argument | Description |
---|---|
--list
Obligatoire
| Répertorie tous les raccourcis, leurs alias et leurs destinations. |
Si vous utilisez fréquemment l'ILC, utilisez la tabulation pour compléter automatiquement les commandes.
Pour Mac OS X
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.
Parameter | Description |
---|---|
--theme-path
Obligatoire
| Chemin d'accès à un thème dans le gestionnaire de conception. |
--verbose
|
|
--target
| Vous pouvez consulter les scores respectifs sur ordinateur ou sur mobile. Par défaut, la cible est la version de bureau. |
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.
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 :
- L'utilisation de --mode dans une commande écrase tous les autres paramètres.
- 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.
- 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.
- Le comportement par défaut de --mode est publish.
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
.
Nom | Description |
---|---|
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.
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é.
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é.
Argument | Description |
---|---|
src
Obligatoire
| Chemin d'accès relatif à la racine du dossier de thème dans le gestionnaire de conception. |
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é.
Argument | Description |
---|---|
src
Obligatoire
| Chemin d'accès relatif à la racine du dossier de module dans le gestionnaire de conception. |
Merci d'avoir partagé votre avis.