Git Status Interactive
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
design
gitsi.xcodeproj
res
src
LICENSE
Makefile
Readme.md

Readme.md

GITSI

Git Status Interactive

Usage

# Run with a rspecific repository
gitsi ~/Development/Code

# The current directory is a repository
gitsi

Click here to see a short example video

What is it

Gitsi is a simple wrapper around git status and git add It provides an easy terminal UI that is optimized for staging, unstaging, and deleting files and changes between the git index, workspace and untracked files.

There are many useful features such as quick jumping to sections, filtering, running git add -p diffing, and quick navigation.

Gitsi displays all your changes and untracked files in a list with the index, workspace, and untracked sections. Just like git status However, you can navigate this this interactively much like vi / vim. Which makes it much easier to quickly jump to the one file you'd like to add or the one file you'd like to move back from the index to the workspace.

Shortcuts

The following shortcuts are also explained within gitsi in a help section at the bottom.

NAVIGATION

  • j move one line down
  • k move one like up
  • C-d Jump half a page down
  • C-u Jump half a page up
  • ! [Shift 1] Jump straight to the index section of the git status output.
  • @ [Shift 2] Jump straight to the workspace section of the git status output.
  • # [Shift 3] Jump straeight to the untracked files section of the git status output.
  • G Jump to the bottom of the list.
  • g Jump to the top of the list.
  • q Quit

SEARCHING

  • / Enter the search / filter mode. Hit return to apply the filter and ESC to cancel the filter. If a filter has been applied, hit / again to edit it again.
  • ESC Cancel the current search or visual mark mode.
  • Enter Apply the current search.

ACTIONS

  • s Add file or stage (depending on context).
  • u Unstage file or delete file (depending on context).
  • m Mark selected file.
  • V Toggle visual mark mode. Moving around will mark files
  • S Stage / Add all marked files. This will also unmark all marked files.
  • U Unstage / delete all marked files. This will also unmark all marked files.
  • d Switch to a git diff of the selected file
  • e Open the selected file in vim for editing
  • i Run a interactive add `git add -p1
  • c Run git commit
  • C Run git commit --amend
  • x Delete all changes to this file. The same as git checkout -- name-of-file

The j/k/C-d/C-u commands can be repeated by entering numbers before the actual command, like vim. i.e. 12j would jump down 12 lines.

Installation

macOS

brew install libgit2
make release
make install

Ubuntu

apt-get install make
apt-get install libgit2-dev
apt-get install libncurses-dev
make release
make install

Development

This is the first pure C project I finished since around 2004. I'm sure there're tons of bugs. If you find an issue, feel free to point it out.

If you build it in debug mode, it will create /tmp/gitsi.log and you can use the gitsi_debug_str function to write to this log.

I deliberately c hose to have all the code in one file in order to simplify working in terminal editors like vim. However, as can be seen in the todo list at the bottom, this might change in the future.

There're currently no tests (and no testing framework) but that's on the agenda.

If you're a die-hard C user and find things that are wrong, please keep in mind that this is a beginner project and please be kind. Thanks.

Terminal

make will create a debug build in the current folder (./gitsi). You can debug on the terminal via llvm llvm gitsi [repo]

Xcode

There's an Xcode project included. It should work right away.

Xcode debugging

Since Xcode does not support running apps with TUI / curses, you have to attach to a process. The way it works is:

  1. Build in Xcode, and then run for debugging
  2. Xcode will say "waiting to attach"
  3. Go into a terminal and run the just-build Xcode product (i.e. somewhere in derived data)
  4. Xcode will connect. Now your breakpoints will be hit.

Linux

For testing on Linux, if you're on a Mac, there's res/Dockerfile that adds clang, valgrind, etc. It can be run via:

# assuming you build the docker image via `docker build . --tag=gitsi:dev`
# also assuming you're in the parent dir that contains the checked out `gitsi` dir (i.e. cd ..)
docker run -it --mount type=bind,source="$(pwd)"/gitsi,target=/code gitsi:dev bash

Valgrind

Valgrind is a good way of detecting memory leaks. Running it looks like this:

valgrind --leak-check=full \
         --show-leak-kinds=all \
         --track-origins=yes \
         --verbose \
         --log-file=valgrind-out.txt \
         ./gitsi REPO-DIR

Note that there're some gray_control leaks in libssh. Those seem to be ignorable, based on https://github.com/libgit2/libgit2/pull/4804/files

NCurses also works in a way that looks like leaks to valgrind: https://invisible-island.net/ncurses/ncurses.faq.html#config_leaks

Open Issues

  • Currently, gitsi has to be run in the repo root, otherwise some operations calculate the wrong file path. This should account for the pwd.
  • [Maybe] Split up into multiple files
  • Add git stash support, especially for stashing individual files
  • The loop over the status items should not happen three times, but instead happen once and call out to functions for index, workspace, and untracked
  • git commit -a
  • Deleted files can only be unstaged to toggle between index and workspace. That seems to be because the status is not taken into account
  • [Maybe] add to homebrew
  • [Maybe] a config file (line numbers on off, color on off, etc)
  • Better error handling (calloc fail, git fail, etc)