There are three ways to run Detect:
Download and run a Detect script.
Download and run a Detect .jar file.
Run Detect from within a Docker container.
Scripts
Running one of the Detect scripts provides the convenience of an auto-update feature, keeping you at the latest version with the associated improvements.Auto-update provides the following default behaviour:
Downloading and running the latest unversioned detect.sh/ps1 script will use the latest version of the Detect .jar file; downloading it for you if necessary.
Running a versioned detect.sh/ps1 script such as detect12.sh/ps1 will use the latest version of the Detect .jar file within that specific major version; downloading it for you if necessary.
To override the auto-update functionality by specifying an exact Detect version, see: To run a specific version of Detect.
If you are running Detect with Black Duck SCA you can also configure the version of Detect that should be used. See Hosting location for Black Duck Detect.
| Detect version | Script Type | Script Name | Notes |
|---|---|---|---|
| Latest | Bash | detect.sh | Runs latest Detect |
| Latest | PowerShell | detect.ps1 | Runs latest Detect |
| 12 | Bash | detect12.sh | Runs latest Detect 12 |
| 12 | PowerShell | detect12.ps1 | Runs latest Detect 12 |
| 11 | Bash | detect11.sh | Runs latest Detect 11 |
| 11 | PowerShell | detect11.ps1 | Runs latest Detect 11 |
| 10 | Bash | detect10.sh | Runs latest Detect 10 |
| 10 | PowerShell | detect10.ps1 | Runs latest Detect 10 |
JAR file
The primary reason to run the Detect .jar directly is that this method provides direct control over the exact Detect version. Detect does not automatically update in this scenario unless configured in Black Duck SCA to do so. See Hosting location for Black Duck Detect.
Docker container
The primary reasons to run Detect from within a Docker container include general Docker container benefits, such as having a repeatable standardized run environment, ease of deployment and isolation from other systems.