@faststore/cli

FastStore CLI

The FastStore Command Line Interface

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.

Installation

From the command line in your project directory, run:

npm install -g @faststore/cli

$ npm install -g @faststore/cli
$ faststore COMMAND
running command...
$ faststore (--version)
@faststore/cli/3.0.83 linux-x64 node-v18.20.3
$ faststore --help [COMMAND]
USAGE
  $ faststore COMMAND
...

Commands

• faststore build [PATH]
• faststore cms-sync [PATH]
• faststore dev [PATH]
• faststore generate-graphql [PATH]
• faststore help [COMMAND]
• faststore init [PATH]
• faststore start [PATH]
• faststore test [PATH]

faststore build [PATH]

USAGE
  $ faststore build [PATH]

ARGUMENTS
  PATH  The path where the FastStore being built is. Defaults to cwd.

See code: dist/commands/build.ts

faststore cms-sync [PATH]

USAGE
  $ faststore cms-sync [PATH] [-d]

ARGUMENTS
  PATH  The path where the FastStore being synched with the CMS is. Defaults to cwd.

FLAGS
  -d, --dry-run

See code: dist/commands/cms-sync.ts

faststore dev [PATH]

USAGE
  $ faststore dev [PATH]

ARGUMENTS
  PATH  The path where the FastStore being run is. Defaults to cwd.

See code: dist/commands/dev.ts

faststore generate-graphql [PATH]

USAGE
  $ faststore generate-graphql [PATH] [-d]

ARGUMENTS
  PATH  The path where the FastStore GraphQL customization is. Defaults to cwd.

FLAGS
  -d, --debug

See code: dist/commands/generate-graphql.ts

faststore help [COMMAND]

Display help for faststore.

USAGE
  $ faststore help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for faststore.

See code: @oclif/plugin-help

faststore init [PATH]

Creates a discovery folder based on the starter.store template.

USAGE
  $ faststore init [PATH]

ARGUMENTS
  PATH  The path where the Discovery folder will be created. Defaults to ./discovery.

DESCRIPTION
  Creates a discovery folder based on the starter.store template.

EXAMPLES
  $ yarn faststore init discovery

See code: dist/commands/init.ts

faststore start [PATH]

USAGE
  $ faststore start [PATH]

ARGUMENTS
  PATH  The path where the FastStore being run is. Defaults to cwd.

See code: dist/commands/start.ts

faststore test [PATH]

USAGE
  $ faststore test [PATH]

ARGUMENTS
  PATH  The path where the FastStore being tested is. Defaults to cwd.

See code: dist/commands/test.ts