Skip to content

yangwenmai/gitfeed

Repository files navigation

GitFeed

Build Status Go Report Card Documentation Coverage Status GitHub issues license Release

中文版本

Join Us On Slack

Check GitHub Newsfeed via the command-line in Go, insipred by 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

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

gitfeed 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:

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

About

A command-line for displaying NewsFeed using GitHub public API in Go

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages