|
| 1 | +<img src="https://github.com/Shopify/cli/blob/main/assets/logo.png?raw=true" width="150"/> |
| 2 | + |
| 3 | +# Shopify CLI |
| 4 | +<a href="http://twitter.com/ShopifyDevs"><img src="https://img.shields.io/twitter/follow/ShopifyDevs?style=flat-square" alt="Twitter Followers"></a> |
| 5 | +<img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License"> |
| 6 | +<a href="https://github.com/Shopify/cli/actions/workflows/shopify-cli.yml"></a> |
| 7 | + |
| 8 | +With the Shopify command line interface (Shopify CLI 3.0), you can: |
| 9 | +- initialize, build, dev, and deploy Shopify apps, extensions, functions and themes |
| 10 | +- build custom storefronts and manage their hosting |
| 11 | + |
| 12 | +Learn more in the [commands docs](./packages/cli/README.md#commands). |
| 13 | + |
| 14 | +<p> </p> |
| 15 | + |
| 16 | +## Before you begin |
| 17 | + |
| 18 | +Install the latest version of [Node.js](https://nodejs.org/en/download/) and [npm](https://docs.npmjs.com/getting-started) (or another package manager of your choice). |
| 19 | + |
| 20 | +<p> </p> |
| 21 | + |
| 22 | +## Developing apps with Shopify CLI |
| 23 | + |
| 24 | +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. |
| 25 | + |
| 26 | +Initialize your project using one of the following commands: |
| 27 | +- `npm init @shopify/app@latest` (installed by default with Node) |
| 28 | +- `pnpm create @shopify/create-app@latest` |
| 29 | +- `yarn create @shopify/app` |
| 30 | +- `bun create @shopify/app@latest` (experimental) |
| 31 | + |
| 32 | +Learn more in the docs: [Create an app](https://shopify.dev/apps/getting-started/create) |
| 33 | + |
| 34 | +<p> </p> |
| 35 | + |
| 36 | +## Developing themes with Shopify CLI |
| 37 | + |
| 38 | +To work with themes, the CLI needs to be installed globally with: |
| 39 | + |
| 40 | +- `npm install -g @shopify/cli @shopify/theme` |
| 41 | + |
| 42 | +You can also use do it through Homebrew on macOS: `brew tap shopify/shopify && brew install shopify-cli` |
| 43 | + |
| 44 | +Learn more in the docs: [Shopify CLI for themes](https://shopify.dev/docs/storefronts/themes/tools/cli) |
| 45 | + |
| 46 | +<p> </p> |
| 47 | + |
| 48 | +## Developing Hydrogen custom storefronts with Shopify CLI ## |
| 49 | + |
| 50 | +The Hydrogen code lives here: https://github.com/Shopify/hydrogen/tree/main/packages/cli |
| 51 | + |
| 52 | +Learn more in the docs: [Shopify CLI for Hydrogen storefronts](https://shopify.dev/docs/custom-storefronts/hydrogen/cli) |
| 53 | + |
| 54 | +<p> </p> |
| 55 | + |
| 56 | +## Help 🖐 |
| 57 | + |
| 58 | +If you encounter issues using the CLI or have feedback you'd like to share with us, below are some options: |
| 59 | + |
| 60 | +- [File a bug report](https://community.shopify.dev/c/shopify-cli-libraries/14) - To report bugs create a post in Shopify CLI and Libraries on the dev community |
| 61 | +- [Ask a question or request a new feature](https://community.shopify.dev/c/dev-platform/32) - To ask a question or request a new feature create a post in Dev Platform on the dev community |
| 62 | +- [Shopify Community Forums](https://community.shopify.com/) - Visit our forums to connect with the community and learn more about Shopify CLI development |
| 63 | +- [CLI Documentation - Apps](https://shopify.dev/apps/tools/cli) - To view CLI documentation for app development |
| 64 | +- [CLI Documentation - Themes](https://shopify.dev/themes/tools/cli) - To view CLI documentation for theme development |
| 65 | +- [CLI Documentation - Hydrogen](https://shopify.dev/custom-storefronts/tools/cli) - To view CLI documentation for Hydrogen (custom storefront) development |
| 66 | + |
| 67 | +## Contribute 👩🏽💻 |
| 68 | + |
| 69 | +If you'd like to contribute to the project, check out the [contributors docs](/docs) and the [steps to get started](/docs/cli/get-started.md). |
| 70 | + |
| 71 | +<p> </p> |
| 72 | + |
| 73 | +## References |
| 74 | + |
| 75 | +- [oclif](https://oclif.io/) |
0 commit comments