Install Shopify CLI

This guide shows you how to install Shopify CLI on Windows, macOS, or Linux. You can use your computer's command line to install the CLI from one of the supported package managers.

Requirements

Ruby or Ruby+Devkit using RubyInstaller for Windows 2.7 or higher
Git
A Shopify Partner account
A Shopify development store to install and test apps

You also need to install the following project-specific requirements:

Project type	Requirements
Ruby on Rails	Node.js Yarn
Node.js	Node.js npm
PHP	PHP Composer npm

Install Shopify CLI

Start by installing Shopify CLI on your computer. You can install Shopify CLI on Windows, macOS, or Linux. Use your computer's command line to install Shopify CLI from one of the supported package managers.

If you want to use Shopify CLI natively on Windows 10, then first make sure that you've installed Ruby+Devkit using RubyInstaller for Windows (version 2.7 or higher).

Alternatively, you can use Shopify CLI using Windows Subsystem for Linux, in which case you need to install the following:

After you install the prerequisites, you can install Shopify CLI as a Ruby gem using the RubyGems.org package manager. In a new terminal window, navigate to your home directory and run the following command:

Verify the installation

To verify that Shopify CLI is installed properly, run the following command:

The command returns a version number.

Shopify CLI is available for macOS through either RubyGems.org or Homebrew.

RubyGems.org

In a new terminal window, navigate to your home directory and run the following command:

Homebrew

You need to add Shopify's third-party repositories to Homebrew before you can install Shopify CLI.

Verify the installation

To verify that Shopify CLI is installed properly, run the following command:

The command returns a version number.

Shopify CLI is available for Linux distributions through RubyGems.org, as well as through apt or yum.

RubyGems.org

In a new terminal window, navigate to your home directory and run the following command:

apt (Debian, Ubuntu)

On Debian-based Linux systems, Shopify CLI is available to install with apt.

Download the latest Shopify CLI .deb file from the releases page on GitHub. Note the file’s location for the next step.
Run the following command. Make sure to replace /path/to/download/shopify-cli-x.y.z.deb with the path to your file's location.

yum (CentOS 8+, Fedora, Red Hat, SUSE Linux)

On RPM-based Linux systems, Shopify CLI is available to install with yum.

Download the latest Shopify CLI .rpm file from the releases page on GitHub. Note the file’s location for the next step.
Run the following command. Make sure to replace /path/to/download/shopify-cli-x.y.z.rpm with the path to your file's location.

Verify the installation

To verify that Shopify CLI is installed properly, run the following command:

The command returns a version number.

Next steps

Learn how to create and manage different types of projects with Shopify CLI.
Familiarize yourself with the core commands for Shopify CLI.
Troubleshoot common issues, including upgrading, migrating from a legacy version, and uninstalling Shopify CLI.

Actions

Menu

Navigation

React components

UX guidelines

Reference

Marketing activities

Reference

Marketing externally

Marketing internally

Shopify CLI

App Bridge

Actions

Menu

Navigation

React components

Post-purchase

UX guidelines

Payment methods

Shipping methods

Theme app extensions

Other integration methods

App extensions

Fulfillments

Migrate to the Subscriptions API

Getting started

Payments examples

Hosted Payment SDK

Reference

Checkout API

Shopify admin extensions

Marketing activities

Reference

OAuth

Session tokens

Configuration

Definitions

Subscriptions

App review process

Supporting your app

Data and user privacy

App success

Marketing externally

Marketing internally

Shopify App Store ads

Security

Install Shopify CLI

Requirements

Install Shopify CLI

Verify the installation

RubyGems.org

Homebrew

Verify the installation

RubyGems.org

apt (Debian, Ubuntu)

yum (CentOS 8+, Fedora, Red Hat, SUSE Linux)

Verify the installation

Next steps

On this page