Skip to content

Commit 27d73ad

Browse files
committed
feat: added cli usage
1 parent 95b109d commit 27d73ad

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Definition CLI
2+
3+
## Setup
4+
```bash
5+
cargo build --release
6+
```
7+
8+
## Usage
9+
10+
### General Report
11+
```bash
12+
./cli report
13+
./cli report -p /path/to/definitions
14+
```
15+
16+
### Feature Report
17+
```bash
18+
./cli feature
19+
./cli feature -f feature_name
20+
./cli feature -f feature_name -p /path/to/definitions
21+
```
22+
23+
### Watch for Changes
24+
```bash
25+
./cli watch
26+
./cli watch -p /path/to/definitions
27+
```
28+
29+
### Definition
30+
```bash
31+
./cli definition -n definition_name
32+
./cli definition -n definition_name -p /path/to/definitions
33+
```

0 commit comments

Comments
 (0)