Quickly look up Faker methods without leaving your terminal!
:book: Code Documentation
$ gem install faker-bot
1.) Run a quick lookup
$ faker search name # Faker::SwordArtOnline # └── real_name # └── game_name # Faker::Superhero # └── name # ....
2.) List methods
$ faker list # Faker::BackToTheFuture # ├── quote # ├── date # └── character # Faker::Finance # └── credit_card # ....
faker also includes an option to display sample output via the
-v flag. :wink:
$ faker list -v # Faker::Appliance # ├── brand=> Whirlpool # └── equipment=> Sump pump # Faker::UmphreysMcgee # └── song=> Headphones & Snowcones $ faker search name -v # Faker::App # └── name=> Subin # Faker::Address # └── street_name=> Percy Landing # ....
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake spec to run the tests. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/faker-ruby/faker-bot. See CONTRIBUTING.md. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Terminal awesomeness made easy by the TTY Toolkit. :beer:
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the faker-bot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.