FancyGit is a tool which works for Linux and MAC OS, that changes the terminal prompt in order to show you a few cool git informations when you're working on a git repo. It'll always keep you informed about the current branch status.

:rocket: Contributing | :monocle_face: Changelog | :hammer: Troubleshooting

:cupid: Installing

curl -sS https://raw.githubusercontent.com/diogocavilha/fancy-git/master/install.sh | sh

:broken_heart: Uninstalling

curl -sS https://raw.githubusercontent.com/diogocavilha/fancy-git/master/uninstall.sh | sh

:heavy_check_mark: After installing

1. Change the font in your terminal application to one of these fonts:
   • Sauce-Code-Pro-Nerd-Font-Complete-Windows-Compatible.ttf.
   • DejaVu-Sans-Mono-Nerd-Font-Complete.ttf.
   • DejaVu-Sans-Mono-Nerd-Font-Complete-Mono.ttf.
   • JetBrains-Mono-Regular-Nerd-Font-Complete-Mono.ttf.
   • JetBrains-Mono-Medium-Nerd-Font-Complete-Mono.ttf.
     It's necessary for rendering icons/symbols properly.
     If you can't find the font, it's still possible to install it manually by running fancygit --fonts-install or even installing the ttf file which is placed at ~/.fancy-git/fonts/. NB for Windows Terminal only the Sauce Code option above will display git icons correctly.
2. Restart your terminal.

Run fancygit -h to check FancyGit help.

:nail_care: Git suggested config

git config --global color.ui true
git config --global color.diff.meta "yellow bold"
git config --global color.diff.old "red bold"
git config --global color.diff.new "green bold"
git config --global color.status.added "green bold"
git config --global color.status.changed "yellow"
git config --global color.status.untracked "cyan"

Run fancygit --suggested-global-git-config to see that suggested config.
Run fancygit --suggested-global-git-config-apply to apply it.

I suggest you to use this config because FancyGit will paint the background branch, most of the time, according to the current repo status, since you're using some theme which allows that.

Type fancygit -h for more information.

:eyes: Overview

As a picture is worth a thousand words...

Working on a Python virtual environment?

:art: Themes and color schemes

If you don't want to be too "fancy", you can choose using the simple theme by running fancygit --theme-simple. If you want to return to the default theme, just type fancygit --theme-default. There are a few more themes and color schemes you can choose from.

Type fancygit -h to see all available themes and color schemes on "THEME COMMANDS" and "COLOR SCHEME COMMANDS" sections.

Here you have a list of available themes and their corresponding color schemes.

Screenshot font: JetBrains-Mono-Medium-Nerd-Font-Complete-Mono.ttf

fancygit --theme-default (default color scheme: --color-scheme-default)

fancygit --color-scheme-dracula

fancygit --color-scheme-batman

fancygit --color-scheme-robin

fancygit --color-scheme-superman

fancygit --color-scheme-light

fancygit --color-scheme-neon

fancygit --color-scheme-cga

fancygit --theme-human (default color scheme: --color-scheme-human)

fancygit --theme-simple (default color scheme: --color-scheme-simple)

:link: Separators styles

You can type fancygit --separator<TAB> so you can see all the available separator styles for you to use.

:bangbang: Important :bangbang:

It's highly recommended to set up the terminal font to one of:

• Sauce-Code-Pro-Nerd-Font-Complete-Windows-Compatible.ttf.
• DejaVu-Sans-Mono-Nerd-Font-Complete.ttf.
• DejaVu-Sans-Mono-Nerd-Font-Complete-Mono.ttf.
• JetBrains-Mono-Regular-Nerd-Font-Complete-Mono.ttf.
• JetBrains-Mono-Medium-Nerd-Font-Complete-Mono.ttf.

This way, symbols will be rendered correctly and new FancyGit releases must work as expected.
In order to install the fonts you can run fancygit --fonts-install.

Screenshot font: Sauce-Code-Pro-Nerd-Font-Complete-Windows-Compatible.ttf

fancygit --separator-default

fancygit --separator-blocks

fancygit --separator-blocks-tiny

fancygit --separator-curve

fancygit --separator-fire

fancygit --separator-lego

fancygit --separator-paint

:dizzy: Feature switchers

Feature switchers are special commands to enable/disable features and they work on every theme.
You can enable or disable them by typing fancygit --enable-<feature-name> or fancygit --disable-<feature-name>.
Type fancygit -h to see all available feature switchers on "FEATURE SWITCHER COMMANDS" section.

:toolbox: Commands

:toolbox: Aliases

:gear: Advanced tweaking - override some default config values

If you like to tweak things more in-depth, like special characters and such, you can create environment variables. These variables override any value found in FancyGit default configuration.

Example:
You want to change the branch icon, because you are using a different console font and the icon is on a different character position inside the font. Simply create the correspondent environment variable.
For sure, you will likely have changed the symbol:

# Branch icon.
FANCYGIT_ICON_LOCAL_REMOTE_BRANCH=""

Here you can see a list of available environment variables FancyGit will search and replace:

# Path is a git repository
FANCYGIT_ICON_GIT_REPO

# Only local branch icon.
FANCYGIT_ICON_LOCAL_BRANCH

# Branch icon.
FANCYGIT_ICON_LOCAL_REMOTE_BRANCH

# Merged branch icon.
FANCYGIT_ICON_MERGED_BRANCH

# Staged files.
FANCYGIT_ICON_HAS_STASHES

# Untracked files.
FANCYGIT_ICON_HAS_UNTRACKED_FILES

# Changed files.
FANCYGIT_ICON_HAS_CHANGED_FILES

# Added files.
FANCYGIT_ICON_HAS_ADDED_FILES

# Unpushed commits.
FANCYGIT_ICON_HAS_UNPUSHED_COMMITS

# Path is a python virtual environment
FANCYGIT_ICON_VENV

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Holger Pandel 💻	Marvin Kweyu 💻	Foundjem 💻	Rafael Martins 💻	Otávio Augusto 📖	Roger Carhuatocto 📓	Rafael Pereira 📓
Tom Halliley 💵	Sven Finke 🤔	ibury08 💻	Josip Trupina 💻	David Quartino 💻	Borjovsky 💻	EDIflyer 💻
Gaby 💵	nboehm99 💻	Mike Szczys 💻

:coffee: Buy me a coffee!