@scayle/storefront-cli

• @scayle/storefront-cli
• Using PNPM
• Using NPX

Storefront CLI

The SCAYLE Storefront command-line interface (CLI) tool accelerates feature adoption in SCAYLE Storefront tenant projects by simplifying the integration of new features and updates from the Storefront Application. It allows tenants to selectively add individual feature components, even if their project is based on an older Storefront Application version, avoiding the need for a full Storefront Application upgrade.

Usage

Recommended Usage

To always use the current version of the CLI we recommend to use the package as remote package pnpx or npx. This will always fetch the current version of the Storefront CLI.

# Using PNPM
pnpx @scayle/storefront-cli COMMAND

# Using NPX
npx @scayle/storefront-cli COMMAND

Installed Usage

$ npm install -g @scayle/storefront-cli
$ sfcli COMMAND
running command...
$ sfcli (--version)
@scayle/storefront-cli/1.1.0 darwin-arm64 node-v24.15.0
$ sfcli --help [COMMAND]
USAGE
  $ sfcli COMMAND
...

Commands

• sfcli commands
• sfcli deploy
• sfcli help [COMMAND]
• sfcli setup
• sfcli setup cms amplience
• sfcli setup cms contentful
• sfcli setup cms contentstack
• sfcli setup cms storyblok

sfcli commands

List all sfcli commands.

USAGE
  $ sfcli commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
    [--no-truncate | ] [--sort id|plugin|summary|type | ]

FLAGS
  -c, --columns=<option>...  Only show provided columns (comma-separated).
                             <options: id|plugin|summary|type>
  -x, --extended             Show extra columns.
      --deprecated           Show deprecated commands.
      --hidden               Show hidden commands.
      --no-truncate          Do not truncate output.
      --sort=<option>        [default: id] Property to sort by.
                             <options: id|plugin|summary|type>
      --tree                 Show tree of commands.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all sfcli commands.

See code: @oclif/plugin-commands

sfcli deploy

The deploy command will initiate a new deployment to SCAYLE PaaS and and display the build logs.

USAGE
  $ sfcli deploy -t <value> -s <value> -e <value> --deploy-token <value> [--json] [--log-level
    debug|warn|error|info|trace] [-h] [--no-config-file] [--non-interactive] [-g <value>]

FLAGS
  -e, --env-key=<value>       (required) [env: SCAYLE_CLI_ENV_KEY] Env Key is needed for identifying the correct
                              environment.
  -g, --git-ref=<value>       [env: SCAYLE_CLI_GIT_REF] Git ref is used to checkout the specific version of the app that
                              should be deployed. If omitted, the current git HEAD of the detected Storefront
                              Application project is used; when no project can be detected, the command exits with an
                              error.
  -h, --no-header             Disable initial header print for the CLI.
  -s, --shop-key=<value>      (required) [env: SCAYLE_CLI_SHOP_KEY] Shop Key is needed for identifying the correct shop.
  -t, --tenant-space=<value>  (required) [env: SCAYLE_CLI_TENANT_SPACE] Tenant Space is needed for identifying the
                              correct context within the SCAYLE Core System.
      --deploy-token=<value>  (required) [env: SCAYLE_CLI_DEPLOY_TOKEN] Deploy Token is needed to authenticate against
                              the SCAYLE PaaS System.
      --no-config-file        [env: SCAYLE_CLI_NO_CONFIG_FILE] Disable generating a config file.
      --non-interactive       [env: SCAYLE_CLI_NON_INTERACTIVE] Never prompt. A missing required value aborts with an
                              error instead of asking, and a prompt with a safe default takes that default.

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Set to debug or trace to enable verbose debug output.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  The deploy command will initiate a new deployment to SCAYLE PaaS and and display the build logs.

EXAMPLES
  $ sfcli deploy

See code: src/commands/deploy.ts

sfcli help [COMMAND]

Display help for sfcli.

USAGE
  $ sfcli 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 sfcli.

See code: @oclif/plugin-help

sfcli setup

The setup command will guide the user through a series of interactive prompts to gather the necessary information for configuring the Storefront Application.

USAGE
  $ sfcli setup (-a <value> -t <value>) [--json] [--log-level debug|warn|error|info|trace] [-h]
    [--no-config-file] [--non-interactive] [-p <value>] [-o] [-e]

