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 Boilerplate. It allows tenants to selectively add individual feature components, even if their project is based on an older Boilerplate version, avoiding the need for a full Boilerplate upgrade.
The CLI handles the complexities of component delivery and integration, allowing developers to focus on customizing and implementing the feature's functionality.
It automatically fetches the necessary components based on the selected feature and Storefront Boilerplate version, manages potential file conflicts, and optionally includes unit tests.
This streamlined workflow significantly reduces manual effort and accelerates the overall development process.
To always use the current version of the CLI we recommend to use the package as remote npm package (npx Documentation). This will always fetch the current version of the Storefront CLI and will contain the newest files to add to the SFB.
$ npx @scayle/storefront-cli COMMAND$ npm install -g @scayle/storefront-cli
$ sfcli COMMAND
running command...
$ sfcli (--version)
@scayle/storefront-cli/0.9.14 linux-x64 node-v22.16.0
$ sfcli --help [COMMAND]
USAGE
$ sfcli COMMAND
...Adds a SCAYLE Storefront feature module to Storefront projects,
USAGE
$ sfcli add [PACKAGES] -a <value> [--json] [--log-level debug|warn|error|info|trace] [-h]
[--no-config-file] [-c] [-f] [-s <value>]
ARGUMENTS
PACKAGES (country-detection|navigation|product-listing|product-details|promotions|search) Directly install one or
more specific packages, bypassing the multi-select prompt.
FLAGS
-a, --access-token=<value> (required) Access Token for Storefront Boilerplate repository
-c, --should-copy Copy relevant feature module components and related files
-f, --should-override Override existing files while copying relevant feature module components and related files
-h, --no-header Disable initial header print for the CLI.
-s, --src-dir=<value> Custom srcDir where the components are stored.
--no-config-file Disable generating a config file.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<options: debug|warn|error|info|trace>
DESCRIPTION
Adds a SCAYLE Storefront feature module to Storefront projects,
with an option to include the associated Vue components and unit tests.
EXAMPLES
$ sfcli add
See code: src/commands/add.ts
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
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] [-g <value>]
FLAGS
-e, --env-key=<value> (required) Env Key is needed for identifying the correct environment.
-g, --git-rev=<value> Git revision is used to checkout the specific version of the app that should be deployed
-h, --no-header Disable initial header print for the CLI.
-s, --shop-key=<value> (required) Shop Key is needed for identifying the correct shop.
-t, --tenant-space=<value> (required) Tenant Space is needed for identifying the correct context within the SCAYLE
Core System.
--deploy-token=<value> (required) Deploy Token is needed to authenticate against the SCAYLE PaaS System.
--no-config-file Disable generating a config file.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<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
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
The setup command will guide the user through a series of interactive prompts to gather the necessary information for configuring the Storefront Boilerplate.
USAGE
$ sfcli setup -t <value> -a <value> [--json] [--log-level debug|warn|error|info|trace] [-h]
[--no-config-file] [-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 feature module components and related
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 Disable generating a config file.
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> [default: info] Specify level for logging.
<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 Boilerplate.
EXAMPLES
$ sfcli setup
See code: src/commands/setup.ts
Licensed under the MIT License
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.