Shopify CLI コマンド一覧|テーマ開発

テーマ開発
この記事でわかること
・Shopify CLIコマンド一覧

Shopify CLI コマンド一覧

Shopify Online Store2.0でテーマ開発をするなら必須のShopify CLIコマンド一覧です。

shopify theme init

ローカルで新しいテーマを作成するためのCLIコマンドです。

このコマンドは、gitリポジトリをローカルに複製します。テーマ構築をするために一番初めに使うCLIコマンドです。

このコマンドは、Shopifyサンプルテーマである「Dawn」をローカルにコピーします。

shopify theme init

? Theme name
> DawnBFCM
┏━━ Cloning https://github.com/Shopify/dawn.git into DawnBFCM... ━━━━━
┃ ██████████████████████████████████████████████████████████████ 100%
┗━━ ✓ Cloned into DawnBFCM ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

shopify populate <object>

このコマンドは、テーマをテストするためのCLIコマンドです。

商品・顧客・注文などのサンプルデータをストアに入力してチェックしてくれます。

<object>にテストデータのタイプを指定します。

以下は、商品のデータを使ってテストしたい場合です。

shopify populate products

このコマンドを入力すると、以下が出力されます。

✓ spring glitter added to johns-apparel.myshopify.com at https://johns-apparel.myshopify.com/admin/products/6572161466504
✓ frosty frost added to johns-apparel.myshopify.com at https://johns-apparel.myshopify.com/admin/products/6572161499272
✓ floral voice added to johns-apparel.myshopify.com at https://johns-apparel.myshopify.com/admin/products/6572161532040
✓ dark bird added to johns-apparel.myshopify.com at https://johns-apparel.myshopify.com/admin/products/6572161564808
✓ long shape added to johns-apparel.myshopify.com at https://johns-apparel.myshopify.com/admin/products/6572161597576
Successfully added 5 Products to johns-apparel.myshopify.com
⭑ View all Products at https://johns-apparel.myshopify.com/admin/products

shopify theme serve

このコマンドは、ローカルでストアをカスタマイズするためのCLIコマンドです。

このコマンドを使用すると、ストアへのログインを求められるので、データを使いたいストアにログインします。

shopify theme serve

コマンドを使用すると以下を返します。

  • http://127.0.0.1:9292にある開発テーマへのリンク。このURLは、CSSとセクションへのローカル変更をホットリロードしたり、ファイルが変更されたときにページ全体を更新したりできるため、ストアのデータを使用してリアルタイムで変更をプレビューできます。このプレビューは、GoogleChromeでのみ利用できます。
  • Shopify管理者のテーマのエディターへのリンク
  • 他人に共有できるプレビューリンク
┏━━ Viewing theme... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
┃ * Syncing theme #108267175958 on johns-apparel.myshopify.com
┃ ████████████████████████████████████████████████████ 100%
┃
┃ Serving .
┃
┃ Please open this URL in your browser:
┃ http://127.0.0.1:9292
┃
┃ Customize this theme in the theme editor:
┃ https://johns-apparel.myshopify.com/admin/themes/108267175958/editor
┃
┃ Share this theme preview:
┃ https://johns-apparel.myshopify.com/?preview_theme_id=108267175958
┃
┃ (Use Ctrl-C to stop)
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

shopify theme check

このコマンドは、テーマのリントを行うためのCLIコマンドです。

テーマ内のliquidがベストプラクティスに従っているかをチェックするために使用します。

shopify theme check

shopify theme push

このコマンドは、ローカルで作成したテーマをShopifyストアにプッシュするためのCLIコマンドです。

ストア内のテーマリストから上書きするテーマの選択を求められます。

フラグを使用して既存のテーマを上書きせずにテーマをアップロードすることができます。(–unpublished)

shopify theme push

? Select theme to push to (Choose with ↑ ↓ ⏎, filter with 'f')
  1. Dawn [live]
> 2. Dawn - BFCM [unpublished]

shopify theme list

このコマンドは、ストア内のテーマの一覧を表示するためのCLIコマンドです。

shopify theme list

shopify theme publish

このコマンドは、テーマライブラリから未公開のテーマを公開するためのCLIコマンドです。

テーマIDを指定しない場合は、コマンド入力後に公開するテーマの選択を求められます。

shopify theme pushでローカルテーマを公開する場合は、最初に実行する必要があります。

shopify theme publish
? Select theme to push to (Choose with ↑ ↓ ⏎, filter with 'f')
> 1. Dawn - BFCM [unpublished]

Shopify CLIのアップデート方法

CLIを使っているとたまに、下記のような警告が出て使えなくなります。

⭑ A new version of Shopify CLI is available! You have version 2.7.4 and the latest version is 2.19.0.

  To upgrade, follow the instructions for the package manager you’re using:
  https://shopify.dev/tools/cli/troubleshooting#upgrade-shopify-cli

その場合は、CLIをアップデートしてあげましょう。

アップデート方法は以下の記事を参考にしてください。