FLAGS
  -a, --admin-api-token=<value>  (required) Admin API token will be used for authentication and authorization when
                                 accessing data from the SCAYLE Core System.
  -e, --only-env                 Setup only local environment variable as part of a .env file and skips creation of shop
                                 config, as well as translation files.
  -h, --no-header                Disable initial header print for the CLI.
  -o, --should-override          Override existing files while copying relevant files
  -p, --parent-shop-key=<value>  Shop key to setup a shop directly.
  -t, --tenant-space=<value>     (required) Tenant Space is needed for identifying the correct context within the SCAYLE
                                 Core System.
      --no-config-file           [env: SCAYLE_CLI_NO_CONFIG_FILE] Disable generating a config file.
      --non-interactive          [env: SCAYLE_CLI_NON_INTERACTIVE] Never prompt. A missing required value aborts with an
                                 error instead of asking, and a prompt with a safe default takes that default.

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Set to debug or trace to enable verbose debug output.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  The setup command will guide the user through a series of interactive prompts to gather the necessary information for
  configuring the Storefront Application.

EXAMPLES
  $ sfcli setup

See code: src/commands/setup/index.ts

sfcli setup cms amplience

Configures the Storefront Application to use Amplience as the CMS provider.

USAGE
  $ sfcli setup cms amplience -n <value> [--json] [--log-level debug|warn|error|info|trace] [-h] [--no-config-file]
    [--non-interactive] (--hub-id <value> -i true|false) [-p <value> ]

FLAGS
  -h, --no-header                      Disable initial header print for the CLI.
  -i, --import-content-model=<option>  (required) Import the content model in to the CMS. This command is only intended
                                       to be used with empty CMS spaces.
                                       <options: true|false>
  -n, --hub-name=<value>               (required) The Amplience Content Delivery 2 hub name, used as the delivery
                                       subdomain. This is the hub name and not the hub ID.
  -p, --personal-access-token=<value>  The Amplience Personal Access Token for the management API. Required for
                                       importing the content model.
      --hub-id=<value>                 The Amplience hub ID, required for importing the content model through dc-cli.
                                       This is the ID from hub settings and not the hub name.
      --no-config-file                 [env: SCAYLE_CLI_NO_CONFIG_FILE] Disable generating a config file.
      --non-interactive                [env: SCAYLE_CLI_NON_INTERACTIVE] Never prompt. A missing required value aborts
                                       with an error instead of asking, and a prompt with a safe default takes that
                                       default.

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Set to debug or trace to enable verbose debug output.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Configures the Storefront Application to use Amplience as the CMS provider.

EXAMPLES
  $ sfcli setup cms amplience

See code: src/commands/setup/cms/amplience.ts

sfcli setup cms contentful

Configures the Storefront Application to use Contentful as the CMS provider.

USAGE
  $ sfcli setup cms contentful -i true|false (--access-token <value> -s <value>) (--preview-token <value> ) [--json]
    [--log-level debug|warn|error|info|trace] [-h] [--no-config-file] [--non-interactive] [--management-token <value> ]

FLAGS
  -h, --no-header                      Disable initial header print for the CLI.
  -i, --import-content-model=<option>  (required) Import the content model in to the CMS. This command is only intended
                                       to be used with empty CMS spaces.
                                       <options: true|false>
  -s, --space-id=<value>               (required) The Contentful Space ID you want to use.
      --access-token=<value>           (required) Delivery API access token for Contentful. Used by the app to fetch
                                       published content.
      --management-token=<value>       Content Management API access token for Contentful. Required for importing the
                                       content model.
      --no-config-file                 [env: SCAYLE_CLI_NO_CONFIG_FILE] Disable generating a config file.
      --non-interactive                [env: SCAYLE_CLI_NON_INTERACTIVE] Never prompt. A missing required value aborts
                                       with an error instead of asking, and a prompt with a safe default takes that
                                       default.
      --preview-token=<value>          (required) Preview API access token for Contentful. Allows the app to fetch
                                       draft/unpublished content for preview purposes.

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Set to debug or trace to enable verbose debug output.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Configures the Storefront Application to use Contentful as the CMS provider.

EXAMPLES
  $ sfcli setup cms contentful

See code: src/commands/setup/cms/contentful.ts

