Awesome
<img src="https://github.com/Shopify/cli/blob/main/assets/logo.png?raw=true" width="150"/>Shopify CLI
<a href="http://twitter.com/ShopifyDevs"><img src="https://img.shields.io/twitter/follow/ShopifyDevs?style=flat-square" alt="Twitter Followers"></a>
<img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License">
<a href="https://github.com/Shopify/cli/actions/workflows/shopify-cli.yml">
</a>
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.
<p> </p>Before you begin
Install the latest version of Node.js and npm (or another package manager of your choice).
<p> </p>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@latestyarn create @shopify/appbun create @shopify/app@latest(experimental)
Learn more in the docs: Create an app
<p> </p>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
<p> </p>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
<p> </p>Help 🖐
If you encounter issues using the CLI or have feedback you'd like to share with us, below are some options:
- Open a GitHub issue - To report bugs or request new features, open an issue in the Shopify CLI repository
- Shopify Community Forums - Visit our forums to connect with the community and learn more about Shopify CLI development
- CLI Documentation - Apps - To view CLI documentation for app development
- CLI Documentation - Themes - To view CLI documentation for theme development
- CLI Documentation - Hydrogen - To view CLI documentation for Hydrogen (custom storefront) development
Contribute 👩🏽💻
If you'd like to contribute to the project, check out the contributors docs and the steps to get started.
<p> </p>