docs
  1. Storefront-guide
  2. Storefront Application
  3. Storefront Cli

Storefront CLI

Overview

The SCAYLE Storefront Command-Line Interface (CLI) is a tool designed to accelerate feature adoption in your Storefront Application project. It simplifies integrating new features and updates from the Storefront Application, allowing you to selectively add individual components.

The CLI handles the complexities of component delivery and integration. It automatically fetches the necessary components based on the selected feature, manages potential file conflicts, and can optionally include unit tests. This streamlined workflow significantly reduces manual effort and speeds up the development process.

Usage

To ensure you are always using the latest version, we recommend running the CLI via npx. This approach fetches the current version of the Storefront CLI on each use, providing access to the newest features and updates.

Global Installation

Alternatively, you can install the package globally on your system. This allows you to use the shorter sfcli command alias.

First install the package using npm, then you can run commands directly.

You can verify the installation and check the version with the following commands:

Access Tokens

Some commands require access to the Git repository of the Storefront Application. Because this repository is private, a token is required for access. Please reach out to your SCAYLE Account Manager if you do not already possess a token for your team.