Kwgradlew
The kwgradlew command creates a Java or Kotlin build specification based on the information in your Gradle wrapper.
You can also create a build specification using your Gradle build file. For more information, see Kwgradle.
As of Klocwork 2022.4, we now support Gradle’s Kotlin DSL format. This provides an alternative syntax to the traditional Groovy DSL with an enhanced editing experience in supported IDEs.
Prerequisites
Before you can create a build specification, you need to
- install the Server package. See Installing Klocwork.
- ensure that the Gradle task is configured to use a supported version of Gradle. See Supported Java build tools to see what versions are supported.
- have the path to the JVM executables set in the PATH environment variable:
- Unix:
<path_to_JDK>/bin:<klocwork_install>/bin:$PATH
- Windows:
<path_to_JDK>\bin;<klocwork_install>\bin;%PATH%
- Unix:
For more information, see Creating a Java build specification.
Usage
kwgradlew <gradle_options>
where <gradle_options> are any arguments required for your gradlew build.
Note: When running the command for the first time, the Build Cache feature should be disabled. This feature should only be enabled for incremental builds (when the '--update' option is used).
Options
| Name (and short name) | Description |
|---|---|
| --help (-h) | display help |
| --version | display kwgradlew version |
| --output (-o) <file> | write the build specification to <file>. By default, the build specification is written to kwinject.out in the current working directory. |
| --update (-u) | when specified, the existing build specification is updated with the results of the new incremental build instead of overwriting it. |
| --build-file <string> | path to the Gradle wrapper file. Absolute or relative paths are supported. Default is build.gradle in the current directory. |
| --project-dir (-p) <string> | the project directory. Default is the current directory, or <install_dir>/bin. |
| --debug-level <integer> | print debug information to the console. Default is 0 (no debug output). |
| --classpath <string> | Paths to user class files and dependent JAR files. Used for type resolution. |
| --excludes <string> | Globbing patterns describing paths to exclude from the analysis. |
| --includes <string> | Globbing patterns describing paths to include in the analysis. Useful in combination with "excludes" patterns. |
| --plugins <string> | Extra paths to plugin jars, separated by ",". |
| --src-lang <string> | Specify this option to generate the build specification for
either Java or Kotlin. Valid values are: java,
kotlin, and java,kotlin. Default is java,kotlin. |