https://github.com/yangwenmai/gitfeed
A command-line for displaying NewsFeed using GitHub public API in Go
https://github.com/yangwenmai/gitfeed
cli feed gitfeed github githubfeed go golang rss
Last synced: 10 months ago
JSON representation
A command-line for displaying NewsFeed using GitHub public API in Go
- Host: GitHub
- URL: https://github.com/yangwenmai/gitfeed
- Owner: yangwenmai
- License: mit
- Created: 2017-11-30T14:20:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-15T17:36:04.000Z (over 7 years ago)
- Last Synced: 2025-04-13T04:12:20.845Z (10 months ago)
- Topics: cli, feed, gitfeed, github, githubfeed, go, golang, rss
- Language: Go
- Homepage:
- Size: 695 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: newsfeed.go
- License: LICENSE
Awesome Lists containing this project
README
# GitFeed #
[](https://travis-ci.org/yangwenmai/gitfeed) [](https://goreportcard.com/report/github.com/yangwenmai/gitfeed) [](http://godoc.org/github.com/yangwenmai/gitfeed) [](https://coveralls.io/github/yangwenmai/gitfeed?branch=master) [](https://github.com/yangwenmai/gitfeed/issues) [](https://github.com/yangwenmai/gitfeed/LICENSE) [](https://github.com/yangwenmai/gitfeed/releases)
[中文版本](README_ZH.md)
[Join Us On Slack](https://join.slack.com/t/gitfeed/shared_invite/enQtMjgwNTU5MTE5NjgxLTA5NDQwYzE4NGNhNDI3N2E0ZmYwOGM2MWNjMDUyNjczY2I0OThiNzA5ZTk0MTc1MGYyYzk0NTA0MjM4OTZhYWE)
Check GitHub Newsfeed via the command-line in Go, insipred by [GitFeed](https://github.com/ritiek/GitFeed).
Newsfeed includes all the news from people you are following on GitHub, repositories you are watching, etc.
All news you would find on your GitHub dashboard.
Base on [Github Events API](https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received)
>**List events that a user has received**
>These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
## Screenshots ##
## Installation ##
1. `go get github.com/yangwenmai/gitfeed`.
2. install gitfeed by source
- `cd $GOPATH/src/github.com/yangwenmai/`
- `git clone https://github.com/yangwenmai/gitfeed.git`
- `cd gitfeed`
- `mkdir -p ~/.gitfeed`
- `cp gitfeed.ini.example ~/.gitfeed/gitfeed.ini`
- `go build && ./gitfeed`
## Usage ##
Run it using gitfeed
The first time you launch gitfeed, it will ask you for GitHub username and set it as the default username to fetch news for.
You can even fetch news for any other user provided you know their GitHub username.
Full list of supported options:
```shell
NAME:
gitfeed - Check GitHub Newsfeed.
USAGE:
gitfeed [global options] command [command options] [arguments...]
VERSION:
0.0.1
AUTHOR:
maiyang
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--config FILE, -c FILE Load configuration from FILE (default:~/.gitfeed/gitfeed.ini)
--user value, -u value Github username
--include value, -i value Include words. Wildcard pattern matching with support for '?' and '*'
--exclude value, -e value Exclude words. Wildcard pattern matching with support for '?' and '*'
--help, -h show help
--version, -v print the version
```
You can modify the default configuration by editing ~/.gitfeed/gitfeed.ini
## Roadmap ##
What are you want?
Please create a new Issue for me.
## License ##
License: MIT License