Install, upgrade, or uninstall Shopify CLI 2.x

This reference guide contains information about upgrading Shopify CLI, migrating from a legacy version, and uninstalling Shopify CLI.

Anchor to Install Shopify CLI 2.xInstall Shopify CLI 2.

If you need to, you can install Shopify CLI 2.x. You can install Shopify CLI 2.x on Windows, macOS, or Linux. Use your computer's command line to install Shopify CLI from one of the supported package managers.

Anchor to RequirementsRequirements

To install and run Shopify CLI, you need to have the following installed on your computer:

• Ruby or Ruby+Devkit using RubyInstaller for Windows

  2.7 or higher

• Git

Anchor to WindowsWindows

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:

• Windows Subsystem for Linux

• Ubuntu VM

  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:

Anchor to MacOSMacOS

Shopify CLI is available for macOS through RubyGems.org.

Anchor to RubyGems.orgRubyGems.org

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

Anchor to LinuxLinux

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

Anchor to RubyGems.orgRubyGems.org

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

Anchor to apt (Debian, Ubuntu)apt (Debian, Ubuntu)

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

1. Download the latest Shopify CLI .deb file from the releases page on GitHub. Note the file’s location for the next step.
2. 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.

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

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

1. Download the latest Shopify CLI .rpm file from the releases page on GitHub. Note the file’s location for the next step.
2. 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.

Anchor to Verify the installationVerify the installation

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

The command returns a version number.

Anchor to Upgrade Shopify CLIUpgrade Shopify CLI

You can manage upgrades to Shopify CLI with the package manager for your platform. You must use the same package manager to upgrade that you originally used to install Shopify CLI.

For extension development, you might also need to update specific node modules manually to use all of the latest features.

Anchor to Homebrew (macOS)Homebrew (macOS)

Anchor to apt (Debian, Ubuntu)apt (Debian, Ubuntu)

1. Download the latest .deb file for Shopify CLI from the releases page.
2. Install the downloaded file and make sure to replace /path/to/download/shopify-cli-x.y.z.deb with the path to your file's location:

Anchor to yum (CentOS 8+, Fedora, Red Hat, SUSE)yum (CentOS 8+, Fedora, Red Hat, SUSE)

1. Download the latest .rpm file for Shopify CLI from the releases page.
2. Install the downloaded file and make sure to replace /path/to/downloaded/shopify-cli-x.y.x.rpm with the path to your file's location.

Anchor to RubyGems (macOS, Linux, Windows 10)RubyGems (macOS, Linux, Windows 10)

Anchor to Migrate from a legacy versionMigrate from a legacy version

As of version 0.9.0, Shopify CLI is installed and managed as a software package, instead of as a Git repository. If you’re using a version prior to 0.9.0, then you need to perform a one-time migration to keep using the CLI.

Complete the following steps to remove the legacy version and reinstall Shopify CLI as a package:

1. Check if you are using the legacy version.
2. Uninstall the legacy Shopify CLI.
3. Install the new version.
4. Re-authenticate the CLI.

Anchor to Check if you are using the legacy versionCheck if you are using the legacy version

You can determine if you’re using a legacy version by running the following command. If you get a command not found error, then you’re using a legacy version.

Anchor to Uninstall the legacy Shopify App CLIUninstall the legacy Shopify App CLI

To uninstall a legacy version of Shopify CLI, complete the following steps:

1. Delete the legacy CLI files.
2. Remove the legacy shopify command from your shell profile.
3. Reload your terminal.

Anchor to Delete the legacy CLI filesDelete the legacy CLI files

By default, Shopify CLI was installed in your home directory. All the files are contained in a hidden directory called .shopify-app-cli. Run the following command to delete the directory:

Anchor to Remove the legacy ,[object Object], command from your shell profileRemove the legacy shopify command from your shell profile

During the install process, Shopify CLI added a line to your shell configuration. This line could be located in one of the following files in your home directory:

• ~/.bash_profile

• ~/.zshrc

• ~/.bash_login

• ~/.profile

• ~/.config/fish/config.fish

  The line will look similar to one of the following examples. The exact syntax depends on your system. Deleting or commenting out the relevant line in your shell profile removes shopify as a command.

Anchor to Reload your terminalReload your terminal

For the changes made to your shell profile to take effect, exit your terminal, and start a new one.

• If you try running shopify, then you should get a command not found error.
• If you have the shopify_api gem installed, then you might see the following response:

If so, then you also need to upgrade the shopify_api gem to v9.2.0 or higher to remove a deprecated shopify command that is contained in that gem.

If you also have the shopify_app gem (which depends on shopify_api gem), then you need to install or update shopify_api first, and then uninstall the older version.

To get a list of the versions of shopify_api currently installed, run the following command:

To install the latest version, run the following command:

To uninstall the older version, run the following command. Replace x.y.z with a version number listed from the gem list command. Repeat as needed.

Anchor to Install the new versionInstall the new version

After you've finished uninstalling the legacy version, you can install the most recent version of Shopify CLI. Follow the installation instructions for your platform.

Anchor to Re-authenticate the CLIRe-authenticate the CLI

To reauthenticate, with Shopify CLI, enter shopify login.

Anchor to Uninstall Shopify CLIUninstall Shopify CLI

Shopify CLI can be removed from your system using the same package manager that you used to install it.

Anchor to Homebrew (macOS)Homebrew (macOS)

Anchor to apt (Debian, Ubuntu)apt (Debian, Ubuntu)

Anchor to yum (CentOS 8+, Fedora, Red Hat, SUSE)yum (CentOS 8+, Fedora, Red Hat, SUSE)

Anchor to RubyGems (macOS, Linux, Windows 10)RubyGems (macOS, Linux, Windows 10)

Anchor to Uninstall a legacy versionUninstall a legacy version

If you’re using a legacy version of Shopify CLI (lower than 0.9.0), then you need to uninstall it manually.

Anchor to Next stepsNext steps

• Review the commands for Shopify CLI.