| Script |
Description |
npm run config:devices |
Starts wizard for interactive creation of device-configuration.json file.
|
npm run serve:dev [-- options] |
Starts local http server. Application will be served in development mode.
Options:
host=ip address
Specifies IP address of network interface which will be bound to running server. Override's webpack's devServer.host setting.
port=port number
Allows to specify port to be used. Override's webpack's devServer.port setting
Examples:
npm run serve:dev -- host=192.168.137.1
Bind server to interface with IP 192.168.137.1
npm run serve:dev -- host=192.168.137.1 port=6666
Bind server to interface with IP 192.168.137.1 using port number 6666
|
npm run serve:prod [-- options] |
Starts local http server. Application will be served in production mode.
npm run serve:dev options apply to npm run serve:prod
|
npm run bundle:clean |
Clears bundle and package output directories.
dist - bundle directory
out - package directory
|
npm run bundle:dev |
Bundles application in development mode. Generated bundle will be placed
in dist directory.
|
npm run bundle |
Bundles application in production mode. Generated bundle will be placed
in dist directory.
|
npm run target:pack [-- options]
|
Creates device package from bundle, placing result in out
directory. When run without any options, Certificate Manager active profile will be used when signing package.
Options:
device=name
Name of the device as defined in device-configuration.json file. Certificate profile, if defined in file, will be used for signing device package.
profile=name
Name of certification profile to use for signing device package.
Examples:
npm run target:pack
Create device package using Certificate Manager active profile.
npm run target:pack -- profile=MyProfile
Created device package will be signed using profile named MyProfile. Profile with such name must be defined in Certificate Manager but does not have to be active.
npm run target:pack -- device=MyDevice
Certificate profile associated with MyDevice in device-configuration.json will be used to sign device package. If MyDevice does not specify certification profile, Certificate Manager active profile will be used.
|
npm run target:install [-- options]
|
Installs device package on target device. Device package should be created with npm run target:pack prior to installation.
When invoked without any options, Device Manager active connection defines target device where application will be installed.
Options:
device=name
Name of the device defined in device-configuration.json file. Application will be installed on devices specified by target property associated with named device.
target=device ip:port
IP:port address of device where to install application.
Examples:
npm run target:install
Application will be installed on first active device in Device Manager.
npm run target:install -- device=MyDevice
Target device associated with MyDevice defined in device-configuration.json will be used for installation.
npm run target:install -- target=IP
npm run target:install -- target=IP:Port
Install application on target device specified by IP or IP:Port. Port defaults to 26101 when omitted.
|
npm run target:launch [-- options]
|
Launches installed application on target device.
Prior to launch, application should be installed on target device.
When invoked without any options, Device Manager active connection defines target device where application will be installed.
Options:
device=name
Name of the device as defined in device-configuration.json file. Application will be launched on devices specified by targetIp.
target=device ip:port
IP:port address of device where to launch application.
Examples:
npm run target:launch
Starts application on first active device in Device Manager.
npm run target:launch -- device=MyDevice
Start application on target device associated with MyDevice defined in device-configuration.json
npm run target:launch -- target=IP
npm run target:launch -- target=IP:Port
Launch application on target device specified by IP or IP:Port. Port defaults to 26101 when omitted.
|
npm run target:kill [-- options]
|
Terminates application running on target device. When invoked without any options, Device Manager active connection defines target device on which application is to be terminated.
Options:
device=name
Name of the device as defined in device-configuration.json file. Application will be terminated on devices specified by targetIp.
target=device ip:port
IP:port address of device on which application is to be terminated.
Examples:
npm run target:kill
Terminates application on first active device in Device Manager.
npm run target:kill -- device=MyDevice
Terminates application on target device associated with MyDevice defined in device-configuration.json
npm run target:kill -- target=IP
npm run target:kill -- target=IP:Port
Terminates application on target device specified by IP or IP:Port. Port defaults to 26101 when omitted.
|
npm run target:devtools [-- options]
|
Launches installed application on target device attaching Chrome DevTools to running application. When invoked without any options, Device Manager active connection defines target device on which application is to be launched. DevTools frontend will be opened in default browser.
Options:
device=name
Name of the device as defined in device-configuration.json file. Application will be launched on devices specified by targetIp to which Chrome DevTools will be attached.
Configuration file allows to specify chrome browser to be used as frontend client for DevTools via chrome field. For best debugging experience, it is recommended to use Chrome version matching Web Client running target device.
target=device ip:port
IP:port address of device on which application application is to be launched. Attached Chrome DevTools will be opened in default browser, unless chrome parameter is specified.
chrome=path to chrome executable
Chrome executable to to be used as frontend to
Chrome DevTools
Examples:
npm run target:devtools
Starts application in debug mode on first active device in Device Manager. Chrome DevTools will be opened in default browser
npm run target:devtools -- device=MyDevice
Starts application in debug mode on target device associated with MyDevice defined in device-configuration.json
If MyDevice definition contains chrome field pointing to chrome executable then this executable will be used as DevTools frontend, otherwise frontend will be opened in default browser.
npm run target:devtools -- target=IP
npm run target:devtools -- target=IP:Port
Starts application in debug mode on target device specified by IP or IP:Port. Port defaults to 26101 when omitted.
npm run target:devtools -- chrome=C:\path\to\chrome.exe
Starts application in debug mode on first active device in Device Manager using chrome executable C:\path\to\chrome.exe as DevTools frontend.
npm run target:devtools -- target=IP chrome=C:\path\to\chrome.exe
Starts application in debug mode on target device specified by IP:26101 with DevTools frontend client C:\path\to\chrome.exe
|
npm run target:run:dev [-- options]
npm run target:run [-- options]
npm run target:debug:dev [-- options]
npm run target:debug [-- options]
|
npm run target:run / npm run target:debug are an all-in-one scripts which bundle application, create target package, install it and run newly installed application on target device, optionally attaching Chrome DevTools to running application. When invoked without any options, target bundle will be signed with Certificate Manager active profile and installed on device being currently active in Device Manager. When used in debug mode, DevTools frontend will be opened in default browser.
dev postfix specifies development mode. bundling. If not present, production mode will be used.
Options:
device=name
Name of the device as defined in device-configuration.json file. Application will be launched on devices specified by targetIp to which Chrome DevTools will be attached.
Configuration file allows to specify chrome browser to be used as frontend client for DevTools via chrome field. For best debugging experience, it is recommended to use Chrome version matching Web Engine running target device.
target=device ip:port
IP:port address of device on which application application is to be launched. Attached Chrome DevTools will be opened in default browser, unless chrome parameter is specified.
chrome=path to chrome executable
Chrome executable to to be used as frontend to
Chrome DevTools.
Examples:
See npm run target:devtools / npm run target:launch for options usage.
|
npm run target:serve:run [-- options]
npm run target:serve:debug [-- options]
See Known issues
|
npm run target:serve:* are an all-in-one scripts, similar to their 'run' equivalents, however, instead of launching an application on target device, a loader application is installed and launched on target device.
Loader is a hosted application . In contrast to standard applications, hosted apps are downloaded from external server specified in application's config.xml file via content src field.
By default, Webpack's Dev Server is used for this purpose. hot/live reload behavior settings are defined in scripts/webpack.common.js file.
When invoked without any options, loader application will be signed using Certificate Manager active profile and installed on a device active in Device Manager. Server url will be infered from scripts/webpack.common.js. If Webpack Dev Server is set to run on all interfaces, devServer.host="0.0.0.0", IPv4 of first network interface will be used as application source along with devServer.port and devServer.server.type settings.
run / debug postfix defines runtime model. In case of run, loader application will be launched on target device. If debug postfix is specified,
Chrome DevTools will be attached to launched application. Frontend will be opened in default browser.
Options:
device=name
Name of the device as defined in device-configuration.json file. Application will be launched on devices specified by targetIp.
Configuration file allows to specify chrome browser to be used as frontend client for DevTools via chrome field. For best debugging experience, it is recommended to use Chrome version matching Web Client running target device. Applies when script is invoked with debug postfix.
target=device ip:port
IP:port address of device on which application application is to be launched. Attached Chrome DevTools will be opened in default browser.
sourceUrl=server's ip:port
Specifies hot/live reload server IP:port to be used by loader application. When omitted, sourceURL is inferred from server settings,
however, in WAN scenarios server may not be accessible directly but via indirect address. This option allows to specify sourceUrl to be used.
chrome=path to chrome executable
Chrome executable to to be used as frontend to
Chrome DevTools.
|