# Command Reference {% hint style="warning" %} **Legacy Alias Deprecation Notice** Starting with **NodeJS Agent 6.2.1**, SeaLights supports standardised CLI parameter naming across technologies. Legacy parameter aliases remain supported for backward compatibility, but they are planned for future deprecation. Customers are strongly encouraged to migrate to the standardised CLI parameters as part of their regular maintenance and upgrade process. More information can be found in **Configuration Standards**. {% endhint %} ## NodeJS Agent — Command Reference ### Generating a Session ID (`config`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs config \ --token \ --appName \ --branchName \ --buildName ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The source branch of the application.
`--buildName`	`--build`	The build label of the current build.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--beControlledVersions`	`--becontrolledversions`	Updates the agent to the version defined by the backend configuration (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Scanning a Build (`scan`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs scan \ --token \ --buildSessionId \ --scanDir \ --outputPath \ --labId ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the SeaLights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	Session ID of configuration created.
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The source branch of the application.
`--buildName`	`--build`	The build label of the current build.
`--scanDir`	`--workspacePath`, `--distFolderPath`, `--distPath`, `--distributablePath`, `-w`	Path to the source workspace where the source code exists.
`--outputPath`	`-outputpath`	Folder to generate the instrumented JS files in when using the `instrumentForBrowsers` parameter.
`--excludeFiles`	`--excludedpaths`	Comma-separated list of files to exclude from scan. Supports wildcards (`` is any string, `?` is any character). For example: `'-with-dependencies.jar, bad-bad?.war, *-source.jar'`
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--useModulePrefix`		Add uniqueModuleId as prefix (if exists) to uniqueId and files path (Default: `false`).
`--jobName`	`--jobName`	Name of Jenkins job.
`--logsUrl`		Path to Jenkins log folder.
`--projectRoot`	`--projectRoot`	Path to the root of the project. Usually where the src folder resides.
`--recursive`		Enables recursive scan behavior (Default: `true`).
`--scanDotFolders`		Includes folders starting with `.` during scan and dryRun commands.
`--partialBuildMapping`		Splits build mapping into chunks with the specified number of files.
`--useRelativeSlMapping`		Uses paths relative to the workspace path (`--scanDir`) in `sl-mapping`.
`--compressSlMapping`		Compresses `sl-mapping` file before upload.
`--moduleName`	`--uniqueModuleId`	Unique module identifier. Value should remain consistent between runs.
`--autoResolveProjectRoot`		Automatically resolves project root during runtime. When set to `true` additional data will be appended to the end of the scanned code, which will be used to resolve the project root when running with a test listener (Default: `false`).
`--instrumentForBrowsers`	`--instrumentForBrowsers`	Instrument the javascript files for providing browser front-end coverage information. Must be used with the `--outputPath` parameter.
`--instrumentationOnly`	`--instrumentationOnly`	Only instrument the javascript files, without sending the build information to the SeaLights server (i.e. skip the build scan). This parameter must be used in addition to the `--instrumentForBrowsers` parameter.
`--toggleBasedBrowserInstrumentation`		Once enabled the browser agent will create separate instrumented files and keep the original files intact. If the preamble file is not found, the original files will be loaded in the browser (Default: `false`).
`--ctxPropagationOnly`		Enable only context propagation without performing any additional browser agent instrumentation (Default: `false`).
`--enableOpenTelemetry`	`--enableOpenTelemetry`	Enable open-telemetry instrumentation when working with the browser test listener (Default: `false`).
`--allowCORS`		Comma-separated origins allowed for header propagation (`*` to enable propagation everywhere). Defaults to current origin only. `--enableOpenTelemetry` must be `true` for this option.
`--allowedDomains`		Comma-separated list of domains where the browser agent should load. If empty string is passed, this option is disabled and agent is loaded for all domains (can be used to overwrite env var or remote config). In scan and dryRun commands --instrumentForBrowsers must be used for this to take effect.
`--delayShutdownInSeconds`		Shutdown time in seconds for the browser agent (Default: `30`).
`--excludeTokenFromBrowserConfig`		Exclude the browser agent token from the browser configuration file (Default: `false`).
`--rawCoverage`		Generates metadata required for processing coverage from v8 lightweight agent (Default: `false`).
`--es6Modules`	`--es6Modules`	Enables ES6 module handling during scan or run (Default: `false`).
`--es6Classes`		Enables ES6 class adjustments during scan. Use it when you scan `ts` classes that later transpiled to `es6` classes.
`--enrichPrivateMethods`		Enriches methods with accessibility modifiers.
`--hashIncludeNestedMethods`		Includes nested anonymous methods in hash calculation. First activation of this CLI parameter can cause false-positive code changes.
`--excludeNestedMethods`		Excludes nested methods from build mapping. First activation of this CLI parameter can cause false-positive code changes.
`--enableLineCoverage`		Enables line-level coverage mapping (Default: `false`).
`--useBranchCoverage`		Enables branch coverage collection (Default: `false`).
`--sourceHash`		Generates method hash from source files instead of generated code.
`--embedCorrectUniqueId`		Embeds unique ID mapping into instrumented files (Default: `false`).
`--resolveWithoutHash`		Resolves mappings without using hashes (Default: `true`).
`--newInstrumenter`		Uses `sl-istanbul-lib-instrument` instead of `istanbul-lib-instrument` (Default: `true`).
`--useBabylon`		Uses Babylon parser for scanning files (Default: `true`).
`--babylonPlugins`		Values: `decorators-legacy` - when there are decorators in the code. `jsx` - for React applications.
`--footprintsMapping`		Determines where browser footprints are resolved (`agent` or `server`). Default: `agent`.
`--enrichByLinesMatch`	`-l`	Enables experimental method matching algorithm.
`--enrichByMethodRange`		Matches methods using original method range positions. Implicitly sets recognizeBabelCreateClass on (Default: `false`).
`--experimentalDeduplicateEnrichedMethodsWithOriginals`		Removes duplicated methods from the build map (Default: `false`).
`--recognizeBabelCreateClass`		Improves recognition of Babel `_createClass` calls, even with code minification (Default: `false`).
`--preferSourceMapFromFile`		Gives precedence to file-based source maps over inline source maps (Default: `false`).
`--excludeSourceMapFiles`	`--excludeSourceMapFiles`	(Optional) During files instrumentation step, this option explicits what to do with `.js.map` files in the `--scanDir` and `--outputPath` folders: `none` - Do nothing and copy `.js.map` files as is to the `--outputPath` folder. `skipCopy` - Do not copy the `.js.map` files from `--scanDir` into `--outputPath` folder. `skipAndDelete` - Skip copy of `.js.map` files and delete them from the `--scanDir`.
`--skipInstrumentingFilesWithoutSourceMap`		Skip instrumenting files without source map (Default: `false`).
`--splitPreambleIntoFile`	`--splitPreambleIntoFile`	Moves instrumentation config into a separate file. Important: customer is responsible to make this file non-cacheable and accessible from the browser. Usage is `--splitPreambleIntoFile` to use (not `--splitPreambleIntoFile true`).
`--preambleFileName`	`--preambleFileName`	Used together with `--splitPreambleIntoFile` to define a custom preamble file name.
`--preambleFileUrl`	`--preambleFileUrl`	Used together with `--preambleFileName` to define a custom URL (Default: `""` which equals to root, you can pass like `https://example.com/a/b/c` or relative like `a/b/c`). Important: Only use this if you need a different server than the one used for the instrumented files. Important: actual URL will be `{preambleFileUrl}/{preambleFileName}`.
`--awsConfigure`		Creates `sl-config` files for AWS Lambda layer integration.
`--awsConfigKeysToIgnore`		Comma-separated list of AWS config keys to ignore. Supported values are: `token`, `buildSessionId`, `collectorUrl`, `projectRoot`, `labId`, `commonSrcPrefix`, `slMapping`, `proxy`, `rawCoverage`.
`--scmType`	`--scm`	Source control used Current options are: `git`, `none`.
`--scmProvider`	`--scmprovider`	The provider name of your Source Control Management (SCM) tool. Values: `Github`, `Bitbucket` and `Gitlab` (Default is Github).
`--repositoryUrl`	`--scmbaseurl`	The URL to the repository which contains the code. If not provided, the url of the remote GIT origin will be used. Example: `https://my.bitbucket.com/projects/ABCD/repos/XYZ/browse/A1`
`--scmVersion`	`--scmversion`	The version of your Source Control Management (SCM) tool. If left blank, cloud version is assumed. Otherwise, specify the version of your on-premise server.
`--commit`	`--commit`	Commit ID, as provided by the SCM.
`--dependency`	`--dependency`	Project dependencies. Format: semicolon:separated list of `AppName@BranchName@BuildName`.
`--dependenciesFile`	`-d`	Path to JSON file containing dependency definitions. Format: `[{"appName":"","branchName":"","buildName":"","buildSessionId":""}`.
`--sendContributors`	`--sendContributors`	Sends contributor details for advanced committer reports and features.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--collectorUrl`	`--collectorurl`	The URL to Sealights collector used to collect footprints from browser environment (Format: `https://<collectorIP>:<collectorPort>/api`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.
`--quiet`	`--quiet`	Suppresses console feedback messages only. Does not suppress log output when logging is configured to print to the console (Default: `false`).

