https://github.com/Shopify/cli
Build apps, themes, and hydrogen storefronts for Shopify
https://github.com/Shopify/cli
cli oclif shopify shopify-apps shopify-themes typescript
Last synced: 4 months ago
JSON representation
Build apps, themes, and hydrogen storefronts for Shopify
- Host: GitHub
- URL: https://github.com/Shopify/cli
- Owner: Shopify
- License: mit
- Created: 2022-06-21T13:52:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-09T20:20:13.000Z (4 months ago)
- Last Synced: 2025-07-09T21:00:50.616Z (4 months ago)
- Topics: cli, oclif, shopify, shopify-apps, shopify-themes, typescript
- Language: TypeScript
- Homepage: https://shopify.dev
- Size: 142 MB
- Stars: 532
- Watchers: 201
- Forks: 185
- Open Issues: 91
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-shopify - Shopify CLI - CLI to build apps, themes, and hydrogen storefronts for Shopify 🚀. (Developer Tools / CLI Tools)
README
# Shopify CLI
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).
### 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).
## 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)
## 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/themes/tools/cli)
## 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)
## 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](https://github.com/Shopify/cli/issues) - To report bugs or request new features, open an issue in the Shopify CLI repository
- [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).
## References
- [oclif](https://oclif.io/)