/
SeaLights Java agent - Command Reference

SeaLights Java agent - Command Reference

Build Scanner

Creating a session ID

Standard Session ID

java -jar sl-build-scanner.jar -config {-token <arg> | -tokenfile <arg>} -appname <arg> -branchname <arg> -buildname <arg> -pi <arg> [-pe <arg>] [-buildsessionid <arg>] [-proxy <arg>] [-buildsessionidfile <arg>]

Parameter

Description

Parameter

Description

token

Access token generated from the SeaLights server

tokenfile

Path to file containing access token generated from the SeaLights server

appname

Name of the application

branchname

The source branch of the application

buildname

The build label of the current build

pi, packagesincluded

Comma-separated list of packages to include in scan

Supports wildcards (* = any string, ? = any character). For example: 'com.example.* ,io.*.demo, com.?ello.world'

pe,packagesexcluded

Comma-separated list of packages to exclude from scan

Supports wildcards (* = any string, ? = any character). For example: 'com.example.* ,io.*.demo, com.?ello.world'

buildsessionid

Optional: A user provided session ID. (This ID must be under 40 characters length).

proxy

Address of proxy to run connection through

buildsessionidfile

Path to a file to save the build session id in. Default: buildSessionId.txt

Pull Request Session ID

java -jar sl-build-scanner.jar -prConfig {-token <arg> | -tokenfile <arg>} -appname <arg> -targetBranch <arg> -latestCommit <arg> -pullRequestNumber <arg> -repoUrl <arg> -pi <arg> [-pe <arg>] [-proxy <arg>] [-buildsessionidfile <arg>]

Parameter

Description

Parameter

Description

token

Access token generated from the SeaLights server

tokenfile

Path to file containing access token generated from the SeaLights server

appname

Name of the application

targetBranch

The branch to which this PR will be merged into (already reported to SeaLights)

latestCommit

The full SHA of the last commit made to the Pull Request

pullRequestNumber

The number assigned to the Pull Request from the source control

repoUrl

The pull request URL for the PR to be scanned, up until the section before the pullRequestNumber value

pi, packagesincluded

Comma-separated list of packages to include in scan. Supports wildcards (* = any string, ? = any character). For example: 'com.example.* ,io.*.demo, com.?ello.world'

pe,packagesexcluded

Comma-separated list of packages to exclude from scan. Supports wildcards (* = any string, ? = any character). For example: 'com.example.* ,io.*.demo, com.?ello.world'

proxy

Address of proxy to run connection through

buildsessionidfile

Path to a file to save the build session id in. Default: buildSessionId.txt

Scanning a build

java -jar sl-build-scanner.jar -scan {-token <arg> | -tokenfile <arg>} {-buildsessionid <arg> | -buildsessionidfile <arg>} [-workspacepath <arg>] [-r] [-baseSourceFolder <arg>] [-componentfile <arg>] [-enableNoneZeroErrorCode] [-fe <arg>] [-fi <arg>] [-moduleName <arg>] [-npf | -pfn <arg>] [-pathToMetaJson <arg>] [-proxy <arg>] [-scmProvider <arg>] [-scmBaseUrl <arg>] [-scmVersion <arg>] [-scm {git|none}] [-customFilterFile <arg>]

Parameter

Description

Parameter

Description

token

Access token generated from the SeaLights server

tokenfile

Path to file containing the access token generated from the SeaLights server

buildsessionid

Session ID of configuration created

buildsessionidfile

Path to file containing the Session ID of configuration created

workspacepath

Path to the source workspace

r, recursive

Recursive search all folders under the workspace path

baseSourceFolder

Relative path from user.dir to the workspace (specify the relative path from the .git folder up to com) Example: src/java

componentfile

A path to a json file that is in the following format:
[{"appName":"","branch":"","build":""}, {...}]
or
[{"buildSessionId":"", {...}]

enableNoneZeroErrorCode

Exit with an error code if an error is encountered

fe, filesexcluded

Comma-separated list of files to exclude from scan

Supports wildcards (* = any string, ? = any character). For example: '*-with-dependencies.jar , bad-bad?.war, *-source.jar'

use comma separated file names or paths like "SpecificFileName1.class,specificFileName2.class" OR "some/sub/folder/*Test.class,another/folder/*/resources/*"

Don’t use dot separated packages such as *.ms.*.gateways.mappers.implementation.MapResource.class

fi, filesincluded

Comma-separated list of files to include in scan

Supports wildcards (* = any string, ? = any character). For example: '*-with-dependencies.jar ,

use comma separated file names or paths like "SpecificFileName1.class,specificFileName2.class" OR "some/sub/folder/*Test.class,another/folder/*/resources/*"

Don’t use dot separated packages such as *.ms.*.gateways.mappers.implementation.MapResource.class

moduleName

Module name, the module name used in the pom.xml file Example: my-app

npf, noPropertiesFile

Do not generate Sealights property file

pfn, propertiesFileName

Path of Sealights property file to generate. Default is 'sealights.properties'

pathToMetaJson

Optional: Path to a json file with metadata regarding the build

proxy

Address of proxy to run connection through

scmProvider

The provider name of your Source Control Management (SCM) tool. Values: Github, Bitbucket and Gitlab (Default is Github)

scmBaseUrl

The URL to the repository which contains the code. If not provided, the url of the remote GIT origin will be used

scmVersion

The version of your Source Control Management (SCM) tool. If not provided, cloud version is assumed

scm

Search for git information. Values: git, none (Default is git)

customFilterFile

Path to JSON format method filter rules file, format described here