UNPKG

shopify

Version:

A CLI tool to build for the Shopify platform

github.com/shopify/cli

Shopify/cli

76 lines (45 loc) • 3.51 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<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">![badge](https://github.com/Shopify/cli/actions/workflows/shopify-cli.yml/badge.svg)</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](./packages/cli/README.md#commands). <p>&nbsp;</p> ## Before you begin 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). <p>&nbsp;</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@latest` - `yarn create @shopify/app` - `bun create @shopify/app@latest` (experimental) Learn more in the docs: [Create an app](https://shopify.dev/apps/getting-started/create) <p>&nbsp;</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](https://shopify.dev/docs/storefronts/themes/tools/cli) <p>&nbsp;</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](https://shopify.dev/docs/custom-storefronts/hydrogen/cli) <p>&nbsp;</p> ## Help 🖐 If you encounter issues using the CLI or have feedback you'd like to share with us, below are some options: - [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 - [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 - [Shopify Community Forums](https://community.shopify.com/) - Visit our forums to connect with the community and learn more about Shopify CLI development - [CLI Documentation - Apps](https://shopify.dev/apps/tools/cli) - To view CLI documentation for app development - [CLI Documentation - Themes](https://shopify.dev/themes/tools/cli) - To view CLI documentation for theme development - [CLI Documentation - Hydrogen](https://shopify.dev/custom-storefronts/tools/cli) - To view CLI documentation for Hydrogen (custom storefront) development ## Contribute 👩🏽‍💻 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). <p>&nbsp;</p> ## References - [oclif](https://oclif.io/)