Skip to content

Shopify/cli

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Shopify CLI

Twitter Followers License badge

With the Shopify command line interface (Shopify CLI 3.0), you can:

  • initialize, build, dev, and deploy Shopify apps, extensions, functions and themes
  • build custom storefronts and manage their hosting

ย 

Before you begin

Install the latest version of Node.js and npm (or another package manager of your choice).

ย 

Developing apps with Shopify CLI

When youโ€™re building a Shopify app, you can initialize your project using your preferred package manager. A single command will install all the dependencies you need โ€” including Shopify CLI itself.

Initialize your project using one of the following commands:

  • npm init @shopify/app@latest (installed by default with Node)
  • pnpm create @shopify/create-app@latest
  • yarn create @shopify/app

Learn more in the docs: Create an app

ย 

Developing themes with Shopify CLI

To work with themes, the CLI needs to be installed globally with:

  • npm install -g @shopify/cli @shopify/theme

You can also use do it through Homebrew on macOS: brew tap shopify/shopify && brew install shopify-cli

Learn more in the docs: Shopify CLI for themes

ย 

Developing Hydrogen custom storefronts with Shopify CLI

The Hydrogen code lives here: https://github.com/Shopify/hydrogen/tree/main/packages/cli

Learn more in the docs: Shopify CLI for Hydrogen storefronts

ย 

Help ๐Ÿ–

If you encounter issues using the CLI or have feedback you'd like to share with us, below are some options:

Contribute ๐Ÿ‘ฉ๐Ÿฝโ€๐Ÿ’ป

If you'd like to contribute to the project, check out the contributors docs and the steps to get started.

ย 

References