xref: /aosp_15_r20/external/nullaway/jar-infer/jar-infer-cli/README.md (revision f50c306653bc89b8210ce6c9e0b0b44fc134bc03)
1*f50c3066SAndroid Build Coastguard WorkerNullAway jar-infer
2*f50c3066SAndroid Build Coastguard Worker=======
3*f50c3066SAndroid Build Coastguard Worker
4*f50c3066SAndroid Build Coastguard Worker### Introduction
5*f50c3066SAndroid Build Coastguard Worker
6*f50c3066SAndroid Build Coastguard WorkerThis extends NullAway to support Nullability inference on external libraries.
7*f50c3066SAndroid Build Coastguard Worker
8*f50c3066SAndroid Build Coastguard Worker### Requirements
9*f50c3066SAndroid Build Coastguard Worker
10*f50c3066SAndroid Build Coastguard Worker  * Java 8
11*f50c3066SAndroid Build Coastguard Worker  * The [Gradle](https://gradle.org/) build tool
12*f50c3066SAndroid Build Coastguard Worker  * The [WALA](http://wala.sourceforge.net/wiki/index.php/Main_Page) analysis framework
13*f50c3066SAndroid Build Coastguard Worker
14*f50c3066SAndroid Build Coastguard Worker### Installation
15*f50c3066SAndroid Build Coastguard Worker
16*f50c3066SAndroid Build Coastguard WorkerClone the repository, and then:
17*f50c3066SAndroid Build Coastguard Worker
18*f50c3066SAndroid Build Coastguard Worker    gradle wrapper
19*f50c3066SAndroid Build Coastguard Worker    ./gradlew build
20*f50c3066SAndroid Build Coastguard Worker
21*f50c3066SAndroid Build Coastguard WorkerThis will pull in the required WALA jars and build the analysis code.
22*f50c3066SAndroid Build Coastguard Worker
23*f50c3066SAndroid Build Coastguard Worker### Usage
24*f50c3066SAndroid Build Coastguard Worker
25*f50c3066SAndroid Build Coastguard Worker    java -jar <path-to-jar-infer-cli-tool> -i <in_path> -o <out_path> [-p <pkg_name>] [-vdh]
26*f50c3066SAndroid Build Coastguard Worker     -i,--input-file <in_path>     path to target jar/aar file
27*f50c3066SAndroid Build Coastguard Worker     -o,--output-file <out_path>   path to processed jar/aar file
28*f50c3066SAndroid Build Coastguard Worker     -p,--package <pkg_name>       qualified package name
29*f50c3066SAndroid Build Coastguard Worker     -v,--verbose                  set verbosity
30*f50c3066SAndroid Build Coastguard Worker     -d,--debug                    print debug information
31*f50c3066SAndroid Build Coastguard Worker     -h,--help                     print usage information
32*f50c3066SAndroid Build Coastguard Worker
33