Help Center

Menu

dev

The dev group of commands offer access to the local component runner. 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 [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")
  -nb, --no-browser              Disables launching browser when starting the server
  -e --edge-components           For developing components of type "edge"
  -h, --help                     display help for command

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

With the release of DXP CLI v5.20.0, the cmp dev command returns the following deprecation warning:

Warning: The command "dev" is deprecated and will be removed in a future release. Please use "dev-ui" instead

The recommended way forward is to use the local dev-ui by running:

dxp-next cmp dev-ui <source>