Install Shopify API CLI

This guide shows you how to install Shopify App 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

To use Shopify API CLI, you need to have the following:

Install on Windows

If you want to use Shopify App CLI natively on Windows 10, then we recommend installing Ruby using RubyInstaller for Windows.

Alternatively, you can also use Shopify App CLI using Windows Subsystem for Linux, in which case you need:

On Windows, install Shopify App CLI as a Ruby gem using the RubyGems.org package manager:

  1. Open your terminal app.
  2. Run gem install shopify-cli.
  3. After the installation has completed, run shopify version to verify the installation was successful.

Install on macOS

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

Install with RubyGems.org

  1. Open your terminal app.
  2. Run gem install shopify-cli.
  3. After the installation has completed, run shopify version to verify the installation was successful.

Install with Homebrew

  1. Open your terminal app.
  2. Run brew tap shopify/shopify to add Shopify’s third-party repositories to Homebrew.
  3. Run brew install shopify-cli.
  4. After the installation has completed, run shopify version to verify the installation was successful.

Install on Linux

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

Install with RubyGems.org

  1. Open your terminal app.
  2. Run gem install shopify-cli.
  3. After the installation has completed, run shopify version to verify the installation was successful.

Install with apt (Debian, Ubuntu)

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

  1. Download the latest Shopify App CLI .deb file from the releases page on GitHub. Note the file’s location for the next step.
  2. Open your terminal app.
  3. Run sudo apt install /path/to/download/shopify-cli-x.y.z.deb. Make sure to replace /path/to/download/shopify-cli-x.y.z.deb with the path to your file's location.
  4. After the installation has completed, run shopify version to verify the installation was successful.

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

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

  1. Download the latest Shopify App CLI .rpm file from the releases page on GitHub. Note the file’s location for the next step.
  2. Open your terminal app.
  3. Run sudo apt install /path/to/download/shopify-cli-x.y.z.rpm. Make sure to replace /path/to/download/shopify-cli-x.y.z.rpm with the path to your file's location.
  4. After the installation has completed, run shopify version to verify the installation was successful.

Next steps