GitBar

A plugin for BitBar to quickly show your open source GitHub contribution stats, help set contribution goals, all on your macOS(formerly OS X) menu bar.

(Inspired by Dan Cadden's plugin)

Almost all of us have private repos we tend to work on, and it's really easy to neglect your OSS work. So, I created Gitbar to make daily public contributions a habit. Gitbar is a OSX Menu Bar utility that shows your daily GitHub stats, streaks, and contributions. You can even set contribution goals in the application. - Dan Cadden

Prerequisites

• macOS (Snow Leopard or newer (>= 10.6))
• Node.js and npm (nvm is recommended)

Installation

First, download and install BitBar.

Clone the plugin repo:

git clone https://github.com/clthck/gitbar

Inside the repo folder, install the dependencies:

npm i

Configuration

In the root folder you'll need to make .env file with your GitHub username (copy sample.env and rename it). Here you'll also be able to customize contribution goal tracking as well. Simply give the tracking value TRUE or FALSE to turn it on or off, respectively, and provide your ideal goal number to give yourself a completion percentage.

GITHUB_USERNAME="<YOUR_GITHUB_NAME_HERE>"
CONTRIBUTION_GOAL_TRACKING=true
CONTRIBUTION_GOAL="1000"
COMPACT_UI=true

Now, launch BitBar and select the gitbar_plugin folder as your Plugin Folder.

Gotchas

If you have an error resulting from your path to Node, edit the shebang at the top of gh.5m.js to include the correct path.

To find the correct path simply run:

which node

Or if you don't want to edit gh.5m.js file, hit the following:

ln -s $(which node) /usr/local/bin/node

Dependencies

Obviously BitBar.

I also use the github-contrib-stats to crawl GitHub and parse selected values from public GitHub profiles. Feel free to contribute if you'd like!

I use this module as GitHub API doesn't provide necessary data yet.

Suggestions, comments?

Feel free to create an issue or reach out on the 💬 BitBar Slack or Twitter @clthck!