SeaLights Node.js agent - Command Reference
Configure a session and create session ID
npx slnodejs config {--token <token> | --tokenfile <file>} --appname <appname> --branch <branch> --build <build> [--buildsessionid <buildsessionid>] [--proxy <proxy>] [--failbuild {true|false}]
Parameter | Description |
---|---|
| Access token generated from the Sealights server |
| Path to file containing access token generated from the SeaLights server |
| Name of the application |
| The source branch of the application |
| The build label of the current build |
| (Optional) A user provided session ID |
| Address of proxy to run connection through |
| Exit with an error code if an error is encountered (Default: |
Scanning a build
npx slnodejs scan {--token <token> | --tokenfile <file>} {--buildsessionid <id> | --buildsessionidfile <file>} --workspacepath <workspacepath> --scm {git|none} [--projectRoot <folder>] [--excludedpaths <excludedpaths>] [--uniqueModuleId <id>] [--es-modules] [--jobName <jobName>] [--logsUrl <logsUrl>] [--dependenciesFile <dependenciesFile>] [--instrumentForBrowsers --outputpath <folder> [--downloadAgent {true|false}] [--instrumentationOnly] [--labid <labid>] [--excludeSourceMapFiles {none|skipCopy|skipAndDelete}]] [--proxy <proxy>] [--failbuild {true|false}] [--scmBaseUrl <url> --scmProvider {github|gitlab|bitbucket} --scmVersion <arg>] [--es6Modules] [--babylonPlugins decorators-legacy|jsx] [--collectorUrl <url>] [--splitPreambleIntoFile --preambleFileUrl <url> --preambleFileName <fileName>] [--embedCorrectUniqueId]
Parameter | Description |
---|---|
| Access token generated from the SeaLights server |
| Path to file containing access token generated from the SeaLights server |
| Session ID of configuration created |
| Path to file containing the Session ID of configuration created |
| Path to the source workspace |
| Comma-separated list of files to exclude from scan Supports wildcards (* = any string, ? = any character). For example: |
| Path to the root of the project. Usually where the src folder resides |
| Unique name when providing more than one build scan per build |
| Indicates that you use es6 modules |
| Name of Jenkins job |
| Path to Jenkins log folder |
| Source control used. Current options are: |
| A path to a JSON file that is in the following format: |
| Instrument the JS files for providing browser front-end coverage information. Must be used with the |
| Set this value to ' |
| Only instrument the javascript files, without sending the build information to the SeaLights server (i.e. skip the build scan). |
| Folder to generate the instrumented JS files in when using the |
| Unique ID for a set of test labs in case multiple labs are running simultaneously or for an integration build. |
| Address of proxy to run connection through |
| Exit with an error code if an error is encountered (Default: |
| The provider name of your Source Control Management (SCM) tool. |
| The URL to the repository which contains the code. If not provided, the URL of the remote GIT origin will be used Example: |
| The version of your Source Control Management (SCM) tool. If not provided, Cloud version is assumed |
| Values:
|
| The URL for the Collector service. Format: “https://<collectorIP>:<collectorPort>/api” |
| (Optional) During files instrumentation step, this option explicits what to do with
|
| Split the preamble used for browser application into a separate file.
Usage is |
| Used together with
|
| Used together with |
| Used to enable context propagation on the Node application. Used with the See also: |
Ending a multi-module build
npx slnodejs buildend {--token <token> | --tokenfile <file>} {--buildsessionid <id> | --buildsessionidfile <file>} [--proxy <proxy>] [--failbuild {true|false}] [--skipUpgrade {true|false}] --ok | --failed
Parameter | Description |
---|---|
| Access token generated from the SeaLights server |
| Path to file containing access token generated from the SeaLights server |
| Session ID of configuration created |
| Path to file containing the Session ID of configuration created |
| Address of proxy to run connection through |
| Exit with an error code if an error is encountered (Default: |
| Should not try to upgrade agent (Default: |
| build finished successfully |
| build not finished successfully |
Updating/Deleting a component from an Integration build
Parameter | Description |
---|---|
| Access token generated from the SeaLights server |
| Path to file containing access token generated from the SeaLights server |
| Session ID of configuration created |
| Path to file containing the Session ID of configuration created |
| One or several build session ID's (comma separated) of the component(s) to be updated or deleted |
| A path to a JSON file that is in the following format: |
| Address of proxy to run connection through |
Test Listener
Starting a test stage
Parameter | Description |
---|---|
| Access token generated from the SeaLights server |
| Path to file containing access token generated from the SeaLights server |
| Session ID of configuration created |
| Path to file containing the Session ID of configuration created |
| Name of the test sta |