sfcli setup cms contentstack

Configures the Storefront Application to use Contentstack as the CMS provider.

USAGE
  $ sfcli setup cms contentstack -i true|false (-d <value> -k <value>) (-p <value> ) -r
    na|eu|au|azure-na|azure-eu|gcp-na|gcp-eu (-e <value> ) [--json] [--log-level debug|warn|error|info|trace] [-h]
    [--no-config-file] [--non-interactive] [-b <value>] [-m <value> ]

FLAGS
  -b, --branch=<value>                 [default: main] Branch UID used with Contentstack's branch feature
  -d, --delivery-token=<value>         (required) Content Delivery Token used for fetching published content via Content
                                       Delivery API.
  -e, --environment=<value>            (required) Environment name in Contentstack determines which environment to use
                                       for content retrieval.
  -h, --no-header                      Disable initial header print for the CLI.
  -i, --import-content-model=<option>  (required) Import the content model in to the CMS. This command is only intended
                                       to be used with empty CMS spaces.
                                       <options: true|false>
  -k, --api-key=<value>                (required) Contentstack Stack API Key required to identify the target stack.
  -m, --management-token=<value>       Contentstack Management Token required for importing the content model via the
                                       Management API.
  -p, --preview-token=<value>          (required) Content Preview Token used for fetching draft/preview content via
                                       Content Preview API.
  -r, --region=<option>                (required) Region for the stack
                                       <options: na|eu|au|azure-na|azure-eu|gcp-na|gcp-eu>
      --no-config-file                 [env: SCAYLE_CLI_NO_CONFIG_FILE] Disable generating a config file.
      --non-interactive                [env: SCAYLE_CLI_NON_INTERACTIVE] Never prompt. A missing required value aborts
                                       with an error instead of asking, and a prompt with a safe default takes that
                                       default.

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Set to debug or trace to enable verbose debug output.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Configures the Storefront Application to use Contentstack as the CMS provider.

EXAMPLES
  $ sfcli setup cms contentstack

See code: src/commands/setup/cms/contentstack.ts

sfcli setup cms storyblok

Configures the Storefront Application to use Storyblok as the CMS provider.

USAGE
  $ sfcli setup cms storyblok -i true|false (--access-token <value> -s <value>) [--json] [--log-level
    debug|warn|error|info|trace] [-h] [--no-config-file] [--non-interactive] [-p <value>] [-r eu|cn|us|ca|ap]

FLAGS
  -h, --no-header                      Disable initial header print for the CLI.
  -i, --import-content-model=<option>  (required) Import the content model in to the CMS. This command is only intended
                                       to be used with empty CMS spaces.
                                       <options: true|false>
  -p, --personal-access-token=<value>  The Storyblok Personal Access Token for the Management API. Required for
                                       importing the content model.
  -r, --region=<option>                Region of your Storyblok space. Derived from the Space ID when omitted, so pass
                                       it only to override that. Selects the Management API host for the content model
                                       import; in a Storefront Application V3 project it is also written to
                                       STORYBLOK_CMS_REGION.
                                       <options: eu|cn|us|ca|ap>
  -s, --space-id=<value>               (required) The unique Space ID for your Storyblok space. This identifies the
                                       specific Storyblok space to connect to.
      --access-token=<value>           (required) The Storyblok Preview or Public Access Token used for the Content
                                       Delivery API.
      --no-config-file                 [env: SCAYLE_CLI_NO_CONFIG_FILE] Disable generating a config file.
      --non-interactive                [env: SCAYLE_CLI_NON_INTERACTIVE] Never prompt. A missing required value aborts
                                       with an error instead of asking, and a prompt with a safe default takes that
                                       default.

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Set to debug or trace to enable verbose debug output.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Configures the Storefront Application to use Storyblok as the CMS provider.

EXAMPLES
  $ sfcli setup cms storyblok

See code: src/commands/setup/cms/storyblok.ts

License

Licensed under the MIT License

What is SCAYLE?

SCAYLE is a full-featured e-commerce software solution that comes with flexible APIs. Within SCAYLE, you can manage all aspects of your shop, such as products, stocks, customers, and transactions.

Learn more about SCAYLE’s architecture and commerce modules in the Docs.

Other channels

• LinkedIn
• Jobs