Shopify CLI Cheatsheet

Shopify CLI (Command Line Interface) is a set of tools provided by Shopify that allows developers to interact with their Shopify stores using the command line. It facilitates various tasks related to theme development, app development, and store management.

Benefits of deploying your theme with Shopify CLI include:

1. Efficiency: Shopify CLI streamlines the theme development process by providing commands for tasks such as creating, updating, and managing themes. This increases development efficiency.
2. Local Development: Developers can use Shopify CLI for local theme development, enabling them to work on themes offline and push changes to the live store when ready.
3. Collaboration: Shopify CLI supports collaboration among developers by allowing them to share and synchronize their work easily. This is particularly useful for teams working on a common theme.
4. Automated Deployment: With Shopify CLI, you can automate the deployment of themes, reducing the risk of errors and ensuring a smoother transition from development to production.
5. Version Control Integration: It integrates well with version control systems (e.g., Git), allowing developers to track changes, collaborate effectively, and manage different versions of the theme.
6. Quick Setup: Shopify CLI simplifies the setup process for new themes, reducing the time and effort required to create a new theme from scratch or set up an existing theme locally.
7. Theme Preview: Developers can use Shopify CLI to preview their theme changes before making them live, helping to catch issues and ensure a seamless user experience. In summary, Shopify CLI enhances the development workflow for Shopify themes, providing a more efficient and collaborative environment. It is a valuable tool for developers looking to streamline their theme development process on the Shopify platform.

Setup a local shopify theme

If you want to implement a lot of custom code into your shopify theme, perhaps your even developing your own shopify theme from scratch then you will surely want to implement a shopify local development environment.

This approach to shopify theme development allows you to:

• Code themes using your preferred code editor.
• Keep your changes under git version control
• Live reload coding changes

  Prerequisites

Install / upgrade shopify cli with homebrew

Version 3.49.5

Get Theme List

You can get the myshopify url from your list of domains ‘settings > domains’ Firstly this command will try log you in to your store. Upon success a browser window will open with some login prompts for you to complete. Then back in your terminal you will see a lovely list of all the themes on your shopify site.

I like to run the theme list command before I do anything as its a nice, safe command to run and it will tell you if you are logged in correctly.

shopify theme list --store store_name.myshopify.com

Trouble shooting login issues

If you run the shopify theme list command and get the following error

You are not authorized to edit themes on
"your-shop.myshopify.com".

You can't use Shopify CLI with development stores if you only have Partner
staff member access. If you want to use Shopify CLI to work on
development store, then you should be the store owner or create a staff
account on the store.

If you're the store owner, then you need to log in to the store directly
using the store URL at least once (for example, using
"https://your-shop.myshopify.com/admin") before you log in using
Shopify CLI. Logging in to the Shopify admin directly connects the
development store with your Shopify login.

Try fix this by running a auth logout first then re-run the shopify theme list --store store_name.myshopify.com

shopify auth logout

Once logged out, you can run theme list command again. The theme list command will try log you in by way of prompting you to open a browser to login. So hit enter when you see the prompt

Start Local Development Enviroment

The below command is your bread and butter for local development.

it will eventually sync your local enviroment with the production enviroment. Give it some time. Its not fast to begin with.

Once the files have been synced then you can click the local address it dispays http://127.0.0.1:9292 to view your site locally. Any changes you make will be live reloaded at http://127.0.0.1:9292

shopify theme dev --store store_name.myshopify.com

Shopify Theme

Some other commands you might want to experiment with

theme check
theme delete

theme info
theme init
theme language-server
theme list
theme open
theme package
theme publish
theme pull
theme push
theme share

Integrate with GitHub

Shopify theme deployment one option is to integrate with github

On your local system, cd into your local site folder.

Deploy theme with shopify CLI

cd my_shopify_site_files/

Logout

logout of the current session if you are not 100% certain of your current logged in account

shopify logout

Login to your site using shopify cli

shopify login --store=https://example.myshopify.com

A browser will launch and you need to choose the associated shopify account to login with.

Pull theme down to local files with cli

Pull all settings and content updates from remote server from the current live theme.

• A list of themes will be returned
• Choose the first one in the list if you want the live theme pulled

shopify theme pull

Deploy theme with cli

shopify theme push

You will be given the option of what theme you want to deploy to. This is a handy feature as it allows you to test your changes on one of the backup instances of your theme before deploying to the live theme.

Partial deploy - only deploy one file

shopify theme push --only assets/styles.css.liquid --allow-live`

Deploy to unpublished theme

If you omit the --allow-live flag, you will be asked which theme you want to deploy to. This can be handy for doing tests on unpublished themes using the theme preview mode to preview the your deployments first before deploying to the published theme.