From d4b60d6f045e27062c650bb254b4a5a64d9986e4 Mon Sep 17 00:00:00 2001 From: evermake Date: Sat, 3 Feb 2024 15:30:59 +0300 Subject: [PATCH] add available CLI options to README.md --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e6f05dae..fcc42492 100644 --- a/README.md +++ b/README.md @@ -40,16 +40,26 @@ and then: ```bash $ java -jar jpeek-jar-with-dependencies.jar --sources . --target ./jpeek ``` - - jPeek will analyze Java files in the current directory. XML reports will be generated in the `./jpeek` directory. Enjoy. +
+Available CLI options + +| Option | Description | +|-----------------------------|------------------------------------------------------------------------------------| +| `-s, --sources ` | **Required.** Path to directory with the class files | +| `-t, --target ` | **Required.** Path to directory where the reports will be generated | +| `--include-ctors` | Include constructors into all formulas | +| `--include-static-methods` | Include static methods into all formulas | +| `--include-private-methods` | Include private methods into all formulas | +| `--metrics ` | Comma-separated list of metrics to include (default: `"LCOM5,NHD,MMAC,SCOM,CAMC"`) | +| `--overwrite` | Overwrite the target directory, if it exists, or exit with error | +| `--quiet` | Turn off logging | +| `--help` | Display help message | +
+ You can also deploy it as a web service to your own platform. Just compile it with `mvn clean package --settings settings.xml` and then run, as `Procfile` suggests. You will need to have `settings.xml` with the following data: