Install or upgrade Shopify CLI 2.x

If you need to, you can install Shopify CLI 2.x. You should only install Shopify CLI 2.x if you are continuing work on an existing app that hasn't been migrated to Shopify CLI 3.x, or if Shopify CLI 2.x is explicitly specified in the prerequisites for a feature.

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.

• 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:

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:

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

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

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

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

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

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.

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.

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

The command returns a version number.

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.

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:

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.

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

1. Uninstall the client library and command line tool:

   Yarn (without React):

   Yarn (if using React):

   NPM (without React):

   NPM (if using React):

2. Install the new client library:

   Yarn (without React):

   Yarn (if using React):

   NPM (without React):

   NPM (if using React):

3. Install the new command line tool:

   Yarn:

   NPM:

4. In your extension code, replace all references to the old client library with the new library:

   • If you're using React, then replace @shopify/argo-post-purchase-react with @shopify/post-purchase-ui-extensions-react.
   • If you're not using React, then replace @shopify/argo-post-purchase with @shopify/post-purchase-ui-extensions.

5. Update your scripts in package.json to use the new checkout-ui-extensions-run:

1. Uninstall the client library and command line tool:

   Yarn (without React):

   Yarn (if using React):

   NPM (without React):

   NPM (if using React):

2. Install the new client library:

   Yarn (without React):

   Yarn (if using React):

   NPM (without React):

   NPM (if using React):

3. Install the new command line tool:

   Yarn:

   NPM:

4. In your extension code, replace all references to the old client library with the new library:

   • If you're using React, then replace @shopify/argo-admin-react with @shopify/admin-ui-extensions-react.
   • If you're not using React, then replace @shopify/argo-admin with @shopify/admin-ui-extensions.

5. Update your scripts in package.json to use the new checkout-ui-extensions-run: