HubSpot-CLI-Befehle

Last updated: November 14, 2023

Generieren Sie mithilfe eines persönlichen Zugriffsschlüssels die Authentifizierung für einen HubSpot-Account. Sie können Ihren Zugriffsschlüssel hier generieren. Wenn Sie bereits eine hubspot.config.yml-Datei haben, können Sie diesen Befehl verwenden, um Anmeldeinformationen für zusätzliche Accounts hinzuzufügen. Sie könnten zum Beispiel Ihren Sandbox-Account als Entwicklungsumgebung verwenden. Wenn Sie aufgefordert werden, einen Namen für den Account einzugeben, darf der Name keine Leerzeichen enthalten.

Use this table to describe parameters / fields
Parameter	Description
`accountNameOrID`	Identifizieren Sie den neuen Standard-Account anhand seines Namens (wie in der Konfigurationsdatei festgelegt) oder der ID.

Use this table to describe parameters / fields
Parameter	Description
`accountNameOrID`	Identifizieren Sie den zu entfernenden Account anhand seines Namens (wie in der Konfigurationsdatei festgelegt) oder der ID.


Argument	Description
`dest` Optional	Pfad zum Verzeichnis des Dateisystems des Remote-Entwicklers, für das Sie Dateien auflisten möchten. Wenn nicht angegeben, wird standardmäßig der Stamm-Account verwendet.


Argument	Description
`src` Erforderlich	Pfad in HubSpot-Design-Tools
`dest` Optional	Pfad zum lokalen Verzeichnis, in dem die Dateien abgelegt werden sollen, relativ zu Ihrem aktuellen Arbeitsverzeichnis. Wenn Sie dieses Argument weglassen, wird Ihr aktuelles Arbeitsverzeichnis als Standard verwendet.


Optionen	Description
`--account`	Geben Sie eine `accountId` oder einen Namen, von der oder dem abgerufen werden soll Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.
`--overwrite`	Überschreiben Sie vorhandene Dateien mit abgerufenen Dateien.
`--mode`	Geben Sie an, ob ein Entwurf oder eine veröffentlichte Version einer Datei von HubSpot abgerufen werden soll. Weitere Informationen dazu erhalten Sie hier


Argument	Description
`src` Erforderlich	Pfad zur lokalen Datei, relativ zu Ihrem aktuellen Arbeitsverzeichnis.
`dest` Erforderlich	Pfad in HubSpot-Design-Tools, kann ein neuer Pfad sein.


Optionen	Description
`--account`	Geben Sie eine `accountId` oder einen Namen ein, von der oder dem abgerufen werden soll Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.
`--mode`	Geben Sie an, ob hochgeladene Dateien in HubSpot veröffentlicht werden. Siehe „Modi“ für weitere Informationen.
`--clean`	Ein optionales Flag, das das Zielverzeichnis und seinen Inhalt vor dem Hochladen löscht.


Unterbefehle	Description
`filemanager`	Lädt das angegebene src-Verzeichnis in den Date-Manager und nicht in das Dateisystem des Entwicklers im Design-Manager hoch. Hinweis: Hochgeladene Dateien werden auf öffentlich gesetzt, sodass sie von jedem mit der URL angezeigt werden können. Weitere Einzelheiten zu den Einstellungen für die Dateisichtbarkeit finden Sie in unserer Hilfedokumentation.

Überwachen Sie Ihr lokales Verzeichnis und laden Sie Änderungen automatisch in Ihren HubSpot-Account hoch, wenn Sie speichern. Alle Änderungen, die Sie beim Speichern vornehmen, werden sofort übernommen.

Beachten Sie bei der Verwendung von watch Folgendes:

Wenn Sie überwachte Dateien lokal löschen, werden sie nicht automatisch aus HubSpot gelöscht. Um Dateien zu löschen, verwenden Sie --remove.
Wenn Sie einen Ordner lokal umbenennen, wird ein neuer Ordner mit dem neuen Namen zu HubSpot hochgeladen. Der bestehende Ordner in HubSpot wird nicht automatisch gelöscht. Um den Ordner zu löschen, verwenden Sie --remove.


Argument	Description
`src` Erforderlich	Pfad zu dem lokalen Verzeichnis, in dem sich Ihre Dateien befinden, relativ zu Ihrem aktuellen Arbeitsverzeichnis
`dest` Erforderlich	Pfad in HubSpot-Design-Tools, kann ein neuer Pfad sein.


