project

--detect.project.version.create.when.no.components=true

If set to false, Detect will not create a project version on Black Duck when no components are found and no other scan tools are active.

By default (true), a project version is always created on Black Duck upon a successful scan, even if no components were detected. Set to false to suppress project version creation when the scan produces no components and no scan tools such as signature scan, binary scan, or container scan are enabled.

--detect.project.deep.license=false

If set to true, enables Deep License Analysis for the project, including detailed license data and snippet analysis.

--detect.policy.check.fail.on.names

A comma-separated list of policy names with a non-zero number of violations that will fail Detect.

If left unset, Detect will not fail due to violated policies of a certain name. This property does not change the behavior of detect.policy.check.fail.on.severities.

--detect.policy.check.fail.on.severities=ALL,NONE,BLOCKER,CRITICAL,MAJOR,MINOR,OK,TRIVIAL,UNSPECIFIED 

A comma-separated list of policy violation severities that will fail Detect. If this is set to NONE, Detect will not fail due to policy violations. A value of ALL is equivalent to all of the other possible values except NONE.

--detect.stateless.policy.check.fail.on.severities=ALL,NONE,BLOCKER,CRITICAL,MAJOR,MINOR,OK,TRIVIAL,UNSPECIFIED 

A comma-separated list of policy violation severities that will fail Detect. If this is set to NONE, Detect will not fail due to policy violations. A value of ALL is equivalent to all of the other possible values except NONE. This property works for both stateless and rapid scans.

--detect.project.description

If project description is specified, your project will be created with this description. For updates, see detect.project.version.update.

--detect.project.name

An override for the name to use for the Black Duck SCA project. If not supplied, Detect will attempt to use the tools to figure out a reasonable project name. If that fails, the final part of the directory path where the inspection is taking place will be used.

--detect.project.tier

If a Black Duck SCA project tier is specified, your project will be created with this tier. For updates, see detect.project.version.update.

--detect.project.version.license

If project version license is specified, your project version will be created with this license. For updates, see detect.project.version.update.

--detect.project.version.update=false

If set to true, Detect will update the Black Duck SCA project and project version according to configured project and project version properties. (By default, these properties are only set on created projects / project versions.)

When set to true, the following properties will be updated on the Project: description (detect.project.description), tier (detect.project.tier), and project level adjustments (detect.project.level.adjustments). The following properties will also be updated on the project version: notes (detect.project.version.notes), phase (detect.project.version.phase), distribution (detect.project.version.distribution), nickname (detect.project.version.nickname), license (detect.project.version.license).

--detect.project.version.name

An override for the version to use for the Black Duck SCA project. If not supplied, Detect will attempt to use the tools to figure out a reasonable version name. If that fails, the current date will be used.

--detect.project.version.nickname

If a project version nickname is specified, your project version will be created with this nickname. For updates, see detect.project.version.update.

--detect.project.version.notes

If project version notes are specified, your project version will be created with these notes. For updates, see detect.project.version.update.

--detect.project.version.phase=ARCHIVED,DEPRECATED,DEVELOPMENT,PLANNING,PRERELEASE,RELEASED 

If project version phase is specified, your project version will be created with this phase. For updates, see detect.project.version.update.

--detect.project.level.adjustments=true

If set, created projects will be created with the value of this property. For updates, see detect.project.version.update.

Corresponds to the 'Always maintain component adjustments to all versions of this project' checkbox under 'Component Adjustments' on the Black Duck SCA Project settings page.

--detect.project.application.id

Sets the 'Application ID' project setting.

--detect.clone.project.version.latest=false

If set to true, detect will attempt to use the latest project version as the clone for this project. The project must exist and have at least one version.

--detect.project.clone.categories=ALL,NONE,COMPONENT_DATA,CUSTOM_FIELD_DATA,DEEP_LICENSE,LICENSE_TERM_FULFILLMENT,VERSION_SETTINGS,VULN_DATA 

The value of this property is used to set the 'Cloning' settings on created Black Duck SCA projects. If property detect.project.version.update is set to true, the value of this property is used to set the 'Cloning' settings on updated Black Duck SCA projects.

--detect.clone.project.version.name

The name of the project version to clone this project version from. Respects the given Clone Categories in detect.project.clone.categories or as set on the Black Duck SCA.

--detect.custom.fields.project

A list of custom fields with a label and comma-separated value starting from index 0. For each index, provide one label and one value. For example, to set a custom field with label 'example' to 'one,two': `detect.custom.fields.project[0].label='example'` and `detect.custom.fields.project[0].value='one,two'`. To set another field, use index 1. Note that these will not show up in the detect configuration log.

When assigning a value that contains a comma to a single-value field such as a text field, append '[0]' to the end of the value property name. For example, to set the value of the first field you are setting ('detect.custom.fields.version[0]') to 'text1,text2', use 'detect.custom.fields.version[0].value[0]=text1,text2'.

--detect.custom.fields.version

A list of custom fields with a label and comma-separated value starting from index 0. For each index, provide one label and one value. For example , to set a custom field with label 'example' to 'one,two': `detect.custom.fields.version[0].label='example'` and `detect.custom.fields.version[0].value='one,two'`. To set another field, use index 1. Note that these will not show up in the detect configuration log.

When assigning a value that contains a comma to a single-value field such as a text field, append '[0]' to the end of the value property name. For example, to set the value of the first field you are setting ('detect.custom.fields.version[0]') to 'text1,text2', use 'detect.custom.fields.version[0].value[0]=text1,text2'.

--detect.parent.project.name

When a parent project and version name are specified, the created detect project will be added as a component to the specified parent project version. The specified parent project and parent project version must exist on Black Duck SCA.

--detect.parent.project.version.name

When a parent project and version name are specified, the created detect project will be added as a component to the specified parent project version. The specified parent project and parent project version must exist on Black Duck SCA.

--detect.project.group.name

Sets the 'Project Group' to assign the project to. Must match exactly to an existing project group on Black Duck SCA.

--detect.project.settings

Path to a JSON file containing project settings. The file should contain a JSON object with detect.project properties specified as key-value pairs.

detect.project properties provided on the command line take precedence over values specified in the JSON file.

--detect.project.tags

A comma-separated list of tags to add to the project. This property is not supported when using Detect in offline mode.

--detect.project.user.groups

A comma-separated list of names of user groups to add to the project.

--detect.code.location.name

An override for the base name Detect will use for the scan (codelocation) it creates. Detect appends a suffix to the base name that indicates the source ("scan" for the signature scanner, "gradle/bom" for the Gradle detector, etc.). If this property is set and multiple code locations are generated from the same source, Detect will also append an index to avoid name collisions. When this property is set, detect.project.codelocation.prefix and detect.project.codelocation.suffix are ignored.

--detect.project.codelocation.prefix

A prefix to the name of the scans created by Detect. Useful for running against the same projects on multiple machines.

--detect.project.codelocation.suffix

A suffix to the name of the scans created by Detect.

--detect.project.version.distribution=EXTERNAL,INTERNAL,OPENSOURCE,SAAS 

If project version distribution is specified, your project version will be created with this distribution. For updates, see detect.project.version.update.