good-first-issues
good-first-issues copied to clipboard
Find good first issues right from your CLI! 🚀
Good First Issues
Find good first issues right from your CLI!
Install Good First Issues
Requires Python 3.6.1 or higher.
$ pip3 install good-first-issues --upgrade
The CLI uses the alias gfi
to run commands.
![](https://i.imgur.com/UM4e9vQ.png)
Contents
- Install Good First Issues
-
Contents
- Create GitHub Personal Access Token
-
Usage
-
Search for issues
- Query all repos in an organization
- Query a single repo in an organization
- Query all repos in a user profile
- Query a single repo in a user profile.
-
Search for Hacktoberfest approved issues
-
Query all repos with topic
hacktoberfest
- Query all repos with topic 'hacktoberfest' in an organization or in a user profile
-
Query all repos with topic
- Changing output limits
- Viewing issues on browser
-
Search for issues
- Contributing
Create GitHub Personal Access Token
The CLI requires GitHub Personal Access Token to make requests to the GitHub API.
You don't have to select any scopes, add a Note for your token and select Generate token.
Provide token to CLI:
$ gfi config
Token is stored locally on /home/<username>/.gfi/good-first-issues
file.
Token in envrionment variable:
Store the token with the name GFITOKEN
in your environment.
Usage
GitHub provides API to fetch user and organization data. Personal Access Token is required for authentication and data fetching.
Search for issues
To look for issues, use the gfi search
command.
Query all repos in an organization
$ gfi search "rust-lang"
Demo
![]()
Query a single repo in an organization
$ gfi search "facebook" --repo "jest"
Demo
![]()
Query all repos in a user profile
$ gfi search "yankeexe" --user
Demo
![]()
Query a single repo in a user profile.
--user
flag not required here.
$ gfi search "yankeexe" --repo "good-first-issues"
Demo
![]()
Search for Hacktoberfest approved issues
Query all repos with topic hacktoberfest
$ gfi search --hacktoberfest
$ gfi search -hf
Demo
![]()
Query all repos with topic 'hacktoberfest' in an organization or in a user profile
Query all repos with topic 'hacktoberfest' in an organization.
$ gfi search "facebook" --hacktoberfest
Demo
![]()
Query all repos with topic 'hacktoberfest' in a user profile.
--user
flag not required here.
$ gfi search "yankeexe" --hacktoberfest
Demo
![]()
Changing output limits
The output is limited to display 10 issues by default. Use --limit
flag to set the number of issues for output or --all
for no limits.
Limit the issues to 12
$ gfi search "facebook" --limit 12
Demo
![]()
View all issues found.
$ gfi search "rust-lang" --all
Viewing issues on browser
It's hard to navigate through all the issues when you have the --all
flag enabled, you can view the issues on your browser with ease using the --web
flag.
$ gfi search "facebook" --all --web
Demo
![]()
Contributing
For guidance on setting up a development environment and how to make a contribution to good-first-issues
, see the contributing guidelines.