A command-line tool that accelerates feature adoption in SCAYLE Storefront Application projects by simplifying the integration of new features and updates from the Storefront Application.
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.
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 Application version, manages potential file conflicts, and optionally includes unit tests.\ This streamlined workflow significantly reduces manual effort and accelerates the overall development process.
Usage
$3
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.
FLAGS -e, --env-key= (required) [env: SCAYLE_CLI_ENV_KEY] Env Key is needed for identifying the correct environment. -g, --git-ref= [env: SCAYLE_CLI_GIT_REF] Git ref 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= (required) [env: SCAYLE_CLI_SHOP_KEY] Shop Key is needed for identifying the correct shop. -t, --tenant-space= (required) [env: SCAYLE_CLI_TENANT_SPACE] Tenant Space is needed for identifying the correct context within the SCAYLE Core System. --deploy-token= (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.
GLOBAL FLAGS --json Format output as json. --log-level=
[default: info] Specify level for logging.
DESCRIPTION The deploy command will initiate a new deployment to SCAYLE PaaS and and display the build logs.
The setup command will guide the user through a series of interactive prompts to gather the necessary information for configuring the Storefront Application.
FLAGS -a, --admin-api-token= (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= Shop key to setup a shop directly. -t, --tenant-space= (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.
GLOBAL FLAGS --json Format output as json. --log-level=
[default: info] Specify level for logging.
DESCRIPTION The setup command will guide the user through a series of interactive prompts to gather the necessary information for configuring the Storefront Application.
FLAGS -h, --no-header Disable initial header print for the CLI. -i, --import-content-model=
(required) Import the content model in to the CMS. This command is only intended to be used with empty CMS spaces. -s, --space-id= (required) The Contentful Space ID you want to use. --access-token= (required) Delivery API access token for Contentful. Used by the app to fetch published content. --management-token= (required) 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. --preview-token= (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=
[default: info] Specify level for logging.
DESCRIPTION Configures the Storefront Application to use Contentful as the CMS provider.
FLAGS -b, --branch= [default: main] Branch UID used with Contentstack’s branch feature -d, --delivery-token= (required) Content Delivery Token used for fetching published content via Content Delivery API. -e, --environment= (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=
(required) Import the content model in to the CMS. This command is only intended to be used with empty CMS spaces. -k, --api-key= (required) Contentstack Stack API Key required to identify the target stack. -m, --management-token= (required) Contentstack Management Token required for importing the content model via the Management API. -p, --preview-token= (required) Content Preview Token used for fetching draft/preview content via Content Preview API. -r, --region=
(required) Region for the stack --no-config-file [env: SCAYLE_CLI_NO_CONFIG_FILE] Disable generating a config file.
GLOBAL FLAGS --json Format output as json. --log-level=
[default: info] Specify level for logging.
DESCRIPTION Configures the Storefront Application to use Contentstack as the CMS provider.
FLAGS -h, --no-header Disable initial header print for the CLI. -i, --import-content-model=
(required) Import the content model in to the CMS. This command is only intended to be used with empty CMS spaces. -p, --personal-access-token= The Storyblok Personal Access Token for the Management API. Required for importing the content model. -s, --space-id= (required) The unique Space ID for your Storyblok space. This identifies the specific Storyblok space to connect to. --access-token= (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.
GLOBAL FLAGS --json Format output as json. --log-level=
[default: info] Specify level for logging.
DESCRIPTION Configures the Storefront Application to use Storyblok as the CMS provider.
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.