Giter VIP home page Giter VIP logo

git-recall's Introduction

git-recall

Simple and handy tool to easily recall what you've done

git recall

Purpose

git-recall is a simple tool that allows you to easily go through your commits and check what you or other contributors in your team did. It doesn't aim to be a replacement for the git log command, but just to be a handy way to recall what you've done from your terminal.

Usage

$ git recall   [-a <author name>] 
	           [-d <days-ago>]
               [-f]
               [-h]
Options description:
  • -a - Restrict search for a specific user (use -a "all" for all users)
  • -d - Display commits for the last n days
  • -f - Fetch the latest changes
  • -h - Show help screen
How to use:

Once the commits are displayed, you can use either the arrow keys or j/k to switch between commits, press TAB to expand/reduce the commit's diff or q to quit.

Limitations:

when the number of lines between the commits list and a commit's diff is higher than the current terminal session's number of lines, the result will be displayed using the less program which will open the diff in a separate screen. You can still use either TAB or q to return to the commits list.

Examples

$ git recall
# By default (without options), the command will display commits from yesterday and
# for the current user.
$ git recall -d 5 -a "Doge"
# The command will show all Doge's commits from 5 days ago.

$ git recall -d 5 -a "all"
# The command will show commits of all contributors from 5 days ago.
$ git recall -f
# Fetch commits beforehand.

Installation

Without using tools
You can install it by simply copying the `git-recall` script into any existing path
(e.g. /usr/local/bin) or create your own directory and add it to the 'PATH' variable.
Using NPM

Use npm to install the project.

npm install --global git-recall
Manual install

Clone the project and install it using make install.

$ git clone https://github.com/Fakerr/git-recall.git
$ cd git-recall
$ sudo make install

Requirements

  • OS: Linux or OSX
  • Tools: git, less, sed
Optional Requirements
  • For a better UX, it's recommended to have installed the lesskey program.

Contribution

Pull requests are welcome, along with any feedback or ideas.

License

MIT

git-recall's People

Contributors

fakerr avatar teszko avatar

Watchers

Vincent.Chan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.