Skip to content

Latest commit

 

History

History
652 lines (616 loc) · 47.6 KB

README.md

File metadata and controls

652 lines (616 loc) · 47.6 KB
Raw

Shell Prompt Customization Scripts

These scripts aim to provide the user the ability to more easily and flexibly change their shell (bash and zsh) and git repository prompts.

NOTE
zsh is not currently supported, but support is planned to be included.

Using the Shell Prompt Customization Scripts

To use the Shell Prompt customization scripts, simply copy sh-prompt.sh and/or git-prompt.sh files to your home directory. On linux, this is typcially accessed by using the alias ~. On Windows®, your home directory is typically located at C:\Windows\Users\<your username>. You can quickly go to the location of your home directory by typing %USERPROFILE% into the location bar in Windows Explorer.

When putting these files into your home directory, you can optionally rename the scripts to .sh-prompt.sh and .git-prompt.sh.

Finally, an example .bashrc file is provided in this repository. You can use it as is (by copying it also to your home directory), or take the bits and pieces that you need to customize your shell prompt, adding them to your existing .bashrc file. The example .bashrc file contains many environment variables that are commented out. This example script shows you all the available environment variables you can set in your .bashrc to affect the display of your shell prompt. The value shown for each commented out variable is the default value for the variable used by the scripts when the variable is undeclared and/or empty or null. See below or read the comments in the individual sh-prompt.sh and git-prompt.sh scripts for more information.

The version of git-prompt.sh that is supplied with this repository has been modified to allow you to customize the display of git repository information in your shell prompt in more ways than the original git-prompt.sh script allows.

Customizing Your Shell Prompt

This section will outline how you can use sh-prompt.sh to customize your shell prompt. This section won't discuss customizing the git repository portion of the shell prompt (that will be covered under Customzing Your Git Format String below).

The following sections define the environment variables you can set in your .bashrc file to customize your shell prompt. Examples of various customizations will be shown afterwards.

As stated in Using the Shell Prompt Customization Scripts, you must copy sh-prompt.sh to your home directory (either with the same name, or renamed as .sh-prompt.sh) and be sourced from your .bashrc file (which is typically in the same location) in order for the environment variables discussed below to have any effect on your shell prompt.

Shell Prompt Textual Format String Variables

The environment variables listed below can be used to customize the text that is displayed for each portion of a typical shell prompt. You should refrain from including any color information in these format strings (unless you want or need more complex colorization of portions of your shell prompt).

Just remember, the more text you display in your prompt, the slower it will be to display the prompt. This includes any color information you decide to include in the color format strings discussed in the following section.

SH_PS1_USERNAME

Sets the string to be used for the username portion of the prompt string.

If this variable is not declared, or it's null or empty, then this defaults to the username placeholder token for the shell prompt. Otherwise, the username portion of the shell prompt will contain this text.

NOTE

If the format string does not contain the username placeholder (\u for bash, for example), then the username of the current interactive user will not be displayed; however, any other text in this variable will still be displayed.

If you don't want to display the username portion of the shell prompt, omit the 'u' format specifier when setting SH_PS1_FORMAT_STRING. See below for more details.

EXAMPLE

SH_PS1_USERNAME="\n$(tput setaf 170)$MSYSTEM \u"

