Shopify CLI 2.x

Clones a Git repository to your local machine to use as the starting point for building a theme.

If no Git repository is specified, then this command creates a copy of Dawn, Shopify's example theme, with the specified name in the current folder. If no name is provided, then you're prompted to enter one.

Uploads the current theme as the specified theme, or a development theme, to the store that you're connected to.

This command also returns the following information:

• A link to your development theme at http://127.0.0.1:9292. This URL can hot reload local changes to CSS and sections, or refresh the entire page when a file changes, enabling you to preview changes in real time using the store's data.

  You can specify a different network interface and port using --host and --port.

• A link to the editor for the theme in the Shopify admin.

• A preview link that you can share with other developers.

If you already have a development theme for your current environment, then this command replaces the development theme with your local theme. You can override this using the --theme-editor-sync flag.

Development themes are deleted when you run shopify logout. If you need a preview link that can be used after you log out, then you should share your theme or push to an unpublished theme on your store.

You can run this command only in a directory that matches the default Shopify theme folder structure.

Calls and runs Theme Check to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. Learn more about the checks that Theme Check runs.

Lists the themes in your store, along with their IDs and statuses.

Returns links that let you preview the specified theme. The following links are returned:

• A link to the editor for the theme in the Shopify admin.
• A preview link that you can share with other developers.

If you don't specify a theme, then you're prompted to select the theme to open from the list of the themes in your store.

Retrieves theme files from Shopify.

If no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.

Uploads your local theme files to Shopify, overwriting the remote theme if specified.

If no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your store.

You can run this command only in a directory that matches the default Shopify theme folder structure.

This command returns the following information:

• A link to the editor for the theme in the Shopify admin.
• A preview link that you can share with others.

If you use the --json flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.

Sample output:

Uploads your theme as a new, unpublished theme in your theme library. The theme is given a randomized name.

This command returns a preview link that you can share with others.

Publishes an unpublished theme from your theme library.

If no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes in your store.

You can run this command only in a directory that matches the default Shopify theme folder structure.

If you want to publish your local theme, then you need to run shopify theme push first. You're asked to confirm that you want to publish the specified theme. You can skip this confirmation using the --force flag.

Packages your local theme files into a ZIP file that can be uploaded to Shopify.

Only folders that match the default Shopify theme folder structure are included in the package.

The ZIP file uses the name theme_name-theme_version.zip, based on parameters in your settings_schema.json file.

Deletes a theme from your store.

You can specify multiple themes by ID. If no theme is specified, then you're prompted to select the theme that you want to delete from the list of themes in your store.

You're asked to confirm that you want to delete the specified themes before they are deleted. You can skip this confirmation using the --force flag.

Lists the available commands and describes what they do.

You can also use the help command or options to get more detailed information about a specific command:

Authenticates and logs you into the specified store with Shopify CLI.

The --store flag accepts the following inputs:

The specified store can be a development store or a Shopify store. You need to have collaborator access to the store, or be a staff member or owner of the store.

To switch between stores that you have access to, use shopify switch.

Logs you out of the Shopify account or Partner account and store.

The logout command clears credentials. You need to reauthenticate the next time that you connect to a store.

Adds example data to your store for testing your app or theme’s behavior.

The populate command lets you specify which type of data you're populating, and how many to create:

Displays the store that you're currently connected to.

Example output:

Switches between stores without logging out and logging in again.

If you enter this command without a --store flag, then you're prompted to select a store associated with your account.

The --store flag accepts the following inputs:

Displays the version of Shopify CLI that you're running.

Example output:

Configures Shopify CLI options. There are two available options: analytics and feature.

Configures anonymous usage reporting by enabling or disabling analytics.

Configures active feature sets in the CLI.

This command is used for development and debugging work on the CLI tool itself. Unless you're developing the tool, don't alter this command. Review the Shopify CLI development guide for more information.

Determines which Partner organization you're logged in to, or which store you're logged in to as a staff member.

Example output: