Help Center

Menu

dev-ui

The dev-ui group of commands offer access to the local component user interface. The runner lets you create a local preview environment for your component so you do not need to upload it to the Squiz DXP to preview it.

Usage: dxp-next cmp dev-ui [options] <source>

A local component runner for developing new components

Arguments:
  source                         folder containing the template files in development

Options:
  -p, --port <number>            Define port the webserver runs on (default: 3000)
  -l, --logging-format <string>  Format of log output (choices: "human", "json", default: "human")
  -h, --help                     display help for command

The logs are currently bunyan formatted and should be piped into the bunyan cli: dxp-next cmp dev-ui <source> | npx bunyan

The dev-ui command is not availble for components at edge as the UI tooling does not support ES Modules. Attempting to use the dev-ui command will produce the following error:

error: Error: ESM style modules are not supported.