Commandes d'ILC HubSpot

Last updated: novembre 15, 2023

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.

Use this table to describe parameters / fields
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.

Use this table to describe parameters / fields
Parameter	Description
`accountNameOrID`	Identifiez le compte à supprimer par son nom (tel que défini dans le fichier de configuration) ou son ID.


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.


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


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


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


Argument	Description
`type` Obligatoire	Type de ressource. Types pris en charge : `module` `template` `website-theme` `function` `webpack-serverless` `react-app` `vue-app`
`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.


Argument	Description
`path` Obligatoire	Chemin d'accès aux outils de conception HubSpot


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

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


Argument	Description
`src` Obligatoire	Fichier JSON local à utiliser pour générer la table HubDB.


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


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 `hubdb.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" } } ] }


Argument	Description
`tableId` Obligatoire	Identifiant de la table HubDB trouvé dans le tableau de bord HubDB.


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


Argument	Description
`tableId` Obligatoire	Identifiant de la table HubDB trouvé dans le tableau de bord HubDB.


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


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


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


Argument	Description
`secret-name` Obligatoire	Nom du secret.
`secret-value` Obligatoire	La valeur du secret (détail de l'authentification ou autre).


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


Argument	Description
`secret-name` Obligatoire	Nom du secret que vous voulez supprimer.


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.

Use this table to describe parameters / fields
Parameter	Description
`--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.

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.


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.

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.


Argument	Description
`src` Obligatoire	Chemin d'accès relatif à la racine du dossier de module dans le gestionnaire de conception.

Partagez votre avis

Cet article vous a-t-il été utile ? Oui Non

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

Apps & Integrations

CMS

Developer References

Developer Community

App Ecosystem New

Template Marketplace

App Partner Program

CMS Reference Docs

Commandes d'ILC HubSpot

Afficher toutes les commandes

Installer l'ILC

Installer uniquement dans le répertoire actuel

Mettre à jour l'ILC

Authentification

init

Authentifier un compte

Lister les comptes authentifiés

Définir comme compte par défaut

Supprimer un compte

Supprimer des comptes non valides

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

Lister les fichiers

Récupérer les fichiers

Charger des fichiers

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

Déplacer les fichiers

Créer de nouveaux fichiers

Supprimer des fichiers

Ignorer les fichiers

Commandes HubDB

Créer une table HubDB

Récupérer la table HubDB

Effacer les lignes d'une table HubDB

Supprimer la table HubDB

Commandes de fonction sans serveur

Créer une fonction

Lister les fonctions

Obtenir des journaux

Ajouter un secret

Mettre à jour un secret

Supprimer un secret

Lister les secrets

Ouvrir les raccourcis du navigateur

ouvert

Achèvement de la commande

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

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

Modes

Environment variables

Validation des ressources du Marketplace

Valider le thème

Valider un module

Partagez votre avis