HubSpot CLIコマンド

Last updated: 7月 18, 2022

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

ご使用のバージョンを確認するには、次のコマンドを実行します。

hs --version

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

古いバージョンをアンインストールするには、次のように実行します。

npm uninstall -g @hubspot/cms-cli

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

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


引数	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で公開するかどうかを指定します。詳しくは「モード」のセクションをご覧ください。


サブコマンド	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` `global-partial` `website-theme` `function` `webpack-serverless` `react-app` `vue-app`
`name` 必須	新しいアセットの名前
`dest` 任意	新規アセットの宛先フォルダー（現在の作業ディレクトリーを基準にした相対パス）。省略すると、既定で現在の作業ディレクトリーになります。


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


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


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


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


引数	Description
`tableId` 必須	HubDBダッシュボードで確認可能なHubDBテーブルのid。
`dest`	`hubdb.json`ファイルの格納先にするローカルパス。


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


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


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


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


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

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


引数	Description
`endpoint-name` 必須	serverless.jsonファイルで定義されたエンドポイント名。関数ファイルへのパスではありません。


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

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


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


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


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


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


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

既定で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

--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です。

CLIのv1.0.10（2020年3月リリース）からv1.0.11では、hs initを実行すると、設定ファイルが/Users/<username>/hubspot.config.ymlに配置されていました。

設定ファイルの場所を明確にするために、このコマンドを実行すると、設定ファイルがコマンドを実行したフォルダー内に配置されるように従来の動作に戻しました。設定ファイルは移動しなくても、問題なく機能します。ファイルをプロジェクトファイルとまとめて管理する場合は、ファイルをこのディレクトリーからプロジェクトフォルダーに移動しても問題ありません。このファイルには認証の資格情報が含まれているので、バージョン管理にはコミットしないでください。

上記以外のバージョンのCMS-CLIを使用してこのコマンドを実行した場合、コマンドを実行したフォルダー内に設定ファイルが配置されます。

defaultPortal: DEV portals: # Sample apikey entry, manually entered - name: DEV portalId: 123 defaultMode: 'publish' authType: apikey apiKey: xxxxxx-xxxxx-xxxxx-xxxxx-xxxxx # Sample personal access key entry, generated from running hs auth personalaccesskey or hs init - name: PROD portalId: 456 authType: personalaccesskey personalAccessKey: >- xxxxx-xxxxxx-xxxxxxx-xxxxxx-xxxxx-xxxxxxx-xxxxxxxx auth: tokenInfo: accessToken: >- xxxxx-xxxxxx-xxxxxxx-xxxxxx-xxxxx-xxxxxxx-xxxxxxxx expiresAt: '2020-01-01T00:00:00.000Z'


名前	Description
`defaultPortal` 任意	操作するアカウントを指定する`--account=`を使用してコマンドを実行する必要がなくなります。コマンドの実行時に`--account=`が指定されていない場合には`defaultPortal`が使用されます。
`defaultMode` 任意	アカウント、下書き、公開に使用するモード。
`allowUsageTracking` 任意	HubSpotにローカル開発ツールの使用状況をトラッキングする権限を許可するかどうかを指定します。既定では`true`です。全てのトラッキングを無効にするには`false`を設定します。


名前	Description
`portalId` 必須	認証を設定するアカウントのアカウントID。
`authType` 必須	特定の入力に使用される認証方式。`personalaccesskey`または`apikey`。※認証方式値の設定パラメーターも指定する必要があります。`authType`の指定方法に加えて、`personalAccessKey`または`apiKey`キーの設定方法については、前述の例を参照してください。
`name` 任意	アカウント名を指定するパラメーター。コマンドの操作対象となるアカウントを指定するために使用できます。上記の例では`--account=123`と`--account=DEV`はいずれもアカウントID 123を操作します。この名前にはスペースを含めることができません。
`defaultMode` 任意	アカウント、下書き、公開に使用するモード。


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

注：2022年11月30日以降、HubSpot APIキーをHubSpot APIにアクセスするための認証方法として使用することはできなくなります。さらに、2022年7月15日以降は、HubSpot APIキーがまだ生成されていないアカウントでは、APIキーを作成できなくなります。

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


引数	Description
`src` 必須	ローカルテーマフォルダーのパス（現在の作業ディレクトリーを基準にした相対パス）。

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

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

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

アプリと連携

CMS

リファレンス

コミュニティー

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

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

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

CMS Reference Docs

HubSpot CLIコマンド

インストール

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

アップグレード

一般的なコマンド

help

init

auth

accounts list

accounts use

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

list

fetch

upload

watch

move

create

remove

HubDBコマンド

HubDBテーブルの作成

HubDBテーブルの取得

HubDBテーブルの行の消去

HubDBテーブルの削除

HubDBテーブルのJSON

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

関数のリスト

ログ

シークレットの追加

シークレットの更新

シークレットの削除

シークレットのリスト

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

open

コマンドの補完

ローカルテンプレートの形式

ローカルモジュールの形式

.hsignore

モード

認証

最上位の設定パラメーター

アカウント設定パラメーター

Environment variables

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

テーマの検証

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

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

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