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

Node.js: 22.12 or higher
A Node.js package manager: npm, Yarn 1.x, or pnpm.
Git: 2.28.0 or higher

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.

Code

npm install -g @shopify/cli@latest

yarn global add @shopify/cli@latest

pnpm install -g @shopify/cli@latest

# Only for macOS

brew tap shopify/shopify

brew install shopify-cli

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.

Anchor to Upgrade Shopify CLIUpgrade Shopify CLI

Starting with Shopify CLI 4.0, Shopify CLI upgrades itself automatically using the package manager you installed it with. Auto-upgrade is skipped in CI environments, project-local installs, and major version bumps. To upgrade immediately, run shopify upgrade.

Anchor to Turn off auto-upgradesTurn off auto-upgrades

To disable auto-upgrades, run shopify config autoupgrade off.
To re-enable, run shopify config autoupgrade on.

When auto-upgrade is off, Shopify CLI shows a daily reminder when a new version is available, but won't upgrade itself.

Anchor to Network proxy configurationNetwork proxy configuration

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

Set the proxy for HTTP traffic:

export SHOPIFY_HTTP_PROXY=http://proxy.com:8080
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.
For authenticated proxies, include credentials in the URL:

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

Anchor to Usage reportingUsage reporting

Anonymous usage statistics are collected by default. To opt out, you can use either SHOPIFY_CLI_NO_ANALYTICS=1 or OPT_OUT_INSTRUMENTATION=true.

Anchor to Contribute to Shopify CLIContribute to Shopify CLI

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

Anchor to Where to get helpWhere to get help

Shopify CLI and Libraries - Report any issues with the CLI.
Dev Platform - Ask any questions and learn more about the Dev Platform powering the CLI.

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

Was this page helpful?