HubSpot CLIコマンド

Last updated: 11月 13, 2023

CLIは@hubspot/cms-cliから@hubspot/cliに変更されました。古いcms-cliを使用している場合は、アンインストールしてから新しいバージョンをインストールする必要があります。

ご使用のバージョンを確認するには、hs --versionを実行します。

バージョン番号が3.0.0未満の場合は、古いバージョンです。

古いバージョンをアンインストールするには、npm uninstall -g @hubspot/cms-cliを実行します。

以降に記載するコマンドを使用すると、CLIでHubSpotアカウントを認証して、アカウントを利用できるようになります。CLIでのアカウント認証がまだ済んでいない場合は、まず、hs initを実行してhubspot.config.ymlファイルを作成します。このファイルに、接続されている全てのHubSpotアカウントの詳細が含まれます。以下のコマンドは、このファイルを操作するものです。

詳しくは、ローカル開発を開始するためのガイドをご覧ください。

パーソナルアクセスキーを使用して、HubSpotアカウントに対する認証を生成します。こちらでアクセスキーを生成することができます。既存のhubspot.config.ymlファイルがある場合は、このコマンドを使用して他のアカウントの資格情報を追加できます。例えば、サンドボックスアカウントを開発環境として使用できます。アカウントに使用する名前の入力が求められた際、この名前にスペースを含めることはできません。

Use this table to describe parameters / fields
Parameter	Description
`accountNameOrID`	新しい既定のアカウントをその名前（設定ファイルに設定されている名前）またはIDで識別します。

Use this table to describe parameters / fields
Parameter	Description
`accountNameOrID`	削除するアカウントをその名前（設定ファイルに設定されている名前）またはIDで識別します。

CLIを使用すると、デベロッパーファイルシステム（デザインマネージャーのファイルシステム）とやり取りできます。以降に記載するコマンドを使用すると、ローカルで新しいアセット（モジュール、テーマなど）を作成してアカウントにアップロードしたり、HubSpotアカウント内のファイルを一覧表示したりできます。また、既存のファイルをローカル環境にダウンロードすることもできます。


引数	Description
`dest` 任意	ファイルの一覧を表示する、リモートのデベロッパーファイルシステム上のディレクトリーを示すパス。省略した場合、既定でアカウントのルートが使用されます。


引数	Description
`src` 必須	HubSpotデザインツールのパス
`dest` 任意	ファイルを配置するローカルディレクトリーのパス（現在の作業ディレクトリーを基準にした相対パス）。この引数は、省略すると既定で現在の作業ディレクトリーになります。


オプション	Description
`--account`	取得元の`accountId`または名前を指定します。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。
`--overwrite`	取得したファイルで既存のファイルを上書きします。
`--mode`	HubSpotからファイルの下書きバージョンと公開バージョンのいずれを取得するかを指定します。詳細はこちらを参照してください。


引数	Description
`src` 必須	ローカルファイルのパス（現在の作業ディレクトリーを基準にした相対パス）。
`dest` 必須	HubSpotデザインツールのパス。新規のパスも指定できます。


オプション	Description
`--account`	取得元の`accountId`または名前を指定します。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。
`--mode`	アップロードされたファイルをHubSpotで公開するかどうかを指定します。詳細はモードを参照してください。
`--clean`	アップロード前に宛先ディレクトリーとその内容を削除するオプションのフラグ。


サブコマンド	Description
`filemanager`	指定したsrcディレクトリーをファイルマネージャーにアップロードします（デザインマネージャー上のデベロッパーファイルシステムではなく）。注：アップロードされたファイルは「公開」に設定され、URL経由で誰でも表示できるようになります。ファイルの表示に関する設定の詳細は、ヘルプドキュメントを参照してください。

ローカルディレクトリーを監視し、ディレクトリーでの変更の保存時にその変更内容を自動的にHubSpotアカウントにアップロードします。保存時に行った変更は即座に公開されます。

watchを使用する場合は、次の点に留意してください。

