Modules: Git

May 09, 2018

Displays information about local git repositories: branch, changed files, and recent commits.

git screenshot

Branch

The name of the currently-active git branch.

Changed Files

A list of all the files that have changed since the last commit, and their status.

Recent Commits

A list of n recent commits, who committed it, and when.

Source Code

wtf/git/

Required ENV Variables

None.

Keyboard Commands

Key: /
Action: Open/close the widget’s help window.

Key: h
Action: Show the previous git repository.

Key: l
Action: Show the next git repository.

Key: ←
Action: Show the previous git repository.

Key: →
Action: Show the next git repository.

Configuration

git:
  commitCount: 5
  enabled: true
  position:
    top: 0
    left: 3
    height: 2
    width: 2
  refreshInterval: 8
  repositories:
  - "/Users/chris/go/src/github.com/senorprogrammer/wtf"
  - "/Users/user/fakeapp"

Attributes

commitCount
The number of past commits to display.
Values: A positive integer, 0..n.

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

position
Defines where in the grid this module’s widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

repositories
Defines which git repositories to watch.
Values: A list of zero or more local file paths pointing to valid git repositories.

Content