Skip to main content

Shopify CLI

Shopify CLI is a command-line interface tool that helps you generate and work with Shopify apps, themes and custom storefronts. You can also use it to automate many common development tasks.

Anchor to requirementsRequirements

Anchor to installationInstallation

This installs Shopify CLI globally on your system, so you can run shopify commands from any directory. Find out more about the available commands by running shopify in your terminal.

npm install -g @shopify/cli@latest

Anchor to commandsCommands

Shopify CLI groups commands into topics. The command syntax is: shopify [topic] [command]. Refer to each topic section in the sidebar for a list of available commands.

Or, run the help command to get this information right in your terminal.

Terminal

shopify help

Anchor to upgradeUpgrade Shopify CLI

We recommend that you always use the latest version of Shopify CLI if possible. To upgrade, run version to check the current version and determine if there are any updates available. Run the install command to upgrade to the latest CLI version.

Terminal

shopify version
> Current Shopify CLI version: 3.50.0
> 💡 Version 3.51.0 available!

npm install -g @shopify/cli@latest

Anchor to network-proxyNetwork proxy configuration

When working behind a network proxy, you can configure Shopify CLI (version 3.78+) to route connections through it:

  1. Set the proxy for HTTP traffic:

    export SHOPIFY_HTTP_PROXY=http://proxy.com:8080

  2. Optionally, set a different proxy for HTTPS traffic:

    export SHOPIFY_HTTPS_PROXY=https://secure-proxy.com:8443

    If not specified, the HTTP proxy will be used for all traffic.

  3. For authenticated proxies, include credentials in the URL:

    export SHOPIFY_HTTP_PROXY=http://username:password@proxy.com:8080

Anchor to reportingUsage reporting

Anonymous usage statistics are collected by default. To opt out, you can use the environment variable SHOPIFY_CLI_NO_ANALYTICS=1.

Anchor to contributeContribute to Shopify CLI

Shopify CLI is open source. Learn how to contribute to our GitHub repository.

Anchor to helpWhere to get help

  • Shopify Community Forums - Visit our forums to connect with the community and learn more about Shopify CLI development.
  • Open a GitHub issue - To report bugs or request new features, open an issue in the Shopify CLI repository.

Anchor to resourcesResources

Start building a theme
Learn how to set up your theme development environment and create a new theme
Start building an app
Learn how to set up your app development environment and start building