Page Comparison

apiKey 

(Mandatory) A unique identifier of your organization. Used to identify the organization in plugins. 

N/A

N/A

No default

-apiKey

userKey 

Unique identifier of the user that can be generated from the Profile page in your Mend account.

NOTE: Required only if Enforce user level access is selected in the Integrate page.

N/A

N/A

No default

-userKey

requesterEmail 

The provided email will be matched with an existing Mend account. Requests for new libraries will be created with the matched account as the requester email.

user@provider.com

N/A

N/A

No default

No

projectName 

The name of the project to update (mandatory).

NOTE: Only required if projectToken is not defined.

N/A

N/A

No default

-project

projectVersion 

The project's version.

NOTE: Added to the name if Use version in project names is selected in the Integrate page.

N/A

N/A

No default

-projectVersion

projectToken 

Unique identifier of the project to update; found on the Integrate page.

NOTE: Only required if projectName is not defined.

N/A

N/A

No default

-projectToken

projectTag 

Enables setting of project tag only for a newly-created project. Project tag should be defined with key:value

For example: projectTag= myTagKey:myTagValue

NOTE: This parameter is not supported when using the Repo Integrations or the Azure DevOps Services Integration.

N/A

N/A

No default

-projectTag

productName 

The name of the product to update.

NOTE: Only required if projectToken is not defined.

N/A

N/A

MyProduct

-product

productVersion 

Version of the product and project to update. It overrides the project version.

N/A

N/A

No default

-productVersion

productToken 

Unique identifier of the product to update; found on the Integrate page.

NOTE: Only required if projectToken is not defined.

N/A

N/A

No default

-productToken

projectPerFolder

Creates one project per subfolder according to your "-d" parameter. Each subfolder is named according to the folder.

A project per folder is created

A project per folder is not created

False

-projectPerFolder

projectPerFolderIncludes 

Comma or space-delimited list of folder names to be included in the scan.

NOTE: Relevant only if projectPerFolder is True.

N/A

N/A

All folders

No

projectPerFolderExcludes 

Comma or space-delimited list of folder names to be excluded from the scan.

NOTE: Relevant only if projectPerFolder is True.

N/A

N/A

Empty

No

wss.connectionTimeoutMinutes 

Connection timeout in minutes.

N/A

N/A

60

wss.url=https://saas.Mendsoftwarewhitesourcesoftware.com/agent

#wss.url=https://app.Mendsoftwarewhitesourcesoftware.com/agent

#wss.url=https://app-eu.Mendsoftwarewhitesourcesoftware.com/agent 

Enable the relevant URL according to your organization's WS Server URL from your Profile page on the Server URLs panel (additionally, it can be found in the Integrate tab). Then, add the agent path.

N/A

N/A

https://saas.Mendsoftwarewhitesourcesoftware.com/agent

-wss.url

-c

String

Configuration file name (including file path).

No

The default file name is 'wss-unified-agent.config'

• Starting from version 19.1.1, the default file is 'wss-unified-agent.config'. 
  If this file is not found, then the Unified Agent searches for a 'Mend-fs-agent.config' file.

• When using the -detect flag, the generated configuration file is wss-generated-file.config and it should be explicitly stated: 
  -c wss-generated-file.config

-d

String

Comma-separated list of directories and/or files to scan

No

N/A

-f

String

File list path

No

N/A

-v

String

Query the Unified Agent for its version

No

N/A

-archiveFastUnpack 

Boolean

Fast unpacking of archive files

No

False

-requestFiles

String

Comma-separated list of paths to offline request files. 

Regarding the priority of the parameters usage, the Unified Agent searches for the CLI argument, then the configuration file parameter (if not found in the CLI), and then the offline request parameter (if not found in the configuration file).
If multiple request files are provided, then the data from the first offline request is used. Note that the 'projectName', 'projectToken', and 'projectVersion' are fetched from each request file.

If '-d' is explicitly provided when '-requestFiles' is also used, then the Unified Agent does not scan the local folder (which '-d' points to). Instead, it scans only the offline request file(s) provided. '-d' will be ignored in this scenario.

No

When a single request file is provided and if neither 'productName' or 'productToken' values are set in the CLI, Config and Offline request file, then the default product name is 'My Product'.

-whiteSourceFolderPath 

String

A path to the 'Mend' directory. The Mend folder is created when checking policies and creating an offline file. Path can be absolute or relative. 

No

The default location of the 'Mend' folder is the working directory from which the Unified Agent is run.

-requirementsFileIncludes 

(there is only python)

String

Comma-separated list of dependency filenames specifying which files to be scanned for dependencies.

No

requirements.txt

-noConfig

Boolean

When set to True, you can run a scan without using a configuration file. However, in this case, parameters  -projectToken or -project 
and -apiKey are mandatory.

Unless explicitly provided, the default wss.url parameter value is https://saas.Mendsoftwarewhitesourcesoftware.com/agent

No

False

-detect

When this parameter is added, the Unified Agent will analyze the scanned files and will create a new .config file with the relevant configuration parameters. The new configuration file will contain the resolveDependencies parameters according to the discovered package managers. For each manifest file, we will set the relevant parameter to True.

Usage:  java -jar unified-agent.jar -detect 

For example, if a bower.json file is found in the project folder, bower.resolveDependencies will be set to True in the newly created configuration file.

No

By default, the detection is based on the current directory where the Unified Agent jar is located. To change this, add the -d parameter.

For example use:  java -jar unified-agent.jar -detect -d projectFolder

-help or -h

Boolean

The Unified Agent prints the parameters that can be used from the CLI. 

No

-logLevel

String

Specifies the minimal log level printed to stdout. This parameter can be used to control console logging and is useful if a customer is trying to pull logs from a pipeline scan.

To disable console logging set log.level=off

To enable debug logging set log.level=debug

No

info

-proxy

String

Proxy info in the following format:
scheme://<user>:<password>@host:port/

No