Skip to content

Commit a43b3f7

Browse files
committed
Add readme and peek git preview
1 parent c7c553b commit a43b3f7

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

cli-bot/README.MD

+25-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,32 @@
22

33
# Faker-Bot
44

5-
A tiny CLI application that helps to quickly find required functions of kotlin-faker
5+
A CLI application that helps to quickly find required functions of kotlin-faker
6+
7+
<img src=./img/faker-peek.gif width="768" height="606" alt=""/>
68

79
## Installation
10+
The native images are available on [releases](https://github.com/serpro69/kotlin-faker/releases) page.
11+
<i> Note that not every release will have a corresponding native image. In most cases only major/minor version
12+
releases will contain a release of this application, as they are likely to have new functionality
13+
or changes.</i>
814

915
## Usage
16+
### Available commands
17+
#### `list` - List available providers and their functions
18+
19+
#### `lookup` - Lookup functions by name (Case insensitive)
20+
21+
### Available options
22+
#### Verbose output
23+
`./faker-bot list --verbose` - prints sample values for each function
24+
`./faker-bot lookup name --verbose` - prints sample values for each function
25+
26+
#### Switch to java syntax
27+
`./faker-bot list --java-syntax` - prints list of all available providers and their functions using java syntax
28+
29+
#### Using non-default locale
30+
`./faker-bot list --verbose --locale de` - all localized functions with be printed using `de` locale.
31+
32+
#### List available locales
33+
`./faker-bot list --list-locales` - prints all available locales

cli-bot/img/faker-peek.gif

2.59 MB
Loading

0 commit comments

Comments
 (0)