mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-01-15 16:23:37 +01:00
4.5 KiB
4.5 KiB
Command Line Arguments
The following table lists the command line arguments:
| Short | Argument Name | Parameter | Description | Requirement |
|---|---|---|---|---|
| -a | --app | <name> | The name of the application being scanned. This is a required argument. | Required |
| -s | --scan | <path> | The path to scan - this option can be specified multiple times. It is also possible to specify specific file types that should be scanned by supplying a scan path of '[path]/[to]/[scan]/*.zip'. The wild card can only be used to denote any file-name with a specific extension. | Required |
| -o | --out | <folder> | The folder to write reports to. This defaults to the current directory. | Optional |
| -f | --format | <format> | The output format to write to (XML, HTML, VULN, ALL). The default is HTML. | Required |
| -l | --log | <file> | The file path to write verbose logging information. | Optional |
| -n | --noupdate | Disables the automatic updating of the CPE data. | Optional | |
| --suppression | <file> | The file path to the suppression XML file; used to suppress false positives. | Optional | |
| -h | --help | Print the help message. | Optional | |
| --advancedHelp | Print the advanced help message. | Optional | ||
| -v | --version | Print the version information. | Optional |
Advanced Options
| Short | Argument Name | Parameter | Description | Default Value |
|---|---|---|---|---|
| --disableArchive | Sets whether the Archive Analyzer will be used. | false | ||
| --zipExtensions | <strings> | A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. | ||
| --disableJar | Sets whether Jar Analyzer will be used. | false | ||
| --disableNexus | Sets whether Nexus Analyzer will be used. | false | ||
| --disableNexus | Disable the Nexus Analyzer. | |||
| --nexus | <url> | The url to the Nexus Server. | https://repository.sonatype.org/service/local/ | |
| --nexusUsesProxy | <true|false> | Whether or not the defined proxy should be used when connecting to Nexus. | true | |
| --disableNuspec | Sets whether or not the .NET Nuget Nuspec Analyzer will be used. | false | ||
| --disableAssembly | Sets whether or not the .NET Assembly Analyzer should be used. | false | ||
| --pathToMono | <path> | The path to Mono for .NET Assembly analysis on non-windows systems. | ||
| --proxyserver | <server> | The proxy server to use when downloading resources. | ||
| --proxyport | <port> | The proxy port to use when downloading resources. | ||
| --connectiontimeout | <timeout> | The connection timeout (in milliseconds) to use when downloading resources. | ||
| --proxypass | <pass> | The proxy password to use when downloading resources. | ||
| --proxyuser | <user> | The proxy username to use when downloading resources. | ||
| --connectionString | <connStr> | The connection string to the database. | ||
| --dbDriverName | <driver> | The database driver name. | ||
| --dbDriverPath | <path> | The path to the database driver; note, this does not need to be set unless the JAR is outside of the class path. | ||
| --dbPassword | <password> | The password for connecting to the database. | ||
| --dbUser | <user> | The username used to connect to the database. | ||
| -d | --data | <path> | The location of the data directory used to store persistent data. This option should generally not be set. |