スタッフブログ

HubSpot CLIとは

HubSpot CLIは、HubSpotのCMSをコマンドラインから操作できる開発ツールです。テーマやモジュールの作成時に、効率的な開発環境を提供します。ローカル環境で作業しながら、HubSpotのCMSと簡単に連携できるため、開発者にとって非常に便利なツールとなっています。
詳細については、HubSpot開発者ドキュメントをご参照ください。

インストール方法

HubSpot CLIをインストールするには、以下のコマンドを実行します。
グローバルインストール

npm install -g @hubspot/cli

copy

ローカルインストール

npm install @hubspot/cli

copy

CLIの更新

最新バージョンにアップデートする場合

npm i -g @hubspot/cli@latest

copy

アカウントの認証設定

HubSpot CLIでは、バージョン7.4から認証方法が改善されました。

CLI バージョン 7.4 以降

現在はこちらの方法が推奨されています。
このコマンドを実行すると、~/.hscli/config.ymlに設定ファイルが作成され、複数のHubSpotアカウントを1つのファイルで一元管理できます。
プロジェクトごとに設定ファイルを作る必要がありません。

hs account auth

copy

CLI バージョン 7.4 以前

hs init

copy

このコマンドはhubspot.config.ymlを作成し、1つのアカウントを管理します。プロジェクトごとに設定ファイルが必要になります。
こちらのコマンドも使用できますが、hs account authの使用が推奨されています。

アカウント一覧の確認

登録されているアカウントを確認できます。

hs accounts list

copy

基本的な操作コマンド

ファイルの取得

HubSpotからローカル環境へファイルをダウンロードします。

hs fetch <src> <dest>

copy

• <src>: HubSpot上のファイルパス

• <dest>: ローカルの保存先パス

ファイルのアップロード

ローカルファイルをHubSpotへアップロードします。

hs upload <src> <dest>

copy

• <src>: ローカルのファイルパス

• <dest>: HubSpot上の保存先パス

ファイルの監視（自動アップロード）

ローカルファイルを編集するたびに自動的にHubSpotへ反映されます。

hs watch <src> <dest>

copy

ローカルプレビュー

テーマをローカル環境でプレビューできます。

hs theme preview <src> <dest>

copy

プレビューは以下のURLでアクセスできます

https://hslocal.net:3000/

copy

ブラウザでこのURLを開くことで、本番環境にアップロードする前にテーマの見た目や動作を確認できます。

まとめ

HubSpot CLIを活用することで、HubSpot CMSの開発効率を向上させることができます。
特にwatchコマンドによる自動アップロード機能は、リアルタイムでの開発を可能にし、作業時間の短縮につながります。
ぜひHubSpot CLIを導入して、快適な開発環境を構築してください。