https://github.com/perry-mitchell/gstat

Git repo stats reporter application for the terminal
https://github.com/perry-mitchell/gstat

command-line command-line-tool git github status

Last synced: 5 days ago
JSON representation

Git repo stats reporter application for the terminal

• Host: GitHub
• URL: https://github.com/perry-mitchell/gstat
• Owner: perry-mitchell
• License: mit
• Created: 2017-06-09T19:50:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-16T19:08:59.000Z (over 7 years ago)
• Last Synced: 2024-11-30T08:39:21.873Z (22 days ago)
• Topics: command-line, command-line-tool, git, github, status
• Language: JavaScript
• Size: 153 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gstat

Git repo stats reporter application for the terminal

[![gstat on npm](https://nodei.co/npm/gstat.png?downloads=true)](https://www.npmjs.com/package/gstat)

## Installation

Install `gstat` globally:

```shell

npm install -g gstat

```

## Usage

`gstat` takes a directory or glob of directories:

```shell

gstat /somedir

# or

gstat ~/git/*

```

### Options

Certain flags can be added to the command:

 * `-w`: Watch the listed directories for changes every 5 seconds

 * `--watch=n`: Watch the listed directories for changes every **n** seconds

 * `-h`: Show headings

 * `-b`: Show branch

 * `--boring`: Disable emojis

## Output

`gstat` outputs a list of matched directories and their statuses:

![gstat command example](https://github.com/perry-mitchell/gstat/raw/master/gstat-example.png)