Skip to content

Commit 36e334f

Browse files
committed
update cli readme
1 parent 0953959 commit 36e334f

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

cli/README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,22 @@
22

33
This is the cli tool the loyal companion of the spanwflake libary
44

5-
## Running the tool
5+
## USAGE
6+
67
```
7-
spawnflakes.exe number_of_records_to_be_generated
8+
spawnflakes.exe [OPTIONS]
9+
10+
FLAGS:
11+
-h, --help Prints help information
12+
-V, --version Prints version information
13+
14+
OPTIONS:
15+
-c <configuration> sets a custom configuration name and path relative to this location
16+
-d <datastore> Sets the type of the datastore to generate values. By default executes the entire
17+
configuration
18+
-s, --spawn-size <spawn-size> Set the number of rows per table to be generated
819
```
920
example
1021
```
11-
spawnflakes.exe 22
22+
spawnflakes.exe -s 4 -c ..\config.json
1223
```

0 commit comments

Comments
 (0)