Check It Out

Check it out, before you checkout

What is Check It Out?

Check It Out

Check It Out lets you interactively see and choose what branch you want to check out without the hassle of trying to type out a long or confusing branch name. Checking out branches just got even simpler!

Requirements

Node >= v4.0
Git - Required for core features

Compatibility

Check It Out currently has known issues with Windows. Some users have reported it working while others have reported that it does not. It is built and tested mostly in an Arch Linux environment with some user testing on MacOS and other Linux distributions. We're currently looking for help figuring out why Check It Out is unstable on Windows. See CIO-128

Installation

We're on NPM!

 npm install -g check-it-out 

Installing from source

Fork or clone the repository

 git clone https://github.com/jwu910/check-it-out.git 

Navigate to your repository and run

 npm install 

Creat a symbolic link to your entry point

Linux/Mac

In the repository directory run:

 npm link 

Usage

Run this command to list local and remote branches!

 checkit 
Using Check It Out

Features

Call git log on current highlighted branch with space

Git log gif animation
Command Description
j/k, / Navigate the list
h/l, / Previous/Next remote
Ctrl+r Refresh list with a fetch and prune
enter Select highlighted item
space Git log
q, Ctrl+c, esc Quit

Settings

Git log argument validation is planned, but not finished. Currently, if the git log fails, space should not crash the app, but the process should not spawn at all.

Configurable settings can be found at

~/.config/configstore/check-it-out.json

Options Include:

To reset Check It Out to its original configurations listed above, start with the flag --reset-config:

checkit --reset-config

Contributing

Please refer to Contributing Guidelines.

Support

If you love Check It Out, please let me know by adding a star to my project and sharing with your friends and colleagues.

Thank you so much for visiting! Please take a second to consider supporting my current and future projects by buying me a coffee!

Buy me a coffee Buy me a coffee