Optionen	Description
`--account`	Geben Sie eine `accountId` oder einen Namen ein, von der oder dem abgerufen werden soll Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.
`--mode`	Legen Sie fest, ob hochgeladene Dateien in HubSpot veröffentlicht oder als Entwürfe gespeichert werden sollen. Erfahren Sie mehr über die Verwendung von Modi.
`--initial-upload`	Bewirkt, dass ein erster Upload erfolgt, bevor eine Datei gespeichert wurde. Unterstützt einen Alias von `-i`
`--remove`	Veranlasst watch, Dateien in Ihrem HubSpot-Account zu löschen, die lokal nicht gefunden werden.
`--notify=<path/to/file>`	Protokollierung in angegebener Datei, wenn eine Überwachungsaufgabe ausgelöst wird und nachdem Worker inaktiv geworden sind.


Argument	Description
`src` Erforderlich	Pfad zum Verzeichnis des Dateisystems des Remote-Entwicklers, in dem sich Ihre Dateien befinden.
`dest` Erforderlich	Pfad zum Verschieben von Elementen im Dateisystem des Entwicklers.


Optionen	Description
`--account`	Geben Sie eine `accountId` oder einen Namen an, in dem Dateien verschoben werden sollen. Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.


Argument	Description
`type` Erforderlich	Typ des Elements. Folgende Typen werden unterstützt: `module` `template` `website-theme` `function` `webpack-serverless` `react-app` `vue-app`
`name` Erforderlich	Der Name des neuen Elements
`dest` Optional	Der Zielordner für das neue Element, relativ zu Ihrem aktuellen Arbeitsverzeichnis. Wenn Sie dies weglassen, wird Ihr aktuelles Arbeitsverzeichnis als Standard verwendet.


Argument	Description
`path` Erforderlich	Pfad in HubSpot-Design-Tools


Optionen	Description
`--account`	Geben Sie eine `accountId` oder einen Namen an, um eine Datei davon zu entfernen. Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.

Standardmäßig gibt es einige Regeln, die HubSpot automatisch durchsetzt. Es gibt keine Möglichkeit, diese Standardeinstellungen zu überschreiben.

Die folgenden Angaben werden immer ignoriert:

hubspot.config.yml/hubspot.config.yaml
node_modules – Abhängigkeiten
.* – ausgeblendete Dateien/Ordner
*.log – NPM-Fehlerprotokoll
*.swp – Auslagerungsdatei für Vim-Status
Icon\\r – Benutzerdefiniertes Mac OS Finder-Symbol
__MACOSX – Mac-Ressourcen-Gabel
~ – Linux-Backup-Datei
Thumbs.db – Cache für Windows-Bilddateien
ehthumbs.db – Windows-Ordner-Konfigurationsdatei
Desktop.ini – Informationen zu benutzerdefinierten Ordnerattributen von Windows
@eaDir – „Ausgeblendeter“ Ordner von Windows Synology Diskstation, in dem der Server Thumbnails speichert.

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` Erforderlich	Die lokale JSON-Datei, die für die Erstellung der HubDB-Tabelle verwendet werden soll.


Optionen	Description
`--account`	Geben Sie eine `accountId` oder einen Namen an, unter dem HubDB erstellt werden soll. Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.


Argument	Description
`tableId` Erforderlich	HubDB-Tabellen-ID im HubDB-Dashboard gefunden.
`dest`	Das lokale Pfadziel zum Speichern der `hubdb.json`-Datei.

// 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` Erforderlich	HubDB-Tabellen-ID im HubDB-Dashboard gefunden.


Optionen	Description
`--account`	Geben Sie eine `accountId` oder einen Namen an, von der oder dem HubDB-Zeilen gelöscht werden sollen. Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.


Argument	Description
`tableId` Erforderlich	HubDB-Tabellen-ID im HubDB-Dashboard gefunden.


Optionen	Description
`--account`	Geben Sie eine `accountId` oder einen Namen ein, von der oder dem HubDB gelöscht werden soll. Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.


Argument	Description
`--account`	Der HubSpot-Account-Name aus Ihrer hubspot.config. Dieser Parameter ist erforderlich, wenn Sie nicht über einen defaultAccount in Ihrer `hubspot.config` verfügen. Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.
`--json`	Ausgabe von JSON in die Befehlszeile mit Daten zu allen Funktionen. Die JSON-Daten umfassen Portal-ID, Funktions-ID, Route, Rohelementpfad, Methode, Geheimnisse, Erstellungsdatum und Datum der letzten Änderung.