### Ending a Multi-Module Build (`buildend`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs buildend \ --token \ --buildSessionId ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--ok`	`--ok`	Indicates a successful build.
`--failed`	`--failed`	Indicates a failed build.
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Instrumenting a Front-End Build (`instrument`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs instrument \ --token \ --buildSessionId \ --scanDir \ --outputPath \ --labId ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--scanDir`	`--workspacePath`, `--distFolderPath`, `--distPath`, `--distributablePath`, `-w`	Path to the source workspace where the source code exists.
`--outputPath`	`--outputpath`	Folder to generate the instrumented JS files in when using the `instrumentForBrowsers` parameter.
`--projectRoot`	`--projectRoot`	Path to the root of the project. Usually where the src folder resides.
`--toggleBasedBrowserInstrumentation`		Once enabled the browser agent will create separate instrumented files and keep the original files intact. If the preamble file is not found, the original files will be loaded in the browser (Default: `false`).
`--ctxPropagationOnly`		Enable only context propagation without performing any additional browser agent instrumentation (Default: `false`).
`--collectorUrl`	`--collectorurl`	The URL to Sealights collector used to collect footprints from browser environment (Format: `https://<collectorIP>:<collectorPort>/api`).
`--enableOpenTelemetry`	`--enableOpenTelemetry`	Enable open-telemetry instrumentation when working with the browser test listener (Default: `false`).
`--allowCORS`		Comma-separated origins allowed for header propagation (`*` to enable propagation everywhere). Defaults to current origin only. `--enableOpenTelemetry` must be `true` for this option.
`--allowedDomains`		Comma-separated list of domains where the browser agent should load. If empty string is passed, this option is disabled and agent is loaded for all domains (can be used to overwrite env var or remote config). In scan and dryRun commands --instrumentForBrowsers must be used for this to take effect.
`--excludeTokenFromBrowserConfig`		Exclude the browser agent token from the browser configuration file (Default: `false`).
`--delayShutdownInSeconds`		Shutdown time in seconds for the browser agent (Default: 30 seconds).
`--es6Modules`	`--es6Modules`	Enables ES6 module handling during scan or run (Default: `false`).
`--babylonPlugins`		Values: `decorators-legacy` - when there are decorators in the code. `jsx` - for React applications.
`--footprintsMapping`		Determines where browser footprints are resolved (`agent` or `server`). Default: `agent`.
`--splitPreambleIntoFile`	`--splitPreambleIntoFile`	Moves instrumentation config into a separate file. Important: customer is responsible to make this file non-cacheable and accessible from the browser. Usage is `--splitPreambleIntoFile` to use (not `--splitPreambleIntoFile true`).
`--preambleFileName`	`--preambleFileName`	Used together with `--splitPreambleIntoFile` to define a custom preamble file name.
`--preambleFileUrl`	`--preambleFileUrl`	Used together with `--preambleFileName` to define a custom URL (Default: `""` which equals to root, you can pass like `https://example.com/a/b/c` or relative like `a/b/c`). Important: Only use this if you need a different server than the one used for the instrumented files. Important: actual URL will be `{preambleFileUrl}/{preambleFileName}`.
`--no-reduceFileSize`		Optimizes instrumented file size.
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Running Backend Server (`run`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs run \ --token \ --buildSessionId \ --scanDir \ --labId \ --testStage ``` {% hint style="info" %} Example of command: {% code overflow="wrap" %} ```bash npx slnodejs run --tokenFile ./sltoken.txt --buildSessionIdFile buildSessionId --labId "LAB_ID_2" --workspacePath "./server" --useinitialcolor true -- "./server/app.js" ``` {% endcode %} Note the `./server` in the `--workspacePath` refers to `./server/app.js` in the above example. {% endhint %} #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The build label of the current build.
`--buildName`	`--build`	The build label of the current build.
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--testStage`	`--teststage`	'integration tests', 'regression'). The default will be 'Unit Tests'.
`--useBranchCoverage`		Enables branch coverage collection (Default: `false`).
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--collectorUrl`	`--collectorurl`	The URL to Sealights collector used to collect footprints from browser environment (Format: `https://<collectorIP>:<collectorPort>/api`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--scanDir`	`--workspacePath`, `--distFolderPath`, `--distPath`, `--distributablePath`, `-w`	Path to the source workspace where the source code exists.
`--outputPath`	`--outputpath`	Folder to generate the instrumented JS files in when using the `instrumentForBrowsers` parameter.
`--projectRoot`	`--projectRoot`	Path to the root of the project. Usually where the src folder resides.
`--es6Modules`	`--es6Modules`	Enables ES6 module handling during scan or run (Default: `false`).
`--httpServerColoring`		Enables server-side coloring propagation (Default: `false`).
`--httpClientColoring`		Enables client-side coloring propagation (Default: `false`).
`--useInitialColor`	`--useinitialcolor`	Enables generic mode for unsupported test frameworks (Default: `false`).
`--libraries`		Comma-separated list of Node modules to include in coverage. CSV format: `--libraries=@socket.io,agent-base,chokidar`.
`--omitFootprintsLeadingSlash`		Removes leading slash from footprint paths if present (Default: `false`).
`--forwardSignals`		Enables signal forwarding for graceful shutdown in containerized environments. When enabled, termination signals (SIGTERM, SIGINT, etc.) are properly forwarded to the child application process (Default: `false`).
`--signalForwardingTimeout`		Timeout in seconds before forcefully terminating child process after signal forwarding (Default: `10`).
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Updating/deleting a Component from an Integration Build (`componentUpdate` or `componentDelete`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs componentUpdate \ --token \ --buildSessionId \ --componentIds ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The source branch of the application.
`--buildName`	`--build`	The build label of the current build.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--componentIds`	`--componentids`	A list of comma-separated components build session ids (BSIDs).
`--componentFile`	`--componentfile`	A path to a json file. Format: `[{"appname":"","branch":"","build":"","buildSessionId":""},{...}]`. Every entry may include `appName+branchName+buildName` or `buildSessionId`.
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Test Listener - Opening a Test Stage (`start`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs start \ --token \ --buildSessionId \ --labId \ --testStage ``` {% hint style="warning" %} The `buildSessionId` and `buildSessionIdFile` parameters are **deprecated** for test-runner commands. Use `labId` instead. These parameters remain supported only for unit-test runners that execute the build's code directly (e.g. Mocha, Karma, AVA). {% endhint %} #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--testStage`	`--teststage`	Name of the test stage.
`--testGroupId`	`--testgroupid`	The test group id.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The source branch of the application.
`--buildName`	`--build`	The build label of the current build.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--componentIds`	`--componentids`	A list of comma-separated components build session ids (BSIDs).
`--componentFile`	`--componentfile`	A path to a json file. Format: `[{"appname":"","branch":"","build":"","buildSessionId":""},{...}]`. Every entry may include `appName+branchName+buildName` or `buildSessionId`.
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Test Listener - Uploading Report Files (`uploadReports`) {% hint style="warning" %} Report files must be JUnit style XML reports. {% endhint %} This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs uploadReports \ --token \ --buildSessionId \ --file \ --filesFolder ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--testStage`	`--teststage`	Name of the test stage.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The source branch of the application.
`--buildName`	`--build`	The build label of the current build.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--file`	`--reportfile`	Path to report file. This argument can be declared multiple times in order to upload multiple files (Default: `[]`).
`--filesFolder`	`--reportfilesfolder`	Path to folder that contains nothing but report files. All files in folder will be uploaded. This argument can be declared multiple times in order to upload multiple files from multiple folders containing report files. Note: all files in the folder will be uploaded.
`--source`	`--source`	Source of test framework (Default: `Mocha`).
`--type`	`--type`	Type of test report (Default: `JUnitReport`).
`--hasMoreRequests`	`--hasmorerequests`	Indicats whether or not to stop execution after upload (Default: `true`).
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Test Listener - Upload Coverage Files (`nycReport`) {% hint style="warning" %} The coverage file must be in JSON format, created by the [Istanbuljs/nyc](https://istanbul.js.org/) framework. {% endhint %} This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash npx slnodejs nycReport \ --token \ --buildSessionId \ --labId \ --report \ --projectRoot ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--testStage`	`--teststage`	Name of the test stage.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The source branch of the application.
`--buildName`	`--build`	The build label of the current build.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--report`	`--report`	Path to the relevant nyc json report. This command needs an open execution to work. Passing a test-stage using the `--testStage` will automatically open an execution. (Default: `"/Users/username/coverage/coverage-final.json"`)
`--projectRoot`	`--projectroot`	Determines the root directory of a project (Default: current working directory).
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Test Listener - Closing a Test Stage (`end`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs end \ --token \ --buildSessionId \ --labId ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The source branch of the application.
`--buildName`	`--build`	The build label of the current build.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Running Tests via Mocha (`mocha`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs mocha \ --token \ --buildSessionId \ --labId \ --testStage ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--testStage`	`--teststage`	Name of the test stage.
`--appName`	`--appname`	Name of the application.
`--branchName`	`--branch`	The source branch of the application.
`--buildName`	`--build`	The build label of the current build.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--skipUpgrade`	`--skipupgrade`	Prevents the agent from attempting automatic upgrades (Default: `false`).
`--overrideServer`	`--overrideserver`	Overrides the server URL used by the agent for connectivity. Example use case: using the Collector as a proxy.
`--useBranchCoverage`		Enables branch coverage collection (Default: `false`).
`--httpServerColoring`		Enables server-side coloring propagation (Default: `false`).
`--httpClientColoring`		Enables client-side coloring propagation (Default: `false`).
`--projectRoot`	`--projectRoot`	Path to the root of the project. Usually where the src folder resides.
`--es6Modules`	`--es6Modules`	Enables ES6 module handling during scan or run (Default: `false`).
`--testGroupId`	`--testgroupid`	The test group id.
`--testProjectId`	`--testprojectid`	The test project id.
`--resolveWithoutHash`		Resolves mappings without using hashes (Default: `true`).
`--disableTia`	`--enforcefullrun`, `--tiadisabled`	Disables Test Optimization and runs the full test suite.
`--prId`	`--prid`	The PR id.
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

### Running Tests via Jasmine (`jasmine`) This example is with minimum required CLI Parameters. All available CLI Parameters can be found in the table below. ```bash ##Minimum required CLI parameters npx slnodejs jasmine \ --token \ --buildSessionId \ --labId \ --testStage ``` #### All CLI Parameters

CLI Parameter	Legacy Alias	Description
`--token`	`--token`	Access token generated from the Sealights server.
`--tokenFile`	`--tokenfile`	Path to file containing access token generated from the SeaLights server.
`--buildSessionId`	`--buildsessionid`	(Optional) A user provided session ID (case-sensitive).
`--buildSessionIdFile`	`--buildsessionidfile`	Path to file containing the Session ID of configuration created.
`--labId`	`--labid`	Unique ID for a set of test labs in case multiple labs are running simultaneously or for an Integration Build. This needs to be done during the instrumentation process when using the `instrumentForBrowsers` option.
`--testStage`	`--teststage`	Name of the test stage.
`--failOnError`	`--failbuild`	Flag indicating whether the command should exit with status code `1` if the command fails (Default: `false`).
`--proxy`	`--proxy`	Address of proxy to run connection through.
`--help`	`--help`	Show Help message and exit.

## Logging To **enable logs,** you can set the `NODE_DEBUG` environment variable to a value defining the output per the table below: | Linux | Powershell | | ---------------------- | ---------------------- | | `export NODE_DEBUG=sl` | `$env:NODE_DEBUG="sl"` | | Value | Description | | --------- | -------------------------------------------------------------- | | `sl` | Display log output to the console | | `sl-file` | Export the log information to a log file named '`sl.node.log`' | Furthermore, you can **set the logging level** using the `SL_LOG_LEVEL` environment variable with one of the following options: `info` (default) or `debug`. {% code overflow="wrap" lineNumbers="true" %} ```bash export NODE_DEBUG=sl export SL_LOG_LEVEL=debug ``` {% endcode %} To write the log to a specific directory, use `SL_LOG_OUTPUT_FILE` and ensure that the directory has a write permissions. {% code overflow="wrap" lineNumbers="true" %} ```bash export NODE_DEBUG=sl-file export SL_LOG_LEVEL=debug export SL_LOG_OUTPUT_FILE=/var/log/my-custom.log ``` {% endcode %} To **disable logs**, unset the `NODE_DEBUG` variable. {% code overflow="wrap" lineNumbers="true" %} ``` export NODE_DEBUG= ``` {% endcode %} {% hint style="info" %} The above examples are for Linux shells; for Windows CMD prompt, use the `set` command. {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sealights.io/knowledgebase/setup-and-configuration/sealights-agents-and-plugins/node.js-agent/command-reference.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.