Find GitHub Email
☀️ The warmest start to a cold email ❄️
Find GitHub Email allows you to find any GitHub user's email addresses based on their commit history and GitHub profile.
Check out this post for a little more background on the gem.
⏬ Installation
$ gem install find_github_email
Find Github Email uses GitHub's API. In order to use Find GitHub Email, you need a GitHub API token 🔑. Fortunately, these are very easy to obtain:
- 👩💻 Visit https://github.com/settings/tokens/new
- ✍️ Label the token whatever you would like
- ✔️ Select the
read:user
box within theuser
section - 🟩 Click the green
Generate Token
button - 📝 Copy your token
Once you have your API token, in a console run
$ find_github_email -g <GITHUB_API_TOKEN>
You will only need to run this command once 🎉. It will store your API token at ~/.find_github_email_access_token
, and the gem will always look for it at that location.
📬 Usage
After you've followed the installation instructions, you can run:
$ find_github_email <USERNAME>
For example:
$ find_github_email torvalds
torvalds@linux-foundation.org
👩💻 Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jemmaissroff/find_github_email. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
📃 License
The gem is available as open source under the terms of the MIT License.
♥️ Code of Conduct
Everyone interacting in Find GitHub Email's codebase is expected to follow the code of conduct.