Skip to content

Shopify/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d4902f6 · Oct 21, 2024
Oct 10, 2024
Sep 17, 2024
Apr 20, 2023
Jul 9, 2024
Sep 12, 2024
Sep 18, 2024
Jan 11, 2022
Aug 12, 2024
Aug 2, 2024
Sep 25, 2024
Oct 10, 2024
Oct 10, 2024
Apr 16, 2024
Nov 8, 2022
Apr 30, 2024
Sep 27, 2024
Jan 11, 2022
Nov 24, 2022
Aug 2, 2024
Feb 20, 2023
Jul 30, 2024
Jun 22, 2022
Sep 18, 2023
Jun 4, 2024
Mar 28, 2023
Oct 11, 2022
Aug 8, 2024
Jan 11, 2022
Jun 22, 2022
Oct 25, 2023
Feb 20, 2023
Aug 8, 2024
Jul 22, 2024
Jun 18, 2024
Sep 20, 2024
Oct 10, 2024
Mar 24, 2023
Jun 20, 2024
Jun 20, 2024
Aug 12, 2024
Aug 12, 2024
Oct 21, 2024
Jul 10, 2023
May 24, 2022
Jul 10, 2023

Repository files navigation

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

Learn more in the commands docs.

 

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
  • bun create @shopify/app@latest (experimental)

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