Getting started with Instant CLI

With the Instant CLI you can create your own storefront blocks. This guide shows you how to install Instant CLI on macOS, Windows or Linux.

Prerequisites

macOS

• Node — 16.x
• Text editor — We recommend VS Code
• Terminal — Instant is accessed through the command-line interface (CLI).

Windows

• WSL
• Node — 16.x
• Text editor — We recommend VS Code
• Terminal — Instant is accessed through the command-line interface (CLI).

Linux

• Node — 16.x
• Text editor — We recommend VS Code
• Terminal — Instant is accessed through the command-line interface (CLI).

---

Installation ⚡

The CLI is available as an npm package. To install the package run:

npm

Terminal

npm install -g @instantcommerce/cli

yarn

Terminal

yarn install -g @instantcommerce/cli

pnpm

Terminal

pnpm install -g @instantcommerce/cli

---

Verify the installation

To verify that @instantcommerce/cli is installed properly, run the following command:

Terminal

instant --version