gfold

gfold is a CLI-driven application that helps you keep track of multiple Git repositories.

% gfold
astrid  unclean   main       git@github.com:db/astrid.git
fev     bare      main       https://github.com/institute/fev.git
gb      unpushed  dev        https://github.com/hrothgar/gb.git
neloth  unclean   patch      git@github.com:telvanni/neloth.git
pam     clean     main       https://github.com/onc/pam.git
prime   clean     issue2287  git@github.com:bos/prime.git

Description and Motivation

This app displays relevant information for multiple Git repositories in one to many directories. While this tool might seem limited in scope and purpose, that is by design.

It prints each repository in alphabetical order, and pads each result based on the longest directory, branch, and status string. By default, gfold looks at every Git repository via traversal from the current working directory. However, if you would like to target another directory, you can pass that path (relative or absolute) as the first argument.

Installation

There multiple methods for installing gfold.

Homebrew and Linux Brew

You can use macOS Homebrew or Linuxbrew to install the tap.

brew install nickgerace/gfold/gfold

AUR

You can use a Linux distribution that supports installing packages from the AUR, Arch User Respository, to install the following:

• gfold - builds from source
• gfold-git - development package

Many people choose to use an AUR helper, such as yay or paru, in order to install their AUR packages.

yay -S gfold
paru -S gfold

Cargo

You can use cargo to install the crate on almost any platform.

cargo install gfold

Usage

Pass in the -h, or --help, flag to see all the options for using this application.

gfold
gfold ..
gfold $HOME
gfold /this/is/an/absolute/path
gfold ../../this/is/a/relative/path

Compatibility

gfold is intended to be ran on any tier one Rust target. Please file an issue if your platform is unsupported.

Troubleshooting

If fold from GNU Coreutils is installed on macOS via brew, it will be named gfold. You can avoid this collision with shell aliases, shell functions, and/or PATH changes. Here is an example with the o dropped from gfold:

alias gfld=$HOME/.cargo/bin/gfold

Code of Conduct

This repository follows and enforces the Rust programming language's Code of Conduct.

More Information

Please continue to EXTRA.md for more information on using gfold.