|
a |
|
b/docs/samples/cli-arguments-examples.md |
|
|
1 |
# CLI Arguments - Example |
|
|
2 |
|
|
|
3 |
## OS - Specific Build Commands |
|
|
4 |
|
|
|
5 |
**IMPORTANT** |
|
|
6 |
|
|
|
7 |
* MacOS use `./gradlew build` |
|
|
8 |
* Windows use `.\gradlew build` |
|
|
9 |
|
|
|
10 |
1. Type the build command in your terminal depending on your operating system. |
|
|
11 |
 |
|
|
12 |
|
|
|
13 |
2. You should receieve the feedback in your terminal of the successful build. |
|
|
14 |
 |
|
|
15 |
|
|
|
16 |
## Standard CLI Understanding |
|
|
17 |
|
|
|
18 |
The CLI consists of two parts. |
|
|
19 |
|
|
|
20 |
1. Executable |
|
|
21 |
|
|
|
22 |
```java |
|
|
23 |
java-jar build/libs/DNAnalyzer.jar<arguments> |
|
|
24 |
``` |
|
|
25 |
|
|
|
26 |
2. Arguments |
|
|
27 |
|
|
|
28 |
```java |
|
|
29 |
<executable> assets/dna/random/dnalong.fa--amino=ser--min=0--max=100-r |
|
|
30 |
``` |
|
|
31 |
|
|
|
32 |
## Access Help Menu |
|
|
33 |
|
|
|
34 |
Use the executable to complete commands. |
|
|
35 |
|
|
|
36 |
```java |
|
|
37 |
java-jar build/libs/DNAnalyzer.jar<arguments> |
|
|
38 |
``` |
|
|
39 |
|
|
|
40 |
To access the help menu type the following command into your terminal. |
|
|
41 |
|
|
|
42 |
```java |
|
|
43 |
java-jar build/libs/DNAnalyzer.jar-h |
|
|
44 |
``` |
|
|
45 |
|
|
|
46 |
You should get the following response: |
|
|
47 |
 |
|
|
48 |
|
|
|
49 |
## Running Example Command |
|
|
50 |
|
|
|
51 |
Use the executable to complete commands. |
|
|
52 |
|
|
|
53 |
```java |
|
|
54 |
java-jar build/libs/DNAnalyzer.jar<arguments> |
|
|
55 |
``` |
|
|
56 |
|
|
|
57 |
Type the following into your terminal. |
|
|
58 |
|
|
|
59 |
```java |
|
|
60 |
java-jar build/libs/DNAnalyzer.jar assets/dna/random/dnalong.fa--amino=ser--min=14--max=52 |
|
|
61 |
``` |
|
|
62 |
|
|
|
63 |
You should get the following response: |
|
|
64 |
 |