Documentation
Feedback
Guides
Storefront Development

Storefront Development
3. FastStore CLI
The FastStore Command Line Interface (CLI) is the main pre-configured tool for initializing, building and developing FastStore projects.
Also the CLI is the responsible on keeping the stores up-to-date with the @faststore/core package and enables the cloud platform to understand the FastStore project.

Runnig FastStore CLI on the project

The CLI is a dependency in the package.json file of the FastStore project, so once you run yarn install during the set up of the project you can start using it on the project.

Commands

dev

Starts the project in the development environment and usually servers it at http://localhost:3000. It allows you to make changes to the project and see the results in real-time locally on your machine without affecting the production environment.

_10
yarn dev

build

Generates a store in the production environment by compiling the project and optimizing it for production usage.

_10
yarn build

start

Executes a Next.js project in the root directory and usually servers it at http://localhost:3000.

_10
yarn start

cms-sync

Sync your FastStore repository cms folder changes with the Headless CMS app.

_10
yarn cms-sync


Installing FastStore CLI globally using npm

Installing the CLI via npm allows you to use its commands in your machine. To install @faststore/cli package, run the following in the terminal:

_10
npm install -g @faststore/cli

Commands

dev


_10
faststore dev

build


_10
faststore build

start


_10
faststore start

cms-sync


_10
faststore cms-sync

help


_10
yarn faststore help [COMMAND] [-n]

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page