You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-2Lines changed: 18 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,23 @@
1
1
# Polystat CLI
2
2
This repository provides an alternative implementation to [Polystat](https://github.com/polystat/polystat).
3
3
4
-
# Basic usage
4
+
# Installation
5
+
The CLI is distributed as a fat jar, so that you can run without any prerequisites other than the JRE. To run it, just execute:
6
+
```
7
+
java -jar polystat.jar <args>
8
+
```
9
+
It may be helpful to define an alias (the following works in Unix/MacOs):
10
+
```
11
+
alias polystat="java -jar /path/to/polystat.jar"
12
+
```
13
+
And then simply run it like:
14
+
```
15
+
polystat <args>
16
+
```
17
+
More about the arguments you can pass can be found [here](#basic) and [here](#full).
18
+
19
+
20
+
# <aname="basic"></a> Basic usage
5
21
6
22
> `polystat`
7
23
@@ -37,7 +53,7 @@ Get the plain text console output from analyzing Java files. The Java files are
37
53
Write the [SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) JSON files to `polystat_out/sarif` from analysing the `tmp` directory with `.eo` files.
38
54
39
55
40
-
# Full Usage Specification
56
+
# <aname="full"></a> Full Usage Specification
41
57
42
58
## Notation
43
59
The description follows [this guide](https://en.wikipedia.org/wiki/Command-line_interface#Command_description_syntax).
0 commit comments