README.md

Quickly find required kotlin-faker functionality from your terminal

ToC

• Installation
• Usage
  • Available commands
    • list
    • lookup
  • Available options
    • --verbose
    • --java-syntax
    • --locale
    • --list-locales
• Thanks

Installation

The native images are available on releases page.
Download the image to a desired location and make it executable or use below script (Depends on jq)

cd ~
wget $(curl -s https://api.github.com/repos/serpro69/kotlin-faker/releases/latest | jq -r '.assets[].browser_download_url') -O faker-bot
chmod a+x ~/faker-bot

Usage

Usage details are also available with the --help option:
./faker-bot --help
./faker-bot list --help
./faker-bot lookup --help

Available commands

list

• ./faker-bot list - list all providers and their functions
• ./faker-bot list Address Name - list functions of Address and Name providers (Case insensitive)

Since version 1.4.0 partial matching is also supported:

• ./faker-bot list addr - list functions of Address provider

lookup

• ./faker-bot lookup name - lookup functions by name (Case insensitive partial matching)

Available options

Verbose output

./faker-bot list --verbose - prints sample values for each function ./faker-bot lookup name --verbose - prints sample values for each function

Switch to java syntax

./faker-bot list --java-syntax - prints list of all available providers and their functions using java syntax

Using non-default locale

./faker-bot list --verbose --locale de - combined with --verbose, all localized functions will be printed using de locale.

List available locales

./faker-bot list --list-locales - prints all available locales

Thanks

Inspired by faker-ruby/faker-bot