The CLI of Custom Applications allows you to start and build your application.
You could also install the CLI globally, but we recommend local installation instead.
This command starts the application in
development mode. It uses Webpack Dev Server with hot-code reloading, error reporting, and more.
By default the application starts at
This command bundles the application in
production mode and creates an optimized production build of your application in the
By default, the
build command compiles the
index.html, included in the
public folder. You can opt-out of the compilation step by using the option
--build-only. See Going to Production for more information.
--build-only: Generates production bundles without compiling the
index.html. To compile it, run
This command compiles the
index.html.template file into an
index.html file according to the Custom Application config. The production assets are then copied to the
public folder and are ready to be deployed.
See Going to Production for more information.
By default, compiling the
index.html is implicitly done in the
build command, unless the option
--build-only is used. In that case, you need to execute the
compile-html command separately.
This command starts a HTTP server to serve the previously built and compiled Custom Application, from the
public folder. This is useful for testing the production build locally.
We recommend to set up the following scripts in your
By default the application starts at
This command enables users to log in to their Merchant Center account through the CLI. An interactive prompt will be displayed asking the user to enter the login credentials.
Upon login, an API token is generated and stored. The API token will be used by other CLI commands that require a valid API token.
The command uses the cloud Region environment information from the Custom Application config. The API tokens are stored separately for each cloud Region.
This command allows users to synchronize the local Custom Application config with the Merchant Center. The sync implies that a new Custom Application will be created or an existing one will be updated.
Developers can use the
config:sync command to automatically manage the configuration of a Custom Application from the config file instead of having to manually fill out the information in the Merchant Center.
If a new Custom Application needs to be created, an interactive prompt will ask the user to select the Organization where the Custom Application should be configured to.
Additionally, after creating a new Custom Application using the
config:sync command, you must add the generated Custom Application ID to the application config file, following the instructions in the terminal.
Note that this command requires a valid API token. You can get one by using the
mc-scripts login command.
The command uses the cloud Region environment information from the Custom Application config.
Using dotenv files
mc-scripts CLI has the dotenv features built-in.
By default, the following dotenv files are loaded according to the current environment values specified on each command:
process.env.NODE_ENV. The files are merged and overwritten prioritized from top to bottom (highest defined variable overrides lower).
.env.production.local: local overrides of environment-specific settings.
.env.production: environment-specific settings.
.env.local: local overrides. This file is loaded for all environments except test.
Please refer to the dotenv documentation for more details.
Furthermore, you can pass additional dotenv files by using the following option:
--env <path>: Parses the file path as a dotenv file and adds the variables to the environment. Multiple flags are allowed.
These files will take higher priority over the standard environment dotenv files.