The Shopify CLI is written in Typescript and runs in the Node runtime. We settled on a Javascript-based stack because it aligns with the programming language used to build for the platform, and allows having a strongly-typed contract with web tooling that's necessary to compile and optimize projects for deployment. It's designed following a modular architecture where the bottom-most layer represents the foundation that all the features build upon, and the top-most layer represents an horizontally-distributed set of features that users can opt into based on their needs. Modularization also encourages clearly defined boundaries that leads to a better structure that's easier to maintain long-term.
It's important to understand the responsibility of each of the packages to ensure new code is placed in the right package, and that you can find the component you are looking for more easily.
| Package | Description | Examples |
|---|---|---|
| @shopify/create-app | Contains an executable that guides the user through the process of creating a new Shopify app | Executable and init command |
| @shopify/create-hydrogen | Contains an executable that guides the user through the process of creating a new Hydrogen storefront | Executable and init command |
| @shopify/cli | Contains the CLI executable that glues all the commands provided by the features under it | Executable and init command |
| @shopify/app | Contains the logic for creating, building, serving, and deploying Shopify apps | Commands, App model, Deployment tool. |
| @shopify/theme | Contains the logic for creating, building, and pushing themes. | Commands, Theme server and checker. |
| @shopify/hydrogen | Contains the logic for building Hydrogen storefronts | Commands, Theme server and checker. |
| @shopify/cli-kit | Contains models and utilities that are shared across all the features | Authentication handler, Admin API Client, Session manager. |