Argument	Description
`endpoint-name` Erforderlich	Der Endpunktname, wie er in Ihrer serverless.json-Datei definiert ist (nicht der Pfad zur Funktionsdatei).
`--file`	Ausgabe der Protokolle in function.log
`--follow`	Verfolgen Sie die Protokolle, um ein Live-Update zu erhalten, während Sie Ihre serverlosen Funktionen ausführen.
`--latest`	Ausgabe nur des aktuellsten Protokolls
`--account`	Der HubSpot-Account-Name aus Ihrer hubspot.config. Dieser Parameter ist erforderlich, wenn Sie kein defaultPortal in Ihrer hubspot.config haben. Unterstützt einen Alias von `--portal` für die Abwärtskompatibilität mit älteren Versionen des CLI.
`--compact`	Blendet Protokollausgaben/-informationen aus. Gibt Erfolgs-/Fehlermeldung und Ausführungszeit zurück.
`--limit=<number>`	Begrenzen Sie die Menge der in der Ausgabe angezeigten Protokolle.

Wenn Sie ein Fehler vom Typ Es ist ein Server-Fehler aufgetreten. WARNUNG: Die Protokolle für diese Funktion haben das Limit von 4 KB überschritten erhalten, ist Ihr Protokoll zu groß. Dies kann durch den Versuch verursacht werden, ein sehr großes Objekt über die Konsole zu protokollieren, oder durch viele separate Konsolenprotokolle. Um dieses Problem zu beheben, reduzieren Sie die Menge, die Sie zu protokollieren versuchen, treffen Sie Ihren Endpunkt und führen Sie den Befehl erneut aus.


Argument	Description
`secret-name` Erforderlich	Name des Geheimnisses.
`secret-value` Erforderlich	Der Wert des Geheimnisses (Authentifizierungsdetail oder anderweitig).


Argument	Description
`secret-name` Erforderlich	Der Name des Geheimnisses, den Sie später verwenden werden, um auf das Geheimnis zu verweisen. Dies kann ein eindeutiger Wert sein, obwohl es empfehlenswert ist, ihn für die Benutzerfreundlichkeit einfach zu halten.


Argument	Description
`secret-name` Erforderlich	Name des Geheimnisses, das Sie entfernen möchten.


Argument	Description
`shortcut` Erforderlich	Geben Sie den vollständigen Shortcut-Namen oder den Alias des Shortcuts an, den Sie in Ihrem Browser öffnen möchten.


Argument	Description
`--list` Erforderlich	Listet alle Shortcuts, ihre Aliasnamen und Ziele auf.

Use this table to describe parameters / fields
Parameter	Description
`--theme-path` Erforderlich	Pfad zu einem Design im Design-Manager.
`--verbose`	Wenn dieser Parameter ausgeschlossen wird, ist der zurückgegebene Score ein Durchschnitt aller Vorlagen des Designs (Standard). Wenn dieser Parameter enthalten ist, werden die einzelnen Vorlagen-Scores angezeigt. Sie erhalten auch für jede Vorlage Links zu Lighthouse-Berichten.
`--target`	Dies kann entweder ein Desktop- oder ein Mobilgerät sein, um die entsprechenden Scores anzuzeigen. Standardmäßig ist das Ziel Desktop.

Wenn Sie ein Design erstellen, verwenden Sie den folgenden Befehl, um eine editor-preview.json-Datei zu generieren, die CSS-Selektorenzu Designfeldern zuordnet. Auf diese Weise können Content-Autoren sehen, welche Designelemente von Aktualisierungen der Styling-Optionen eines Feldes betroffen sind.

Nach dem Ausführen des Befehls müssen Sie die editor-preview.json-Datei überprüfen und optimieren, um sicherzustellen, dass Felder und Selektoren ordnungsgemäß zugeordnet sind. Während dieser Befehl eine rudimentäre Vermutung darüber anstellt, welche Felder sich auf welche Selektoren auswirken, müssen Sie je nachdem, wie Ihr Design aufgebaut ist, Korrekturen vornehmen. Dieser Befehl kann beispielsweise nicht erkennen, wenn Module das Styling überschreiben oder wenn Sie Makros verwenden. Erfahren Sie mehr über das Hervorheben von Design-Editor-Feldern.

Mit der Option --mode können Sie festlegen, ob lokale Änderungen beim Hochladen in HubSpot veröffentlicht werden. Diese Option kann in jedem Befehl verwendet oder als Standard in Ihrer hubspot.config.yml-Datei festgelegt werden.

Die beiden Optionen für --mode sind --mode=draft und --mode=publish.

Nachfolgend ist die Rangfolge für das Festlegen von --mode aufgeführt:

