README
¶
faker-cli
Simple command line client for the wonderful faker pacakge allowing one to quickly mock random user data
Build/Install
You can build and install the official repository with Go:
go get github.com/mkatychev/faker-cli/cmd/gofaker
Usage
Usage:
gofaker address
gofaker adult [--min=<years>] [--max=<years>] (age|dob [-Y|-M|-D|--fmt=<fmt>])
gofaker city
gofaker country [--short]
gofaker email
gofaker (guid|uuid)
gofaker name [first|last]
gofaker now [--fmt=<fmt>]
gofaker password [<min> <max>]
gofaker phone [--short]
gofaker (postal-code|zip) [--short] [--state=<state>]
gofaker sex [--short] [--lower]
gofaker state [--short] [-n <val,>]
gofaker street
gofaker street2
gofaker ssn [--short] [--now]
Options:
-h --help Show this screen.
--version Show version.
--short Return shortform of relevant data.
--min=<years> Lower age limit for fake adult generation [default: 18].
--max=<years> Upper age limit for fake adult generation [default: 69].
--fmt=<fmt> Timestamp formatter, uses the magical reference date of:
"Mon Jan 2 15:04:05 MST 2006"/"2006-01-02" [default: 2006-01-02].
--not <val,>, -n <val,> Blacklist specific string values, comma separated.
--now Creates an SSN from the first 9 characters of the current timestamp.
- see https://golang.org/pkg/time/#Time.Format for help with timestamp formatting
Documentation
¶
Index ¶
- Constants
- Variables
- func Exclude(list []string, exclusion map[string]bool) []string
- func HandleAddress(opts map[string]interface{}) string
- func HandleAdult(opts map[string]interface{}) string
- func HandleEmail(opts map[string]interface{}) string
- func HandleGUID(opts map[string]interface{}) string
- func HandleName(opts map[string]interface{}) string
- func HandleNow(opts map[string]interface{}) string
- func HandlePassword(opts map[string]interface{}) string
- func HandlePhone(opts map[string]interface{}) string
- func HandleSSN(opts map[string]interface{}) (ssn string)
- func HandleSex(opts map[string]interface{}) string
Constants ¶
const SSNRegex = `[134578]\d\d[1-9]\d[1-9]\d\d\d`
SSNRegex is used to implement pseudorandom RE generator that passes perl re while using re2 engine valid perl regex (that is invalid re2 regex): regex = "^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"; simple approach: [^2069]xx [^0]x [^0]xxx https://en.wikipedia.org/wiki/Social_Security_number#Valid_SSNs
Variables ¶
var DateFormat = "2006-01-02"
DateFormat is used to format time outputs
var Lower bool
Lower returns the lowercased form of relevant data.
var Not map[string]bool
Not is used to blacklist specific string values
var Short bool
Short returns shortform of relevant data.
Functions ¶
func HandleAddress ¶
HandleAddress handles `gofaker (city|state|zip-code|country)`
func HandleAdult ¶
HandleAdult handles `gofaker adult []` arguments TODO Pass in country codes for legal adult age current assumption is an adult age is 18 years or older
func HandleEmail ¶
HandleEmail handles `gofaker email`
func HandleGUID ¶ added in v0.5.0
HandleGUID handles `gofaker (guid|uuid)`
func HandleName ¶
HandleName handles the boolean map if `gofaker name` is called
func HandlePassword ¶
HandlePassword handles `gofaker password` generation, allows a max and min length default is 8-24
func HandlePhone ¶
HandlePhone handles the boolean map if `gofaker phone` is called
Types ¶
This section is empty.
Source Files
Directories