npm install @shopify/cli

A CLI tool to build for the Shopify platform

About @shopify/cli

The @shopify/cli npm package is a powerful command-line tool designed specifically for developers building applications on the Shopify platform. This Node module streamlines the process of developing, testing, and deploying Shopify apps by providing a suite of commands that handle various aspects of the development lifecycle. With @shopify/cli, developers can effortlessly create new Shopify projects, manage environments, and interact with Shopify’s APIs. The tool is an essential asset for any developer looking to optimize their workflow and leverage the robust capabilities of the Shopify ecosystem.

To get started with this indispensable tool, developers can simply run the command npm install @shopify/cli in their terminal. This command installs the Shopify CLI quickly and seamlessly, setting up a local development environment that is pre-configured for Shopify app development. Once installed, the CLI offers commands for starting development servers, initializing new app projects, and deploying apps to Shopify. This installation process ensures that developers can jump straight into coding with minimal setup, allowing them to focus on creating innovative applications rather than dealing with configuration hassles.

The @shopify/cli also enhances productivity by integrating with other Shopify developer tools and services. It supports features like hot-reloading and tunneling, which are crucial for real-time testing and feedback. Additionally, it provides built-in support for Shopify’s Polaris design system, helping developers maintain consistency with Shopify’s visual and user experience guidelines. By using @shopify/cli, developers not only save time but also ensure that their applications meet the high standards set by Shopify, leading to a smoother approval and launch process on the Shopify App Store. This tool is a must-have for any developer looking to build professional and high-quality applications on the Shopify platform.

More from Shopify

Shopify npm packages

Find the best node modules for your project.

Search npm

@shopify/flash-list

FlashList is a more performant FlatList...

Read more
,

@shopify/polaris-icons

[![npm version](https://img.shields.io/npm/v/@shopify/polaris-icons.svg?style=flat)](https://www...

Read more
,

@shopify/polaris

Shopify’s admin product component...

Read more
,

@shopify/cli-kit

A set of utilities, interfaces, and models that are common across all the platform...

Read more
,

@shopify/cli

A CLI tool to build for the Shopify...

Read more
,

@shopify/draggable

The JavaScript Drag & Drop library your grandparents warned you about...

Read more
,

@shopify/app-bridge-core

**[Join our team and work on libraries like this one.](https://www.shopify...

Read more
,

@shopify/theme-check-common


Read more

,

@shopify/graphql-client

Shopify GraphQL Client - A lightweight generic GraphQL JS client to interact with Shopify GraphQL...

Read more
,

@shopify/storefront-api-client

Shopify Storefront API Client - A lightweight JS client to interact with Shopify's Storefront...

Read more
,

@shopify/restyle

A system for building constraint-based UI...

Read more
,

@shopify/theme-check-node

This is the Node.js wrapper of the runtime-agnostic [`@shopify/theme-check-common`](https://npm...

Read more

Dependencies

Core dependencies of this npm package and its dev dependencies.

@shopify/cli-hydrogen, @bugsnag/source-maps, @changesets/cli, @nx/eslint-plugin, @nx/workspace, @octokit/core, @shopify/eslint-plugin-cli, @shopify/generate-docs, @types/node, @types/tmp, @typescript-eslint/parser, ansi-colors, bugsnag-build-reporter, commander, cross-env, esbuild, eslint, execa, fast-glob, find-up, fs-extra, graphql, graphql-tag, json-stringify-deterministic, knip, liquidjs, node-fetch, nx, oclif, octokit-plugin-create-pull-request, pathe, pin-github-action, react, rimraf, tmp, ts-node, typescript

Documentation

A README file for the @shopify/cli code repository. View Code

Shopify CLI

Twitter Followers License badge

With the Shopify command line interface (Shopify CLI 3.0), you can:

Learn more in the commands docs.

 

Before you begin

Install the latest version of Node.js and npm (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:

Learn more in the docs: Create an app

 

Developing themes with Shopify CLI

To work with themes, the CLI needs to be installed globally with:

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

 

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

 

Help 🖐

If you encounter issues using the CLI or have feedback you'd like to share with us, below are some options:

Contribute 👩🏽‍💻

If you'd like to contribute to the project, check out the contributors docs and the steps to get started.

 

References