Die Verwendung von --mode in einem Befehl setzt alle anderen Einstellungen außer Kraft.
Wenn Sie einen defaultMode für jeden Account in Ihrer hubspot.config.yml file festlegen, müssen Sie nicht mehr --mode in jedem Befehl verwenden. Damit wird die Einstellung der obersten Ebene außer Kraft gesetzt.
Wenn Sie einen defaultMode auf oberster Ebene in Ihrer hubspot.config.yml-Datei festlegen, wird ein standardmäßiger --mode für alle Accounts festgelegt. Damit wird das Standardverhalten außer Kraft gesetzt.
Das Standardverhalten für --mode ist publish.


Name	Description
`HUBSPOT_PORTAL_ID` Erforderlich	Die HubSpot-Account-ID.
`HUBSPOT_PERSONAL_ACCESS_KEY` Empfohlen	Der persönliche Zugriffsschlüssel eines Benutzers im HubSpot-Account. Alle vorgenommenen Aktualisierungen werden mit diesem Benutzer verknüpft.
`HUBSPOT_CLIENT_ID`	Die OAuth-Client-ID.
`HUBSPOT_CLIENT_SECRET`	Das OAuth-Geheimnis.

Bitte beachten: Seit dem 30. November 2022 werden HubSpot-API-Schlüssel nicht mehr unterstützt. Die fortgesetzte Verwendung von HubSpot API-Schlüsseln stellt ein Sicherheitsrisiko für Ihren Account und Ihre Daten dar. Während dieser Phase bis zur endgültigen Einstellung kann HubSpot Ihren Schlüssel jederzeit deaktivieren.

Sie sollten sich stattdessen mit einem Zugriffstoken für private Apps oder über OAuth authentifizieren. Erfahren Sie mehr über diese Änderung und wie Sie eine API-Schlüssel-Integration migrieren, um stattdessen eine private App zu verwenden.

Mit dem Befehl zur Designvalidierung können Sie schnell automatisierte Tests für Ihr Design durchführen, um Probleme zu identifizieren, die vor der Einreichung auf dem Marketplace für Vorlagen behoben werden müssen. Diese werden in Ihrem CLI als eine Liste von [Fehler]- und [Erfolgs]-Meldungen zurückgegeben, die in Gruppen unterteilt sind, welche die Typen von Elements innerhalb eines Designs darstellen.

Bevor Sie ein Design validieren können, müssen Sie es zunächst mit hs upload in Ihren Account hochladen. Führen Sie dann den folgenden Befehl aus, um das hochgeladene Design zu validieren.


Argument	Description
`src` Erforderlich	Stamm-relativer Pfad zum Designordner im Design-Manager.


Argument	Description
`src` Erforderlich	Stamm-relativer Pfad zum Modulordner im Design-Manager.

Teilen Sie Ihr Feedback mit uns

War dieser Artikel hilfreich? Ja Nein

Dieses Formular dient dazu, Feedback zu unserer Entwicklerdokumentation zu sammeln. Wenn Sie uns Ihre Meinung zu HubSpot-Produkten mitteilen möchten, teilen Sie diese bitte im Ideenforum der Community.

Apps & Integrations

CMS

Developer References

Developer Community

App Ecosystem New

Template Marketplace

App Partner Program

CMS Reference Docs

HubSpot-CLI-Befehle

Ale Befehle anzeigen

Das CLI installieren

Nur in das aktuelle Verzeichnis installieren

Das CLI aktualisieren

Authentifizierung

init

Einen Account authentifizieren

Authentifizierte Accounts auflisten

Als Standard-Account festlegen

Einen Account entfernen

Ungültige Accounts entfernen

Interaktion mit dem Dateisystem des Entwicklers

Dateien auflisten

Dateien abrufen

Dateien hochladen

Eine Überwachung für den automatischen Upload festlegen

Dateien verschieben

Neue Dateien erstellen

Dateien entfernen

Dateien ignorieren

HubDB-Befehle

HubDB-Tabelle erstellen

HubDB-Tabelle abrufen

Zeilen in einer HubDB-Tabelle löschen

HubDB-Tabelle löschen

Befehle für serverlose Funktionen

Einen Funktion erstellen

Funktionen auflisten

Protokolle abrufen

Ein Geheimnis hinzufügen

Ein Geheimnis aktualisieren

Ein Geheimnis entfernen

Geheimnisse auflisten

Browser-Shortcuts öffnen

open

Befehlsabschluss

Designs und Vorlagen in Bezug auf SEO und Barrierefreiheit evaluieren

Designfeld-Selektoren für In-App-Hervorhebungen generieren

Modi

Environment variables

Validierung von Marketplace-Vorlagen

Design validieren

Modul validieren

Teilen Sie Ihr Feedback mit uns