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.4.4 linux-x64 node-v18.20.5
$ faststore --help [COMMAND]
USAGE
  $ faststore COMMAND
...

Commands

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

faststore build [ACCOUNT] [PATH]

USAGE
  $ faststore build [ACCOUNT] [PATH]

ARGUMENTS
  ACCOUNT  The account for which the Discovery is running. Currently noop.
  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 create [PATH]

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

USAGE
  $ faststore create [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 create discovery

See code: dist/commands/create.ts

faststore dev [ACCOUNT] [PATH] [PORT]

USAGE
  $ faststore dev [ACCOUNT] [PATH] [PORT]

ARGUMENTS
  ACCOUNT  The account for which the Discovery is running. Currently noop.
  PATH     The path where the FastStore being run is. Defaults to cwd.
  PORT     The port where FastStore should run. Defaults to 3000.

See code: dist/commands/dev.ts

faststore generate-graphql [PATH]

USAGE
  $ faststore generate-graphql [PATH]

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

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 start [ACCOUNT] [PATH] [PORT]

USAGE
  $ faststore start [ACCOUNT] [PATH] [PORT]

ARGUMENTS
  ACCOUNT  The account for which the Discovery is running. Currently noop.
  PATH     The path where the FastStore being run is. Defaults to cwd.
  PORT     The port where FastStore should run. Defaults to 3000.

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