Github::Nippou
Displays today's your GitHub action.
This is a helpful tool when you write a daily report in reference to GitHub. Nippou is a japanese word which means a daily report.
Installation
Add this line to your application's Gemfile:
gem 'github-nippou'
And then execute:
$ bundle
Or install it yourself as:
$ gem install github-nippou
Setup
$ git config --global github-nippou.user [Your GitHub account]
$ git config --global github-nippou.token [Your GitHub access token]
Usage
$ github-nippou help
Commands:
github-nippou help [COMMAND] # Describe available commands or one specific command
github-nippou init # Synchronize github-nippou settings on your gist
github-nippou list # Displays today's GitHub events formatted for Nippou (Default)
github-nippou open-settings # Open settings url with web browser
github-nippou version # Displays version
Options:
s, [--since-date=SINCE_DATE] # Retrieves GitHub user_events since the date
# Default: 20170807
u, [--until-date=UNTIL_DATE] # Retrieves GitHub user_events until the date
# Default: 20170807
d, [--debug], [--no-debug] # Debug mode
You can get your GitHub Nippou on today.
$ github-nippou
### masutaka/github-nippou
* [v3.0.0](https://github.com/masutaka/github-nippou/issues/59) by masutaka
* [Enable to inject settings_gist_id instead of the settings](https://github.com/masutaka/github-nippou/pull/63) by masutaka **merged!**
* [Add y/n prompt to sub command \`init\`](https://github.com/masutaka/github-nippou/pull/64) by masutaka **merged!**
* [Add sub command \`open-settings\`](https://github.com/masutaka/github-nippou/pull/65) by masutaka **merged!**
* [Dockerize](https://github.com/masutaka/github-nippou/pull/66) by masutaka **merged!**
Customize output format
$ github-nippou init
This command will create a gist and update your `~/.gitconfig`.
Are you sure? [y/n] y
The github-nippou settings was created on https://gist.github.com/ecfa35cb546d8462277d133a91b13be9
And the gist_id was appended to your `~/.gitconfig`. You can
check the gist_id with following command.
$ git config --global github-nippou.settings-gist-id
Open the Gist URL with your web browser.
$ github-nippou open-settings
Open https://gist.github.com/ecfa35cb546d8462277d133a91b13be9
Docker
You can use the dockerized github-nippou via bin/docker-github-nippou.
$ git clone https://github.com/masutaka/github-nippou.git
$ cd github-nippou/bin
$ ./docker-github-nippou help
However, you cannot use the sub command open-settings.
Contributing
- Fork it ( https://github.com/masutaka/github-nippou/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
External article
In Japanese