npm install @shopify/cli-kit

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

About @shopify/cli-kit

The npm package @shopify/cli-kit offers an essential toolkit for developers working with the Shopify platform, providing a range of utilities, interfaces, and models that streamline the development process across multiple Shopify features. This powerful node module is designed to enhance productivity by offering a standardized set of tools that can be used across various parts of the Shopify ecosystem, ensuring consistency and reliability in application development. By leveraging the @shopify/cli-kit, developers can significantly reduce setup time and focus more on creating innovative solutions for e-commerce.

To begin using this toolkit in your own development environment, the process is straightforward with the command npm install @shopify/cli-kit. This command installs the CLI kit, allowing developers immediate access to its comprehensive suite of tools. Once installed, the @shopify/cli-kit simplifies the interaction with Shopify’s APIs and other platform features, enabling developers to efficiently manage their projects. This installation not only saves time but also ensures that developers have the latest tools needed to build robust applications on Shopify’s platform.

The benefits of using @shopify/cli-kit extend beyond mere convenience. This node module supports a more structured and efficient workflow, which is crucial when dealing with complex e-commerce projects. It allows developers to maintain a high standard of code quality and ensures that all components of a Shopify application are seamlessly integrated and functioning well together. Moreover, the @shopify/cli-kit is continually updated, which means developers have access to the latest features and improvements, keeping their Shopify applications up-to-date and competitive in the fast-paced world of e-commerce.

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-kit 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