Home

Awesome

gfold

latest release tag crates.io version license build status

gfold is a CLI tool that helps you keep track of multiple Git repositories.

A GIF showcasing gfold in action

If you'd prefer to use the classic display mode by default, and avoid setting the flag every time, you can set it in the config file (see Usage section).

Description

This app displays relevant information for multiple Git repositories in one to many directories. It only reads from the filesystem and will never write to it. While this tool might seem limited in scope and purpose, that is by design.

By default, gfold looks at every Git repository via traversal from the current working directory. If you would like to target another directory, you can pass its path (relative or absolute) as the first argument or change the default path in the config file.

After traversal, gfold leverages rayon to perform concurrent, read-only analysis of all Git repositories detected. Analysis is performed by leveraging the git2-rs library.

Usage

Provide the -h/--help flag to see all the options for using this application.

# Operate in the current working directory or in the location provided by a config file, if one exists.
gfold

# Operate in the parent directory.
gfold ..

# Operate in the home directory (first method).
gfold $HOME

# Operate in the home directory (second method).
gfold ~/

# Operate with an absolute path.
gfold /this/is/an/absolute/path

# Operate with a relative path.
gfold ../../this/is/a/relative/path

Config File

If you find yourself providing the same arguments frequently, you can create and use a config file. gfold does not come with a config file by default and config files are entirely optional.

How does it work? Upon execution, gfold will look for a config file at the following path on macOS, Linux and similar operating systems.

$HOME/.config/gfold.toml

On Windows, the lookup path will be in a similar location.

{FOLDERID_Profile}\.config\gfold.toml

For config file creation, you can use the --dry-run flag to print valid TOML. Here is an example config file creation workflow on macOS, Linux and similar platforms:

gfold -d classic -c never ~/ --dry-run > $HOME/.config/gfold.toml

Here are the contents of the resulting config file:

path = '/home/neloth'
display_mode = 'Classic'
color_mode = 'Never'

Let's say you created a config file, but wanted to execute gfold with entirely different settings and you want to ensure that you do not accidentally inherit options from the config file. In that scenario you can ignore your config file by using the -i flag.

gfold -i

You can restore the config file to its defaults by using the same flag.

gfold -i > $HOME/.config/gfold.toml

In addition, you can ignore the existing config file, configure specific options, and use defaults for unspecified options all at once. Here is an example where we want to use the classic display mode and override all other settings with their default values:

gfold -i -d classic > $HOME/.config/gfold.toml

You can back up a config file and track its history with git. On macOS, Linux, and most systems, you can link the file back to a git repository.

ln -s <path-to-repository>/gfold.toml $HOME/.config/gfold.toml

Now, you can update the config file within your repository and include the linking as part of your environment setup workflow.

Installation

Packaging status

Homebrew

You can use Homebrew to install gfold with a choice of two methods.

Core (macOS and Linux)

gfold is now available in the core formulae! However, you may run into a naming collision on macOS if coreutils is installed via brew. See the troubleshooting section for a workaround and more information.

brew install gfold

Tap (macOS only)

The tap is still available if you would like to use it. This is subject to change.

brew install nickgerace/nickgerace/gfold

Arch Linux

You can use pacman to install gfold from the extra repository.

pacman -S gfold

Nix and NixOS

You can install gfold from nixpkgs:

nix-env --install gfold

If you are using flakes, you can install using the nix command directly.

nix profile install "nixpkgs#gfold"

Cargo

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

cargo install gfold

Use the --locked flag if you'd like Cargo to use Cargo.lock.

cargo install --locked gfold

Keeping the crate up to date is easy with cargo-update.

cargo install cargo-update
cargo install-update -a

Download a Binary

If you do not want to use one of the above installation methods and do not want to clone the repository, you can download a binary from the releases page. For an example on how to do that, refer to the manual install guide.

Build From Source

If you would like an example on how to build from source, refer to the manual install guide.

Preferred Installation Method Not Listed?

Please file an issue!

Compatibility

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

Usage as a Library

There are two ways to use gfold as a "library".

  1. Use the libgfold crate that powers gfold
  2. Consume valid JSON results from gfold -d json (not a library, but useful for non-Rust applications)

Troubleshooting and Known Issues

If you encounter unexpected behavior or a bug and would like to see more details, please run gfold with the following environment variables:

# You may also want to add relevant arg(s) and flag(s).
RUST_BACKTRACE=1 RUST_LOG=debug gfold

If the issue persists, please file an issue.

Tuning Environment Variables

Since RUST_BACKTRACE and RUST_LOG do not have gfold-specific behaviors, you can adjust them just as you would in other projects to aid investigation. Please attach relevant logs from execution with sensitive bits redacted in order to help resolve your issue.

Coreutils Collision on macOS

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

Upstream libgit2 Issue

If you are seeing unsupported extension name extensions.worktreeconfig or similar errors, it may be related to libgit2/libgit2#6044.

This repository's tracking issue is #205.

Community

For more information and thanks to contributors, users, and the "community" at large, please refer to the THANKS file.