Sales App CLI

Although FastStore provides a main CLI as the central point for interacting with all modules, Sales App has its own CLI, which is even used internally by the FastStore CLI for all interactions related to the Sales App module.

The Sales App CLI is not a replacement for the FastStore CLI, and ideally, you should always use the FastStore CLI for commands in your storefront monorepo, such as build, create, dev, etc. However, the Sales App CLI may contain specific functionalities for Sales App, such as flags in certain commands that facilitate the development environment.

Tip

We recommend always using the FastStore CLI and only using the Sales App CLI when you need to access a specific feature exclusive to it.

Usage

To use the Sales App CLI directly, you can invoke the binary available in your monorepo using your package manager’s runner. If you’re using yarn or npx, it might look like this:

yarn sales-app --help
# or
npx sales-app --help

Available commands

create

Creates the base structure for Sales App project.

Args:

• PATH: The path where the Sales App should be created.

Flags:

• None

dev

Start your Sales App in development mode.

Args:

• ACCOUNT: The account for which the dev environment should run
• PATH: The path where the Sales App is located
• PORT: The first port number allocated to Sales App

Flags:

• --show-placeholders: Show placeholders for extension points

build

Build your Sales App Extension Points.

Args:

• ACCOUNT: The account for which the dev environment should run
• PATH: The path where the Sales App is located

Flags:

• None