Shopify CLI 2.x

Shopify CLI 2.x and 3.x can be run in the same environment. CLI 2.x is run globally, while CLI 3.x is connected to specific projects. They also use a different base syntax, so they don’t conflict with one another.

To avoid confusion when using Shopify CLI 3.x, you can uninstall your previous version of Shopify CLI.

If you need to, you can install Shopify CLI 2.x. You should only install Shopify CLI 2.x if you are continuing work on an existing app that hasn't been migrated to Shopify CLI 3.x, or if Shopify CLI 2.x is explicitly specified in the prerequisites for a feature.

Until Shopify CLI 2.x is officially sunset, Shopify provides minor updates. Learn how to upgrade between minor versions of Shopify CLI 2.x.

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:

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:

This reference lists the Shopify CLI commands for apps. The basic syntax for these commands is shopify app <command>.

To get help and tips from the command line, type a command with the flag -h:

Creates a project in a new subdirectory of the current directory.

Specify one of the following frameworks in your command after create:

• rails (for Rails)
• php (for Laravel)
• node (for Express)

After you enter the command, you're prompted to name your project.

Connects an existing Shopify CLI project to a Partner account or to a specific Shopify development store.

The connect command creates the project's .env and .shopify-cli.yml files if they don't exist, or updates the files if they do exist.

• .env contains sensitive information that provides functionality to your app, such as the app key. As a result, this file shouldn't be saved to a version control system.
• shopify-cli.yml contains insensitive information required for a project to work with Shopify CLI, such as the project type.

This command is useful if you're working on one project across multiple computers, or if you're collaborating with other developers using a version control system like Git.

Deploys the current app to a hosting service. Currently, the only option is Heroku.

Opens your local development app in your default browser.

Starts a local development server for your project, creates a public ngrok tunnel to your localhost, and updates your app URLs. You can override the app URL updates using the --no-update flag.

You need to authenticate with ngrok using the shopify app tunnel auth command before you run this command.

You need to create an ngrok account and auth token to preview your app using Shopify CLI.

Controls an HTTP tunnel to your local development app using ngrok. With the tunnel command, you can authenticate with ngrok and start or stop the tunnel.

To authenticate with ngrok, you need to create an ngrok account, and then create an authentication token from your ngrok dashboard. Copy your token and use it with the auth command:

To learn more about creating a token, refer to ngrok’s documentation.

You need to run this command before you start a new tunnel using the tunnel start or serve commands.

Start an ngrok tunnel to your app in your localhost development environment.

You need to authenticate with ngrok using the shopify app tunnel auth command before you run this command.

You need to create an ngrok account and auth token to preview your app using Shopify CLI.

Stop the running ngrok tunnel:

This page lists Shopify CLI commands for creating, registering, and pushing app extensions.

Generates a new extension project in a subdirectory of your app. To specify the type and name of your extension, you can use the interactive prompts or specify them as parameters on the command.

Starts a local server that can be rendered in the development store. This command must be run from your extension’s directory. The server will continue to run until you press Ctrl+C.

In versions 1.11.0 and later, this command creates an HTTP tunnel to your local development extension using ngrok. You need to authenticate with ngrok using the shopify app tunnel auth command before you run this command.

You need to create an ngrok account and auth token to preview your app using Shopify CLI.

Serving the extension requires using an internal node module called @shopify/admin-ui-extensions-run. Updating the CLI doesn't update the node modules automatically, so you might need to update this package manually. Run the following commands to update to the latest release:

Creates your app extension and associates it with an app in your Partner organization. This step should be done only once for each app extension.

Before you can push your code to Shopify, you need to create an app in your Partner Dashboard that you want to register your extension to. When you run this command, you're prompted to select an app from the list of apps in your Partner organization.

Connects your local project directory to an existing app in your Partner organization.

This command is intended to help teams collaborate on the same extension code.

Each developer can clone the extension code locally, and then run shopify extension connect to populate the local .env file with the client credentials required to push changes to the extension.

Uploads your extension code to Shopify. You need to run this command before you can publish your extension from the Partner Dashboard. You need to register your extension before you can push it to Shopify.

After a successful push, the CLI generates a link to the Partner Dashboard, where you can create a new version and publish your extension.

If you want to push your app extension to Shopify programmatically, then you can also pass your extension ID, client ID, and client secret as parameters with this command:

Learn more about running Shopify CLI in a CI/CD pipeline.