On a MINGW64 system (such as Git for Windows, this results in MINGW64 being displayed in a light purple (when using a 256-color terminal) followed by a space, followed by the bash username of the current interactive user.

SH_PS1_USER_HOST_SEPARATOR

Sets the string to be used for separating the username from the hostname when displaying the shell prompt.

If not declared, null, or empty, then this defaults to the '@' character. Otherwise, the value defined is used between the username and hostname portions of the shell prompt format string.

If for whatever reason you want no separator between the username and hostname portions of the shell prompt, then omit the 'z' format specifier in SH_PS1_FORMAT_STRING instead. See below for more details.

SH_PS1_HOSTNAME

Sets the string to be used for the hostname portion of the prompt string.

If not declared, null, or empty, then this defaults to the hostname placeholder token for the shell prompt. Otherwise, the hostname portion of the shell prompt will contain this text.

NOTE

If the format string does not contain the hostname placeholder token (\h for bash, for example), then the hostname will not be displayed; however, any other text in this variable will still be displayed.

If you don't want to display the hostname portion of the shell prompt, omit the 'h' format specifier in SH_PS1_FORMAT_STRING. See below for more details.

SH_PS1_PWD

Sets the string to be used for the present working directory (PWD) portion of the prompt string.

If not declared, null, or empty, then this defaults to the PWD placeholder token for the shell prompt. Otherwise, the PWD portion of the shell prompt will contain this text.

NOTE

If the format string does not contain the PWD placeholder token (\w for bash, for example), then the PWD will not be displayed; however, any other text in this variable will still be displayed.

If you don't want to display the PWD portion of the shell prompt, omit the 'w' format specifier in SH_PS1_FORMAT_STRING. See below for more details.

SH_PS1_PROMPT

Sets the string to be used for the prompt portion of the prompt string (i.e. the '$' or '#' that is displayed indicating the shell is ready for user input).

If not declared, null, or empty, then this variable defaults to '\n\$<SP>' for the shell prompt (i.e. a '$' on a new line followed by a space).

Any other text can be used for this variable. But as you may have noticed, something must be displayed. There is no way to not have some sort of prompt be displayed (without altering sh-prompt.sh itself).

SH_PS1_FORMAT_STRING

Defines the tokens that define what portions of the bash prompt should be displayed, and in what order. The SH_PS1_PROMPT is always appended to this string.

If this variable is undeclared, null, or empty, it defaults to "uzhwv". By default, this results in the following prompt:

username@host pwd [git_repository_info]
$

If you are not inside a git repository (or __git_ps1 is not defined), then the [git_repository_info] is not displayed.

The meaning of each of the format specifier tokens is listed in the table below:

Format Token Description
u Gets relpaced with SH_PS1_USERNAME
z Gets replaced with SH_PS1_USER_HOST_SEPARATOR
h Gets replaced with SH_PS1_HOSTNAME
w Gets replaced with SH_PS1_PWD
v If __git_ps1 is defined, and you are in a directory that houses a git repository, then this token is indicates where the git repository information will be displayed in your shell prompt.

Some notes regarding the use of this variable:

  1. You can place these tokens in any order.
  2. This variable should only contain these tokens and no other text. Any other text included in this variable may result in unpredictable and unsupported behavior.
  3. Any spacing and formatting you require for your desired shell prompt should be defined through the individual format string variables (e.g. the SH_PS1_* variables) discussed above.

NOTE
Unless you require or desire complex shell prompt colorization, you should place most color information for the various aspects of your prompt in the color format string variables discussed in the next section.

Remember, the more text you provide in the various pieces of your prompt (including any color information), the slower it will be to display your prompt.

Finally, remember, you should not place any other text in the SH_PS1_FORMAT_STRING variable except for the tokens that were listed in the table above. Any other text in this environment variable will most likely result in your prompt not working as expected, if at all.

###Shell Prompt Color Format String Variables The environment variables listed below can be used to customize the colorization of various parts of your shell prompt. You should refrain from including any textual information in these format strings (unless you want or need more complex customization of portions of your shell prompt). Any text other than command-substitution calls to tput (or ANSI/VT-100 color escape sequences) may result in unpredictable behavior of this script and is stricty unsupported.

Just remember, the more text you display in your prompt, the slower it will be to display the prompt. This includes any color information you decide to include in these color format strings.

SH_PS1_DONT_COLORIZE_PROMPT

If set to 1, the shell prompt will not be colorized (unless any textual format strings discussed in the section above contain any color information themselves).

If this variable is not declared or has any value other than 1 (including null), then the bash prompt will be colorized.

SH_PS1_USERNAME_COLOR

Sets the color the username portion of the shell prompt.

If this variable is not declared and SH_PS1_DONT_COLORIZE_PROMPT is not set to 1, the default color is green, $(tput setaf 2). Otherwise, if this variable is null or empty, it results in $(tput sgr0). Otherwise the value of the variable is used in the shell prompt.

SH_PS1_USER_HOST_SEPARATOR_COLOR

Sets the color for the text which separates the username/hostname portions of the shell prompt.

If this variable is not declared and SH_PS1_DONT_COLORIZE_PROMPT is not set to 1, the default color is green, $(tput setaf 2). Otherwise, if this variable is null or empty, it results in $(tput sgr0). Otherwise the value of the variable is used in the shell prompt.

SH_PS1_HOSTNAME_COLOR

Sets the color for the hostname portion of the shell prompt.

If this variable is not declared and SH_PS1_DONT_COLORIZE_PROMPT is not set to 1, the default color is green, $(tput setaf 2). Otherwise, if this variable is null or empty, it results in $(tput sgr0). Otherwise the value of the variable is used in the shell prompt.

SH_PS1_PWD_COLOR

Sets the color for the present working directory (PWD) portion of the shell prompt.

If this variable is not declared and SH_PS1_DONT_COLORIZE_PROMPT is not set to 1, the default color is dim yellow, $(tput setaf 3) (or brown, as I think it was called for 8/16-color mode). Otherwise, if this variable is null or empty, it results in $(tput sgr0). Otherwise the value of the variable is used in the shell prompt.

SH_PROMPT_COLOR

Set the color for the prompt portion of the shell prompt (e.g. typically the '$ or '#' that appears indicating the shell is ready and awaiting user input).

If this variable is not declared, is null, or empty, then the prompt string's resulting color is $(tput sgr0). Otherwise the value of the variable is used in the shell prompt.

WARNING
There's nothing stopping you from placing other text in the variables discussed above, but they're intended to contain only color information for the various pieces of the prompt string.

You can experiment with values other than purely color information, but you do so at your own risk.

Customzing Your Git Format String

git-prompt.sh only affects the display of your shell prompt when you are currently in a directory which contains a git repository.

The customized version of git-prompt.sh included in this repository allows for enhanced customization of your git repository format string. In the sections that follow, the standard environment variables will be discussed (those that natively come with the git-prompt.sh script as supplied by git) and the variables that this customized version of git-prompt.sh allow to be set.

As stated above in Using the Shell Prompt Customization Scripts, you must copy git-prompt.sh to your home directory (either with the same name, or renamed as .git-prompt.sh) in order for the environment variables discussed below to have any effect on your shell prompt.

The Standard git-prompt.sh Environment Variables

The following list describes the effects of the standard git-prompt.sh environment variables on the display of git repository information in the shell prompt. The core functionality of these environment variables has been preserved by the extended version of this script. The default values of all environment variables used in this extended git-prompt.sh script result in the standard, out-of-the-box display of git repository information (which is usually just the currently checked out branch name of the git repository).

Many of the effects of the standard git-prompt.sh environment variables can be changed or extended through the use and setting of additional environment variables supported by this extended git-prompt.sh script.

GIT_PS1_SHOWDIRTYSTATE

If this environment variable is set to a non-empty value, unstaged and staged changes will be shown next to the current branch name for the git repository.

Unstaged files are denoted with a red '*' and staged changes are denoted with a green '+'. These characters can be replaced using the extended environment variables discussed in the sections that follow.

You can configure the display of this information per repository with the bash.showDirtyState git repository configuration variable. This git configuration repository variable defaults to true once this environment variable is set. To change a repository to not show this information after this environment variable has been set, run the following command inside the git repository:

$ git config bash.showDirtyState=false
GIT_PS1_SHOWUNTRACKEDFILES

If this environment variable to a non-empty value, a character representing that there are untracked files in the repository will be displayed next to the current branch name for the git repository.

Untracked files are denoted with a red '%' sign. This character can be replaced using the extended environment variables discussed in the sections that follow.

You can configure the display of this information per repository with the bash.showUntrackedFiles git configuration variable. This git repository configuration variable defaults to true once this environment variable is set. To change a repository to not show this information after setting this environment variable, run the following command inside the git repository:

$ git config bash.showUntrackedFiles=false
GIT_PS1_SHOWSTASHSTATE

If this environment variable is set to a non-empty value, a character representing whether or not any stashes exist in the repository will be displayed next to the current branch name for the git repository.

If there are any stashes present in the current repository, this will be denoted with a blue '$'. This character can be replaced using the extended environment variables discussed in the sections that follow.

GIT_PS1_SHOWUPSTREAM

If you would like to see the difference between HEAD and its upstream, set this environment variable to auto. A '<' indicates you are behind, '> indicates you are ahead, '<>' indicates you have diverged, and '=' indicates that there is no difference between your copy of the branch and the upstream branch. You can further control behaviour of displaying upstream branch information by setting this environment variable to a space-separated list of values shown in the table below:

Value Description
verbose Shows the number of commits your copy of the branch is ahead/behind (+/-) of the upstream branch.
name If verbose is specified, then also showthe upstream abbreviation name.
legacy Don't use the --count option available in recent versions of git-rev-list
git Always compare HEAD to @{upstream}
svn Always compare HEAD to your SVN upstream

By default, __git_ps1 will compare HEAD to your SVN upstream if it can find one, or @{upstream} otherwise. Once you have set this environment variable, you can override it on a per repository basis by setting the git repository configuration variable bash.showUpstream. To change how a particular repository shows this information after setting this environment variable, run the following command inside the repository:

        # Running this command sets bash.showUntrackedFiles to its default value.
        # Of course, you can use any of the values from the table above.
        $ git config bash.showUntrackedFiles="git"
GIT_PS1_STATESEPARATOR

You can change the separator between the branch name and the above state symbols by setting this environment variable. The default separator is <SP> (a space character).

GIT_PS1_DESCRIBE_STYLE

If you would like to see more information about the identity of commits checked out as a detached HEAD, set this environment variable to one of these values:

Value Description
contains Displays a value relative to a newer annotated tag as the current branch name. For example: (v1.6.3.2~35).
branch Displays a value relative to a newer tag or branch as the current branch name. For example: (master~4)
describe Displays a value relative to an older annotated tag as the current branch name. For example: (v1.6.3.1-13-gdd42c2f)
default displays the exactly matching tag (or shortened commit SHA) as the current branch name.
GIT_PS1_SHOWCOLORHINTS

If this environment variable is set to a non-empty value, __git_ps1 displays colored repository branch state information. The colors are based on the colored output from the git status -sb command.

Colored output of dirty state information is only available when using the output from __git_ps1 for setting PROMPT_COMMAND (in bash) or when using precmd (in zsh).

NOTE

zsh is not supported at this time. Hopefully support will be added for this shell in the near future.

GIT_PS1_HIDE_IF_PWD_IGNORED

If you would like __git_ps1 to do nothing in the case when the current directory is set up to be ignored by _git_ (via a repository .gitignore or global ignore file), then set this environment variable value to a non-empty value.

You can override the effects of this environment variable on a per repository basis by setting the git repository configuration variable bash.hideIfPwdIgnored to false by running the following command from within the repository:

$ git config bash.hideIfPwdIgnored=false

New git-prompt.sh Environment Variables

The following list and description of environment variables have been added to this extended version of the git-prompt.sh script. The default values of all of these variables results in this extended git-prompt.sh script working in exactly the same manner as the standard git-prompt.sh script provided with distributions of git. These variables can be broken down into two main categories:

  1. Information display format strings
  2. Information display colorization

Display Format Strings

The following list describes the available format string environment variables that will allow you to customize how git repository information is displayed via __git_ps1.

GIT_PS1_SHOWUPSTREAM_STYLE

This environment variable can be set to one of the values listed in the following table. In the table below, the Verbose column indicates whether or not GIT_PS1_SHOWUPSTREAM contains verbose as one of its values. {ac} means ahead count, {bc} means behind count, and {b-ud} means behind user defined and {a-ud} means ahead user defined.

Value Verbose Behind Ahead Diverged Up-to-Date
default No < > <> =
default Yes u-{bc} u+{ac} u+{ac}-{bc} u=
arrow No ↓ ↑ ↓↑ ≡
arrow Yes {bc}↓ ↑{ac} {bc}↓↑{ac} ≡
rlarrowhead No ˂ ˃ ˂˃ ≡
rlarrowhead Yes {bc}˂ ˃{ac} {bc}˂˃{ac} ≡
udarrowhead No ˅ ˄ ˅˄ ≡
udarrowhead Yes {bc}˅ ˄{ac} {bc}˅˄{ac} ≡
rltri No ◄ ► ◄► ≡
rltri Yes {bc}◄ ►{ac} {bc}◄►{ac} ≡
udtri No ▼ ▲ ▼▲ ≡
udtri Yes {bc}▼ ▲{ac} {bc}▼▲{ac} ≡
custom No {b-ud} {a-ud} {b-ud}{a-ud} {ud}
custom Yes {bc}{b-ud} {a-ud}{ac} {bc}{b-ud}{a-ud}{ac} {ud}

If this environment variable is not declared or is null or empty or not one of the values defined in the table above, then the value defaults to default in the above table.

NOTE

In order to use any of the values except default or custom, you must use a terminal which supports UTF-8 character encoding. Likewise, if you use Unicode characters for any of the four custom glyph environment variables, your terminal must support UTF-8 character encoding.

GIT_PS1_SHOWUPSTREAM_CUSTOM_AHEAD
GIT_PS1_SHOWUPSTREAM_CUSTOM_BEHIND
GIT_PS1_SHOWUPSTREAM_CUSTOM_DIVERGED
GIT_PS1_SHOWUPSTREAM_CUSTOM_UPTODATE

These four variables allow you to set the marker to be displayed for each of the four states of a local repository branch as compared to its remote upstream branch.

NOTE

There's nothing stopping you from including additional text or other information in any one of these variables. However, their main intent was to display a single glyph-like character. Using anything more than a single character to display information about the status of a branch compared to its upstream counterpart may cause unpredictable behavior and is unsupported.

GIT_PS1_SHOWUPSTREAM_SEPARATOR

If this variable is declared and set to a non-null, non-empty value, the value of this environment variable is used between the ahead/behind information displayed when GIT_PS1_SHOWUPSTREAM is set to a non-empty value. For example, if GIT_PS1_SHOWUPSTREAM_SEPARATOR="|", a diverged branch would display as {bc}<|>{ac}.

GIT_PS1_INITIALCOMMIT

When GIT_PS1_SHOWDIRTYSTATE is set to a non-empty value, this environment variable determines the text that is displayed for a branch which has no commits (i.e. the repository is new). The default text that is displayed if this variable is not declared is '#'.

GIT_PS1_STAGEDCHANGES

When GIT_PS1_SHOWDIRTYSTATE is set to a non-empty value, this environment variable determines the text that is displayed for a branch when that branch has staged changes that need to be committed. The default text that is displayed when there are staged changes in the local repository is '+'.

GIT_PS1_UNSTAGEDCHANGES

When GIT_PS1_SHOWDIRTYSTATE is set to a non-empty value, this environment variable determines the text that is displayed for a branch when that branch has unstaged changes that need to be staged. The default text that is displayed when there are unstaged changes in the local repository is '*'.

GIT_PS1_UNTRACKEDFILES

When GIT_PS1_SHOWUNTRACKEDFILES is set to a non-empty value, this environment variable determines the text that is displayed for a branch when that branch has untracked files. The default text that is displayed when untracked files exist in the local repository is '%'.

GIT_PS1_STASHSTATE

When GIT_PS1_SHOWSTASHSTATE is set to a non-empty value, this environment variable determines the text that is displayed for a repository when that repository has changes which have been stashed. The default text that is displayed when a repository has stashed changes is '$'.

GIT_PS1_SHOWSHORTSHA
When set to 1, this shows the short SHA commit id for the current branch's HEAD according to the format specified in GIT_PS1_SHORTSHA_FORMAT.
GIT_PS1_SHORTSHA_FORMAT
This environment variable allows you to determine how the short SHA commit id for the current branche's HEAD is displayed. The default value is ({s}), e.g. (8e38bf4). Note that {s} reperesents the placeholder for the SHA. So you cannot use {s} in any part of the value of this variable unless you want it to be replaced with the short SHA. You can specify color information in the GIT_PS1_SHORTSHA_COLOR environment variable.
GIT_PS1_BRANCH_FORMAT

This environment variable contains tokens that determines the display order of git branch information in your shell prompt. The table below shows the tokens that this variable supports, and their meaning.

Format Token Description
h If GIT_PS1_SHOWSHORTSHA is set to 1, this token displays the short form of the SHA commit ID of the HEAD ref for the current branch, using the format specified in GIT_PS1_SHORTSHA_FORMAT. The default value of this variable is 0.
b This token is replaced with the current repository's checked out branch name.
s When GIT_PS1_SHOWBRANCHSTATE is set to 1, this token is replaced with the current branch's state information (e.g. (un)staged commits, untracked files, etc.).

The default value of this variable if it is undeclared or empty or null is bs, i.e. show the branch name and the branch state information (if enabled by the value of GIT_PS1_SHOWBRANCHSTATE).

WARNING

Do not use any other text inside this variable other than the tokens listed in the table above. Do not provide any additional formatting in this variable. If you add additional text or formatting to this variable, your prompt likely will not display properly.

GIT_PS1_BRANCHSTATE_FORMAT

When GIT_PS1_SHOWDIRTYSTATE, GIT_PS1_SHOWUNTRACKEDFILES, and/or GIT_PS1_SHOWSTASHSTATE are set to a non-empty value, this environment variable can contain tokens which specify in what order the branch state information for the branch will appear.

If this variable is undeclared, null, or empty, it defaults to "wisu". By default, this results in the following branch information being displayed:

feature/my_special_feature *+$%

The meaning of each of the format tokens is listed in the table below:

Format Token Description
w Causes the string defined in GIT_PS1_UNSTAGEDCHANGES to be displayed when your working index contains unstaged changes.
i Causes the string defined in GIT_PS1_STAGEDCHANGES to be displayed when your index contains staged changes.
s Causes the string defined in GIT_PS1_STASHSTATE to be displayed when your repository contains stashed changesets.
u Causes the string defined in GIT_PS1_UNTRACKEDFILES to be displayed when your working index contains untracked files.

Some notes regarding the use of this variable:

  1. You can place these tokens in any order.
  2. This variable should only contain these tokens and no other text. Any other text included in this variable may result in unpredictable and unsupported behavior.
  3. Any spacing and formatting you require for your desired git repository branch dirty state should be defined through the individual format string variables discussed above and the color format string variables discussed in the following section..
GIT_PS1_SHOWBRANCHSTATE

This environment variable determines when branch state information will be displayed. Valid values are shown in the table below.

Value Description
default If any value is provided for this variable other than those listed in this table, this value applies. When this environment variable is set to default, branch state information is displayed normally (i.e. only when there are (un)staged commits, untracked files, or stashed changesets are the indicators displayed).
always When GIT_PS1_SHOWCOLORHINTS is set to a non-null, non-empty value and one or more of GIT_PS1_SHOWDIRTYSTATE, GIT_PS1_SHOWSTASHSTATE or GIT_PS1_SHOWUNTRACKEDFILES are set to a non-null, non-empty value, the enabled indicators are always shown in the color specified by GIT_PS1_CLEANSTATE_COLOR, which defaults to $(tput setf 7).
GIT_PS1_SHOWSTATE_COUNTS

This environment variable, when set to 1 will show the number of added/deleted files, unstaged changes, and untracked files to the left of the defined branch state indicators.

WARNING

Enabling this option will significantly slow down the display of your prompt after executing commands when inside a git repository. Only enable this option if your repository is small and you really really want to see this information.

Color Format Strings

The following list describes the available color format string environment variables that will allow you to customize how git repository information is colored when displayed via __git_ps1 as extended in this version of git-prompt.sh.

GIT_PS1_DETACHEDHEAD_COLOR
When GIT_PS1_SHOWCOLORHINTS is set to a non-empty value, a detached head will be displayed in the color specified by this environment variable. If this environment variable is undeclared, the default value of $(tput setaf 1) (red) is used.
GIT_PS1_OKBRANCH_COLOR
When GIT_PS1_SHOWCOLORHINTS is set to a non-empty value, a branch which is set to track a valid remote branch will be displayed in the color specified by this environment variable. If this environment variable is undeclared, the default value of $(tput setaf 2) (green) will be used.
GIT_PS1_CLEANSTATE_COLOR

When GIT_PS1_SHOWBRANCHSTATE is set to always, the enabled branch status indicators are displayed in this color. For example, if you have configured GIT_PS1_SHOWDIRTYSTATE to a non-null, non-empty value, then the GIT_PS1_DIRTYSTATE indicator (that is displayed for unstaged commits) will always be shown. The default value of this variable if not declared or null or empty is $(tput setf 7).

This allows, for example, indicators to be shown in a "dimmed" state (when the branch is clean); and then when commits are staged or untracked files exist, the indicator "lights up" according to the color values assigned to the appropriate status indicator color variables.

This color is only used when one of GIT_PS1_NOSTAGEDCHANGES_COLOR, GIT_PS1_NOUNSTAGEDCHANGES_COLOR, GIT_PS1_NOUNTRACKEDFILES_COLOR, or GIT_PS1_NOSTASHSTATE_COLOR are not declared or have a null or empty value.

GIT_PS1_INITIALCOMMIT_COLOR
When GIT_PS1_SHOWDIRTYSTATE and GIT_PS1_SHOWCOLORHINTS are set to a non-empty value, a repository which has no commits (i.e. a new repository) will display the value of GIT_PS1_INITIALCOMMIT next to the branch name using the color specified by this environment variable. If this environment variable is undeclared, the default value of $(tput setaf 2) (green) is used.
GIT_PS1_STAGEDCHANGES_COLOR
When GIT_PS1_SHOWDIRTYSTATE and GIT_PS1_SHOWCOLORHINTS are set to a non-empty value, a repository which has staged changes will display the value of GIT_PS1_STAGEDCHANGES next to the branch name using the color specified by this environment variable. If this environment variable is undeclared, the default value of $(tput setaf 2) (green) is used.
GIT_PS1_NOSTAGEDCHANGES_COLOR
When GIT_PS1_SHOWCOLORHINTS, GIT_PS1_SHOWDIRTYSTATE are declared and have a non-null, non-empty value and GIT_PS1_SHOWBRANCHSTATE is set to always, this color is used to display the GIT_PS1_STAGEDCHANGES indicator when there are no staged changes on the branch.
GIT_PS1_UNSTAGEDCHANGES_COLOR
When GIT_PS1_SHOWDIRTYSTATE and GIT_PS1_SHOWCOLORHINTS are set to a non-empty value, a repository which has unstaged changes will display the value of GIT_PS1_UNSTAGEDCHANGES next to the branch name using the color specified by this environment variable. If this environment variable is undeclared, the default value of $(tput setaf 1) (red) is used.
GIT_PS1_NOUNSTAGEDCHANGES_COLOR
When GIT_PS1_SHOWCOLORHINTS, GIT_PS1_SHOWDIRTYSTATE are declared and have a non-null, non-empty value and GIT_PS1_SHOWBRANCHSTATE is set to always, this color is used to display the GIT_PS1_UNSTAGEDCHANGES indicator when there are no unstaged changes on the branch.
GIT_PS1_UNTRACKEDFILES_COLOR
When GIT_PS1_SHOWUNTRACKEDFILES and GIT_PS1_SHOWCOLORHINTS are set to a non-empty value, a repository which has untracked files will display the value of GIT_PS1_UNTRACKEDFILES next to the branch name using the color specified by this environment variable. If this environment variable is undeclared, the default value of $(tput setaf 1) (red) is used.
GIT_PS1_NOUNTRACKEDFILES_COLOR
When GIT_PS1_SHOWCOLORHINTS, GIT_PS1_SHOWDIRTYSTATE are declared and have a non-null, non-empty value and GIT_PS1_SHOWBRANCHSTATE is set to always, this color is used to display the GIT_PS1_UNTRACKEDFILES indicator when there are no untracked files on the branch.
GIT_PS1_STASHSTATE_COLOR
When GIT_PS1_SHOWSTASHSTATE and GIT_PS1_SHOWCOLORHINTS are set to a non-empty value, a repository which has stashed changes will display the value of GIT_PS1_STASHSTATE next to the branch name using the color specified by this environment variable. If this environment variable is undeclared, the default value of $(tput setaf 4) (blue) is used.
GIT_PS1_NOSTASHSTATE_COLOR
When GIT_PS1_SHOWCOLORHINTS, GIT_PS1_SHOWDIRTYSTATE are declared and have a non-null, non-empty value and GIT_PS1_SHOWBRANCHSTATE is set to always, this color is used to display the GIT_PS1_STASHSTATE indicator when there are no stashed changesets for the repository.
GIT_PS1_SHORTSHA_COLOR
When GIT_PS1_SHOWCOLORHINTS and GIT_PS1_SHOWSHORTSHA are enabled, the color defined in this variable is used when displaying the short SHA in the git branch information. The default value is $(tput setaf 3).

Examples of Shell and/or Git Prompt Customization

In the following sections, several examples of variable values will be shown and the resulting shell prompt output will be demonstrated.

TODO: Add examples here.

Notes

  1. The available "glyphs" that you choose for various parts of the Git string prompt depend on the font you've chosen to use for your terminal window. For example, the font Consolas has a rather limited set of Unicode characters to choose from, while another font such as DejaVu Sans Mono has many Unicode glyphs to choose from.
  2. The modifications made to git-prompt.sh may not be compatable with Z-Shell (zsh). Leave me an issue tracker if you find that to be the case. Better yet, submit a pull request.

Planned, Future Enhancements

  1. Test the modifications in ZSH. They appear that they should work out of the box, but no formal testing has yet been performed.
  2. Create a "build system" that would allow for creating a "theme" that would then generate the required environment variable values and example code which could be placed in your .bashrc.
  3. Create a set of pre-defined "themes".
  4. Look into customizing other git scripts colors (e.g. git status).
    • I find the default red and green colors a bit too dark and saturated for my liking (too hard to see on a black background), which is what spawned these customizations to begin with.
    • I looked through the git config --help documentation, and apparently there are many options that can be set to change the colors output by various scripts; so I won't reinvent the wheel unless I am able to provide customizations above and beyond what the standard tools allow you to do and which will add value and which will not have a significant impact on the amount of time it takes to process the command.
  5. Look into contributing these customizations to Git for Windows. Is there any interest in providing this level of customizability in Git for Windows proper (or perhaps even git itself)??
    • I'm open to comments on this. If there's little to no interest, then I'll just keep these customizations here.

Written with StackEdit.