Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add available CLI options to README.md #537

Merged
merged 1 commit into from
Feb 11, 2024
Merged

add available CLI options to README.md #537

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,26 @@ and then:
```bash
$ java -jar jpeek-jar-with-dependencies.jar --sources . --target ./jpeek
```
<!--
@todo #452:30min Improve how to use section on README.md
How to Use section must be improved; we need to explain the many parameters
that jpeek jar accepts and the default values for each parameter.
-->


jPeek will analyze Java files in the current directory.
XML reports will be generated in the `./jpeek` directory. Enjoy.

<details>
<summary>Available CLI options</summary>

| Option | Description |
|-----------------------------|------------------------------------------------------------------------------------|
| `-s, --sources <path>` | **Required.** Path to directory with the class files |
| `-t, --target <path>` | **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 <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 |
</details>

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:
Expand Down
Loading