Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dblock/fue
Find an e-mail addresses of Github users.
https://github.com/dblock/fue
github github-graphql graphql
Last synced: 17 days ago
JSON representation
Find an e-mail addresses of Github users.
- Host: GitHub
- URL: https://github.com/dblock/fue
- Owner: dblock
- License: mit
- Created: 2018-08-15T01:21:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-31T18:27:01.000Z (almost 2 years ago)
- Last Synced: 2024-10-08T23:10:50.118Z (about 1 month ago)
- Topics: github, github-graphql, graphql
- Language: Ruby
- Homepage:
- Size: 435 KB
- Stars: 19
- Watchers: 4
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
Fue
===
[](https://badge.fury.io/rb/fue)
[](https://github.com/dblock/fue/actions/workflows/test.yml)
Find e-mail addresses of a Github users from their commit logs.
Fue is short for "Finding Unicorn Engineers".
## Table of Contents
- [Usage](#usage)
- [Commands](#commands)
- [Find Someone’s Email](#find-someones-email)
- [Find All Repo Contributors’ Emails](#find-all-repo-contributors-emails)
- [Options](#options)
- [Specify More Depth](#specify-more-depth)
- [Get Help](#get-help)
- [Access Tokens](#access-tokens)
- [Debugging](#debugging)
- [Contributing](#contributing)
- [Copyright and License](#copyright-and-license)
## Usage
```
gem install fue
```
### Commands
#### Find Someone's Email
The `find` command looks through user's initial repository commits.
```
$ fue --verbose find defunkt
Chris Wanstrath
Chris Wanstrath
```
#### Find All Repo Contributors' Emails
The `contributors` command looks through a git log of contributors, then fetches their e-mails.
```
$ fue --verbose contributors defunkt/colored
defunkt: Chris Wanstrath
kch: Caio Chassot
```
### Options
#### Specify More Depth
By default the code looks at 1 commit from the last 10 repositories. You can look at more repositories (breadth) and more commits (depth). The maximum value for depth is 100, enforced by Github. Fue will iterate over a number of repositories larger than 100.
```
$ fue find --breadth=100 --depth=5 defunkt
Chris Wanstrath
Chris Wanstrath
defunkt
```
### Get Help
```
fue help
```
Displays additional options.
### Access Tokens
Fue will ask you to create a personal access token and will store it in the keychain. The access token should be created with `public_repo` scope [here](https://github.com/settings/tokens). You can also skip the prompts and use a previously obtained token with `-t` or by setting the `GITHUB_ACCESS_TOKEN` environment variable.
See [Creating a Personal Access Token for the Command Line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) for more information about personal tokens.
## Debugging
If you run into an unexpected error, try getting a stack trace with `GLI_DEBUG=true`.
```
$ GLI_DEBUG=true fue find dblock
FrozenError: can't modify frozen String
/Users/dblock/source/dblock/fue/lib/fue/auth.rb:97:in `get_secure'
/Users/dblock/source/dblock/fue/lib/fue/auth.rb:80:in `get_password'
/Users/dblock/source/dblock/fue/lib/fue/auth.rb:50:in `password'
/Users/dblock/source/dblock/fue/lib/fue/auth.rb:59:in `block in github'
```
## Contributing
There are [a few feature requests and known issues](https://github.com/dblock/fue/issues). Please contribute! See [CONTRIBUTING](CONTRIBUTING.md).
## Copyright and License
Copyright (c) 2018-2022, Daniel Doubrovkine, [Artsy](http://artsy.github.io), with help from [Orta](https://github.com/orta).
This project is licensed under the [MIT License](LICENSE.md).