監視対象のファイルをローカル側で削除しても、HubSpotからは自動的に削除されません。ファイルを削除するには、--removeを使用します。
ローカル側でフォルダーの名前を変更すると、新しいフォルダーが新しい名前でHubSpotにアップロードされます。HubSpot上にある既存のフォルダーは自動的には削除されません。フォルダーを削除するには、--removeを使用します。


引数	Description
`src` 必須	ファイルが含まれているローカルディレクトリーのパス（現在の作業ディレクトリーを基準にした相対パス）。
`dest` 必須	HubSpotデザインツールのパス。新規のパスも指定できます。


オプション	Description
`--account`	取得元の`accountId`または名前を指定します。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。
`--mode`	アップロードされたファイルをHubSpotで公開するか下書きとして保存するかを指定します。モードの使用についての詳細をご確認ください。
`--initial-upload`	ファイル保存が発生する前に初回のアップロードを実行します。`-i`のエイリアスがサポートされます。
`--remove`	ローカル環境にないファイルがHubSpotアカウント上にある場合に削除を実行します。
`--notify=<path/to/file>`	watchが起動され、作業がアイドル状態になると、指定されたファイルにログを記録します。


引数	Description
`src` 必須	ファイルが含まれているリモートのデベロッパーファイルシステム上のディレクトリーへのパス。
`dest` 必須	デベロッパーファイルシステム内の移動先パス。


オプション	Description
`--account`	ファイル移動先となる`accountId`または名前を指定します。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。


引数	Description
`type` 必須	アセットのタイプ。サポートされるタイプは次のとおりです。 `module` `template` `website-theme` `function` `webpack-serverless` `react-app` `vue-app`
`name` 必須	新しいアセットの名前
`dest` 任意	新規アセットの宛先フォルダー（現在の作業ディレクトリーを基準にした相対パス）。省略すると、既定で現在の作業ディレクトリーになります。


引数	Description
`path` 必須	HubSpotデザインツールのパス


オプション	Description
`--account`	ファイルを削除する`accountId`または名前を指定します。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。

既定でHubSpotによって自動適用されるルールがあります。この既定を上書きする方法はありません。

以下は常に無視されます。

hubspot.config.yml/hubspot.config.yaml
node_modules - 依存関係
.* - 非表示のファイル／フォルダー
*.log - NPMエラーログ
*.swp - vim状態のスワップファイル
Icon\\r - Mac OSのカスタムFinderアイコン
__MACOSX - Macリソースフォーク
~ Linuxバックアップファイル
Thumbs.db - Windows画像ファイルキャッシュ
ehthumbs.db - Windowsフォルダー設定ファイル
Desktop.ini - Windowsカスタムフォルダー属性情報
@eaDir - サーバーによってサムネイルが保存されるWindows Synology DiskStationの「非表示」フォルダー

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


引数	Description
`src` 必須	HubDBテーブルの生成に使用するローカルJSONファイル。


オプション	Description
`--account`	HubDBを作成する`accountId`または名前を指定します。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。


