git-remind - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #go #nodejs #awesome #kubernetes #awesome-list #vue #pytorch #ios #openai #open-source

git-remind

(★ 108)

Never forget to git commit and push

파일 탐색기

최종 버전 다운로드 (.zip)

- - service.go
- - app.go
- - color.go
  - print.go
- demo-fzf.gif
- demo-git-remind-status.png
- demo-notification.png
- get_path_patterns.go
- get_repo_statuses.go
- get_repos.go
- notify_repo_statuses.go
- - get_global_config.go
  - status.go
- beeep_repo_status_notifier.go
- filesystem_repos.go
- git_get_status.go
- git_global_config_path_patterns.go
.gitignore
.goreleaser.yml
LICENSE.md
main.go
Makefile
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/suin/git-remind

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd git-remind

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Homebrew macOS/Linux용 패키지 매니저입니다.

brew install suin/suin/git-remind

Homebrew로 이미 빌드된 패키지를 바로 설치합니다. 소스 빌드가 필요 없습니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Make

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.

make

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

✅ 에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# git-remind

git-remind is a command line tool that prevent you to forget git-commit and git-push.

## 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://raw.githubusercontent.com/suin/git-remind/master/docs/demo-git-remind-status.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://raw.githubusercontent.com/suin/git-remind/master/docs/demo-notification.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/*
```

You can also utilise the `git config` command to configure git-remind to avoid the manually editing of the `.gitconfig`.

```bash
git config --global remind.paths '/Users/you/projects/*'
```

Check the configuration using 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
```

### Ad-hoc paths configuration

The paths can be specified with `--path` option instead of git global configuration `remind.paths`.

```
$ git-remind --path '/path/to/dir/*' paths
/path/to/dir/*
```

The option accepts multiple paths giving two or more `--path` options.

```
$ git-remind --path '/path/to/dir1/*' --path '/path/to/dir2/*' paths
/path/to/dir1/*
/path/to/dir2/*
```

Also giving the environment variable `GIT_REMIND_PATHS`, it makes the same effect.

```
$ export GIT_REMIND_PATHS='/path/to/dir1/*,/path/to/dir2/*'
$ git-remind paths
/path/to/dir1/*
/path/to/dir2/*
```

When both of `--path` option and `GIT_REMIND_PATHS` are given, the paths become the combination of the both.

```
$ export GIT_REMIND_PATHS='/path/to/dir1/*,/path/to/dir2/*'
$ git-remind --path '/path/to/dir3/*' paths
/path/to/dir1/*
/path/to/dir2/*
/path/to/dir3/*
```

## 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://raw.githubusercontent.com/suin/git-remind/master/docs/demo-fzf.gif)

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

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