git-remind: Do you forget to git commit/git push?
Tags: git, gitremind
Published: 2018-10-30 10:39:06

---
title: git-remind: Do you forget to git commit/git push?
published: true
description: 
tags: git,git-remind
---

Do you forget to git commit or git push? [git-remind] is a command line tool for such a forgetful person (like me). It monitors the state of the Git repositories and reports which repositories need to commit or push.

[git-remind]: https://github.com/suin/git-remind

## Features

### git-commit/git-push status

git-remind checks across the all git repositories in your computer, and it displays the status whether there are uncommitted files and there are ahead commits which should be pushed to remote.

![](https://thepracticaldev.s3.amazonaws.com/i/vfx2blo98d2k0nxqn10b.png)

### Desktop Notification

git-remind notifies you git-commit/git-push status using desktop notification. This feature is tested macOS, but it will work in Windows and Linux.

![](https://thepracticaldev.s3.amazonaws.com/i/daza4qkeldvq6r33ga4q.png)

## Installation

### Homebrew

```
brew install suin/suin/git-remind
```

### Manually

Download build binary from the [releases](https://github.com/suin/git-remind/releases).

## Configuration

Add `remind.paths` to your `.gitconfig`, using your own absolute path to the repository directories. 

```text:.gitconfig
[remind]
	paths = /Users/you/projects/foo,/Users/you/projects/bar
```

If you have some git repositories (e.g. `~/projects/foo` and `~/projects/bar`) in the same directory (e.g. in `~/projects`) , you may specify the path using wildcard (e.g.`/Users/you/projects/*`):


```text:.gitconfig
[remind]
	paths = /Users/you/projects/*
```

Check the configuration using the following command:

```bash
git-remind paths # Shows path patterns configuration
git-remind repos # Shows git repositories to be reminded
```

## Usage

### Display git-commit/git-push status

```
$ git-remind status
Need to commit: /Users/suin/projects/myapp1
Need to commit and push: /Users/suin/projects/myapp2
```

#### Short status like `git status -s`

```
$ git-remind status -s
C  /Users/suin/projects/myapp1
CP /Users/suin/projects/myapp2
```

#### Show all status including up-to-date repositories 

```
$ git-remind status -a
Need to commit: /Users/suin/projects/myapp1
Need to commit and push: /Users/suin/projects/myapp2
Up-to-date: /Users/suin/projects/myapp3
```

### Desktop Notification

```
git-remind status-notification
```

## Advanced usage

### Scheduled reminder (cron)

To get scheduled reminder, set up crontab. Following example send notifications every 20 minutes:

```
PATH=/usr/local/bin:/usr/bin:/bin

*/20 * * * * git-remind status-notification > /dev/null 2>&1
```

### Jumping to the repositories

By combining git-remind and [fzf](https://github.com/junegunn/fzf), you will be able to jump the repositories that needs to commit or push:

```
cd $(git remind status -n | fzf)
```

![](https://thepracticaldev.s3.amazonaws.com/i/7lzjcngv47h6zusc8ufe.gif)

It would be useful that you set command alias in your .bashrc/.zshrc:

```bash
alias grj='cd $(git remind status -n | fzf)'
```

## Reference

* GitHub: [suin/git-remind: Never forget to git commit and push] (https://github.com/suin/git-remind)