引数	Description
`tableId` 必須	HubDBダッシュボードで確認可能なHubDBテーブルのid。
`dest`	`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" } } ] }


引数	Description
`tableId` 必須	HubDBダッシュボードで確認可能なHubDBテーブルのid。


オプション	Description
`--account`	HubDBの行を消去する`accountId`または名前を指定します。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。


引数	Description
`tableId` 必須	HubDBダッシュボードで確認可能なHubDBテーブルのid。


オプション	Description
`--account`	HubDBを削除する`accountId`または名前を指定します。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。


引数	Description
`--account`	hubspot.configからのHubSpotアカウントのニックネーム。defaultAccountが`hubspot.config`内に設定されていない場合、このパラメーターは必須です。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。
`--json`	全ての関数のデータを含むJSONがコマンドラインに出力されます。JSONデータには、ポータルID、関数ID、ルーティング、アセットの未加工パス、メソッド、シークレット、作成日、最終変更日が含まれます。


引数	Description
`endpoint-name` 必須	serverless.jsonファイル（関数ファイルへのパスではない）で定義されたエンドポイント名。
`--file`	function.logにログを出力します。
`--follow`	サーバーレス関数の実行時に最新の情報を取得するために、ログの末尾を表示します。
`--latest`	最新のログのみを出力します
`--account`	hubspot.configからのHubSpotアカウントのニックネーム。defaultPortalがhubspot.config内に設定されていない場合、このパラメーターは必須です。古いバージョンのCLIとの下位互換性を確保するために、`--portal`のエイリアスがサポートされます。
`--compact`	ログの出力／情報を非表示にします。正常終了／エラーと実行時間を返します。
`--limit=<number>`	ログ出力の量を制限します

A server error occurred: WARNING: The logs for this function have exceeded the 4KB limitというエラーが発生した場合、ログが大きすぎることを意味しています。このエラーの原因は、巨大なオブジェクトが含まれるコンソールログまたは多数のコンソールログを出力しようとしたことにあります。解決するには、ログの出力を抑えるように調整してから、エンドポイントに対しコマンドを実行し直してみてください。


引数	Description
`secret-name` 必須	名前またはシークレット。
`secret-value` 必須	シークレットの値（認証の詳細など）。


引数	Description
`secret-name` 必須	シークレットの名前。後でシークレットを参照するために使用します。任意の固有の値を指定できますが、利便性を考えて、シンプルなものにすることをお勧めします。


引数	Description
`secret-name` 必須	削除するシークレットの名前。


引数	Description
`shortcut` 必須	ブラウザーで開くショートカットの完全な名前またはショートカットのエイリアスを指定します。


引数	Description
`--list` 必須	全てのショートカット、エイリアス、および参照先のリストを表示します。

GoogleのLighthouseツールを使用して、テーマとテンプレートが以下のカテゴリーにどの程度準拠しているかを評価します。

アクセシビリティー
ウェブのベストプラクティス
パフォーマンス
PWA
SEO（検索エンジン最適化）ツール

以下のタイプのテンプレートが評価されます。

ランディングページ
ウェブサイトページ
ブログ記事
ブログリストページ

Lighthouseのエラーが原因でスコアを生成できないテンプレートがある場合は、これらのテンプレートのリストが提供されます。

Use this table to describe parameters / fields
Parameter	Description
`--theme-path` 必須	デザインマネージャーのテーマへのパス。
`--verbose`	このパラメーターを除外すると、返されるスコアは全てのテーマのテンプレートの平均になります（既定）。このパラメーターを含めると、個々のテンプレートスコアが表示されます。また、各テンプレートのLighthouseレポートのリンクも取得できます。
`--target`	このパラメーターは、それぞれのスコアを表示するために、デスクトップまたはモバイルのいずれにもすることができます。既定では、ターゲットはデスクトップです。

テーマを作成する際に次のコマンドを使用することで、CSSセレクターをテーマフィールドにマッピングするeditor-preview.jsonファイルを生成できます。これにより、コンテンツ作成者がフィールドのスタイル設定オプションの更新によってどのテーマ要素が影響を受けるかを確認できるようになります。

このコマンドを実行した後、editor-preview.jsonファイルを確認し、フィールドとセレクターが適切にマッピングされるように調整する必要があります。このコマンドでは、どのフィールドがどのセレクターに影響するかについて基本的な推測が行われるだけなので、テーマがどのように作成されているかに基づいて修正する必要があります。例えばこのコマンドでは、モジュールがスタイル設定をオーバーライドしていたり、マクロが使用されたりしていても検出できません。テーマエディターフィールドハイライト機能について詳細をご確認ください。

--modeオプションを指定すると、HubSpotにアップロードされたローカルでの変更を公開するかどうかを指定できます。このオプションは各コマンドに追加することも、hubspot.config.ymlファイル内に既定として設定することもできます。

--modeのオプションは、--mode=draft、--mode=publishの2つです。

--modeを指定する場合、次の優先順位が適用されます。

コマンドに--modeを含めると、他の全ての設定よりも優先されます。
hubspot.config.yml内でアカウントごとにdefaultModeを設定すると、コマンドに毎回--modeを含める必要がなくなります。この場合、最上位の設定よりも優先されます。
hubspot.config.yml内で最上位にdefaultModeを設定すると、全てのアカウントに対して既定で--modeが設定されます。これにより既定の動作よりも優先されます。
--modeの既定の動作はpublishです。


名前	Description
`HUBSPOT_PORTAL_ID` 必須	HubSpotアカウントID。
`HUBSPOT_PERSONAL_ACCESS_KEY` 推奨	HubSpotアカウント上の特定のユーザーのパーソナルアクセスキー。全ての更新がこのユーザーに関連付けられます。
`HUBSPOT_CLIENT_ID`	OAuthクライアントID。
`HUBSPOT_CLIENT_SECRET`	OAuthシークレット。

注：2022年11月30日をもってHubSpot APIキーのサポートは終了しました。HubSpot APIキーの使用を続けると、アカウントやデータに対するセキュリティー上のリスクが生じます。なお、HubSpotによってこの廃止段階中にお客さまのキーが無効となった可能性があります。

認証には、代わりに非公開アプリのアクセストークンまたはOAuthを使用する必要があります。この変更の詳細と、非公開アプリを使用するようにAPIキーを移行する方法をご確認ください。

テーマの検証コマンドを使用すると、テーマの自動テストを素早く実行して、アセットマーケットプレイスへの提出前に修正しておく必要がある問題を特定できます。これはCLIでは、テーマ内のアセットを表すグループに分けられ、エラーと成功のリストとして返されます。

テーマを検証する前に、まずはhs uploadを使用してアカウントにアップロードする必要があります。次に、以下のコマンドを実行して、アップロードされたテーマを検証します。


引数	Description
`src` 必須	デザインマネージャーのテーマフォルダーへのルート相対パス。

テーマの検証と同様、このコマンドを使用すると、モジュールの自動テストを素早く実行して、アセットマーケットプレイスへの提出前に修正しておく必要がある問題を特定できます。

モジュールを検証する前に、まずはhs uploadを使用してアカウントにアップロードする必要があります。次に、以下のコマンドを実行して、アップロードされたモジュールを検証します。


引数	Description
`src` 必須	デザインマネージャーのモジュールフォルダーへのルート相対パス。

アンケートにご協力ください

参考になりましたか？はいいいえ

こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。

アプリと連携

CMS

リファレンス

コミュニティー

アプリマーケットプレイス New

CMSアセットマーケットプレイス

アプリ パートナー プログラム

CMS Reference Docs

HubSpot CLIコマンド

全てのコマンドを表示する

CLIをインストールする

現在のディレクトリーにのみインストール

CLIを更新する

認証

init

アカウントを認証する

認証されたアカウントを一覧表示する

既定のアカウントを設定する

アカウントを削除する

無効なアカウントを削除する

デベロッパー ファイル システムとの連携

ファイルを一覧表示する

ファイルをフェッチする

ファイルをアップロードする

自動アップロード用のwatchを設定する

ファイルを移動する

新規ファイルを作成する

ファイルを削除する

ファイルを無視する

HubDBコマンド

HubDBテーブルの作成

HubDBテーブルの取得

HubDBテーブルの行の消去

HubDBテーブルの削除

サーバーレス関数のコマンド

関数を作成する

関数を一覧表示する

ログを取得する

シークレットを追加する

シークレットを更新する

シークレットを削除する

シークレットを一覧表示する

ブラウザーのショートカットを開く

open

コマンドの補完

SEOとアクセシビリティーの観点からテーマとテンプレートを評価する

アプリ内ハイライト表示用のテーマ フィールド セレクターを生成する

モード

Environment variables

マーケットプレイスアセットの検証

テーマの検証

モジュールを検証する

アンケートにご協力ください

アプリパートナープログラム

デベロッパーファイルシステムとの連携

アプリ内ハイライト表示用のテーマフィールドセレクターを生成する