【问题标题】:Adding git branch on the Bash command prompt在 Bash 命令提示符下添加 git 分支
【发布时间】:2013-03-30 18:57:09
【问题描述】:

我尝试在 bash 提示符下添加我当前正在处理(签出)的 git 分支,但没有成功。(同时保持显示活动目录/文件的当前路径完整) 我家有一个 .bashrc 文件,但我也看到很多人提到 .profile 文件..

【问题讨论】:

  • 我认为最好在 unix/linux 交流中问这个问题。
  • 我尝试了 10 种不同的方法,其中一些有效,但我得到了 git 分支并丢失了以前的工作目录/路径..
  • Git 1.9.3+ 带来了一种有趣的分支展示方式:见my answer below
  • @cole busby 显然不是。
  • @GeorgeKatsanos 四年确实向我展示了:p

标签: git bash ubuntu


【解决方案1】:

git 1.9.3 或更高版本:使用__git_ps1

Git 提供了一个名为 git-prompt.sh 的 shell 脚本,其中包含一个函数 __git_ps1

打印文本以添加到 bash PS1 提示符(包括分支名称)

它最基本的用法是:

$ __git_ps1
(master)

它还需要一个可选的格式字符串:

$ __git_ps1 'git:[%s]'
git:[master]

如何获得

首先,将文件复制到某个地方(例如~/.git-prompt.sh)。

选项 1:使用文件系统上的现有副本。示例(Mac OS X 10.15):

$ find / -name 'git-prompt.sh' -type f -print -quit 2>/dev/null
/Library/Developer/CommandLineTools/usr/share/git-core/git-prompt.sh

选项2:拉取脚本from GitHub

接下来,将以下行添加到您的.bashrc/.zshrc

source ~/.git-prompt.sh

最后,将您的PS1 更改为调用__git_ps1 作为命令替代:

重击:

PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '

Zsh:

setopt PROMPT_SUBST ; PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ '

git

但请注意,只有 git 1.9.3(2014 年 5 月)or later 允许您安全地显示该分支名称(!)

commit 8976500Richard Hansen (richardhansen)

bash 和 zsh 都对 PS1 的值进行参数扩展命令替换和算术扩展。

而不是在PS1 中包含原始的未转义分支名称 三参数模式,构造PS1 引用一个保存分支名称的变量。

由于 shell 不会递归扩展,这避免了通过特制分支名称(例如

)执行任意代码
'$(IFS=_;cmd=sudo_rm_-rf_/;$cmd)'.

什么狡猾的头脑会这样命名一个分支? ;) (Beside a Mom as in xkcd)

更多示例

still_dreaming_1 举报in the comments

如果您想要带有xterm(在我的.bashrc 中)的颜色提示,这似乎很有效:

PS1='\[\e]0;\u@\h: \w\a\]\n${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\03‌​3[01;34m\]\w\[\033[00m\]$(__git_ps1)\$ ' 

一切都是不同的颜色,包括树枝。

在 Linux Mint 17.3 Cinnamon 64 位中:

PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[01;34m\] \w\[\033[00m\]$(__git_ps1) \$ ' 

【讨论】:

  • 当你实际在 git repo 中时,如何将提示设置为当前 git 分支。因此,如果您在正常目录中,它会显示正常提示。
  • @still_dreaming_1 你可以很容易地升级或编译 git:stackoverflow.com/a/24847953/6309
  • 如果你想用 xterm(在 .bashrc 中)为颜色提示添加颜色,这似乎很有效:PS1='\[\e]0;\u@\h: \w\a\]\n${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]$(__git_ps1)\$' 一切都是不同的颜色,包括分支。
  • 我发布的 PS1 在 Linux Mint 17.3 Cinnamon 64 位中不再正确显示,但确实如此:PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[01;34m\] \w\[\033[00m\]$(__git_ps1) \$ '
  • 当前主人在github.com/git/git/blob/master/contrib/completion/git-prompt.sh - 我认为我们应该在答案中链接到那个,以防将来发现漏洞?另外:我不得不在我的 PS1 行中转义 $ 和 ",但这可能是由于它的复杂性。
【解决方案2】:

按照以下步骤操作:(Linux)

编辑文件~/.bashrc,在其末尾输入以下行(如果是Mac,文件将是~/.bash_profile

# Git branch in prompt.
parse_git_branch() {
    git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
}
export PS1="\u@\h \W\[\033[32m\]\$(parse_git_branch)\[\033[00m\] $ "

现在,启动新的终端窗口,并尝试进入任何 git-repo。将显示当前分支,并带有提示。

4 More Info - MAC/Linux

【讨论】:

  • 我认为没有必要在 OSX 上更改 ~/.bash_profile 而不是 ~/.bashrc。
  • 对于颜色,请考虑在上面的 parse_git_branch 中将“git 分支”更改为“git -c color.ui=always 分支”。它与 git branch 用于突出显示当前分支的颜色相同。
  • 受您的启发,但我喜欢我的工作目录是带有蓝色突出显示的完整路径 (\w)。示例:gist.github.com/rmharrison/1885ef6bbb0226eb7b42e2135d5eeca2
  • 对于 MAC,我必须在 $(parse_git_branch) 之前消除转义才能使其正常工作:PS1="\u@\h \W\[\033[32m\]$(parse_git_branch)\[\033[00m\] $ "。虽然我也没有在 PS1 前使用“导出”。
【解决方案3】:

1- 如果你没有 bash-completion ...:sudo apt-get install bash-completion

2- 编辑您的 .bashrc 文件并检查(或添加):

if [ -f /etc/bash_completion ]; then
  . /etc/bash_completion
fi

3- ... 在提示行之前:export PS1='$(__git_ps1) \w\$ '
__git_ps1 会显示你的 git 分支)

4- 做source .bashrc

编辑:

进一步阅读:Don’t Reinvent the Wheel

【讨论】:

  • 这似乎是我使用宅基地/流浪机器的唯一方法
  • 在 ubuntu 16.04 中运行良好
  • “不要重新发明轮子”链接已损坏。
  • @TaylorR 我已恢复链接。
【解决方案4】:

这是我如何配置提示以显示 Git 状态:

获取 git-prompt 脚本:

curl -o ~/.git-prompt.sh https://raw.githubusercontent.com/git/git/master/contrib/completion/git-prompt.sh

并自定义您的提示,在您的 .bashrc 文件中添加以下代码:

# Load Git functions
source ~/.git-prompt.sh

# Syntactic sugar for ANSI escape sequences
txtblk='\e[0;30m' # Black - Regular
txtred='\e[0;31m' # Red
txtgrn='\e[0;32m' # Green
txtylw='\e[0;33m' # Yellow
txtblu='\e[0;34m' # Blue
txtpur='\e[0;35m' # Purple
txtcyn='\e[0;36m' # Cyan
txtwht='\e[0;37m' # White
bldblk='\e[1;30m' # Black - Bold
bldred='\e[1;31m' # Red
bldgrn='\e[1;32m' # Green
bldylw='\e[1;33m' # Yellow
bldblu='\e[1;34m' # Blue
bldpur='\e[1;35m' # Purple
bldcyn='\e[1;36m' # Cyan
bldwht='\e[1;37m' # White
unkblk='\e[4;30m' # Black - Underline
undred='\e[4;31m' # Red
undgrn='\e[4;32m' # Green
undylw='\e[4;33m' # Yellow
undblu='\e[4;34m' # Blue
undpur='\e[4;35m' # Purple
undcyn='\e[4;36m' # Cyan
undwht='\e[4;37m' # White
bakblk='\e[40m'   # Black - Background
bakred='\e[41m'   # Red
badgrn='\e[42m'   # Green
bakylw='\e[43m'   # Yellow
bakblu='\e[44m'   # Blue
bakpur='\e[45m'   # Purple
bakcyn='\e[46m'   # Cyan
bakwht='\e[47m'   # White
txtrst='\e[0m'    # Text Reset

# Prompt variables
PROMPT_BEFORE="$txtcyn\u@\h $txtwht\w$txtrst"
PROMPT_AFTER="\\n\\\$ "

# Prompt command
PROMPT_COMMAND='__git_ps1 "$PROMPT_BEFORE" "$PROMPT_AFTER"'

# Git prompt features (read ~/.git-prompt.sh for reference)
export GIT_PS1_SHOWDIRTYSTATE="true"
export GIT_PS1_SHOWSTASHSTATE="true"
export GIT_PS1_SHOWUNTRACKEDFILES="true"
export GIT_PS1_SHOWUPSTREAM="auto"
export GIT_PS1_SHOWCOLORHINTS="true"

如果你想了解更多,你可以在这里获取所有的点文件:https://github.com/jamming/dotfiles

【讨论】:

  • 迄今为止的最佳答案。
  • @Hesam 您可以更改PROMPT_BEFORE 环境变量并删除$txtwht\w 我不知道,但我想它可以解决问题
  • 它在我的 Mac 上工作,但显示的分支名称如 (master *$%=)
  • 那些符号类似于分支的状态,即:$ 表示有隐藏的更改,= 表示最新的提交被推送到远程跟踪的分支
【解决方案5】:

对于 mac,这非常有效:http://martinfitzpatrick.name/article/add-git-branch-name-to-terminal-prompt-mac/:

# Git branch in prompt.
parse_git_branch() {
    git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
}

export PS1="\u@\h \W\[\033[32m\]\$(parse_git_branch)\[\033[00m\] $ "

【讨论】:

    【解决方案6】:

    首先,在您的主目录中打开您的 Bash 配置文件。使用默认编辑器打开和编辑 bash_profile 的最简单方法。

    例如,我使用 VS Code 使用以下命令打开它:code .bash_profile。

    然后只需将以下代码粘贴到您的 Bash。

    parse_git_branch() {
         git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
    }
    
    export PS1="\u@\h \W\[\033[32m\]\$(parse_git_branch)\[\033[00m\] $ "
    

    功能

    parse_git_branch()

    将获取分支名称,然后通过 PS1 您可以在终端中显示它。

    这里,

    \u = 用户名

    @ = 静态文本

    \h = 计算机名称

    \w = 当前目录

    $ = 静态文本

    您可以更改或删除这些变量以进行更多自定义。


    如果你是第一次在终端使用 Git,或者在配置后立即使用 Git,有时可能看不到分支名称。

    如果您遇到此问题,请不要担心。在这种情况下,只需创建一个示例存储库并在进行一些更改后提交它。当 commit 命令执行一次时,终端会从那时开始找到 git branch。


    【讨论】:

      【解决方案7】:
      root:~/project#  -> root:~/project(dev)# 
      

      将以下代码添加到 ~/.bashrc 的末尾

      force_color_prompt=yes
      color_prompt=yes
      parse_git_branch() {
      git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/(\1)/'
      }
      if [ "$color_prompt" = yes ]; then
      PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[01;31m\]$(parse_git_branch)\[\033[00m\]\$ '
      else
      PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w$(parse_git_branch)\$ '
      fi
      unset color_prompt force_color_prompt
      

      【讨论】:

        【解决方案8】:
        vim ~/.bash
        
        parse_git_branch() {
             git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
        }
        
        export PS1="\u@\h \[\033[32m\]\w\[\033[33m\]\$(parse_git_branch)\[\033[00m\] $"
        

        要反映最新的更改,请运行以下命令

        source ~/.bashrc
        

        输出:-

        chandrakant@NDL41104 ~/Chandrakant/CodeBase/LaravelApp (development) $
        

        【讨论】:

          【解决方案9】:

          如果您使用fish shell,它非常简单。 fish 是一个带有很多好东西的交互式 shell。您可以使用apt-get 安装它。

          sudo apt-get install fish
          

          然后您可以使用更改提示设置

          > fish_config 
          Web config started at 'http://localhost:8001/'. Hit enter to stop.
          Created new window in existing browser session.
          

          现在去http://localhost:8001/ 打开提示选项卡并选择经典+ git选项

          现在点击使用提示按钮,你就设置好了。

          【讨论】:

            【解决方案10】:
            parse_git_branch() {
                git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
            }
            export PS1='\[\e]0;\w\a\]\n\[\e[32m\]\u@\h \[\e[33m\]\w\[\e[0m\]$(parse_git_branch)\n\$ '
            

            【讨论】:

            • Eww,真的不要把裸终端逃生放在那里;像任何理智的人一样使用tput
            【解决方案11】:

            按照以下步骤在 ubuntu 终端中显示您的 GIT 存储库的分支名称:

            第一步: 打开终端并使用以下命令编辑 .bashrc。

            vi .bashrc

            第2步:在.bashrc文件末尾添加以下行:

            parse_git_branch() {
            git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/' }
            

            export PS1="\u@\h \W\[\033[32m\]\$(parse_git_branch)\[\033[00m\] $ "

            第 3 步: 源 .bashrc 在根(主)目录中执行以下操作:

            /根文件夹:~$source .bashrc

            第四步:重启并打开终端,查看cmd。导航到您的 GIt 存储库目录路径,您就完成了。 :)

            【讨论】:

              【解决方案12】:

              这是我使用的一个简单干净的版本:link

              【讨论】:

                【解决方案13】:

                我想要一个干净的解决方案,附加到现有提示而不是替换它。与其他解决方案一样,将其添加到 .bashrc 的底部

                # function
                parse_git_branch() {
                  if [ -n "$(git rev-parse --git-dir 2> /dev/null)" ]; then
                    echo "($(git rev-parse --abbrev-ref HEAD)) "
                  fi
                }
                
                # environment customization
                export PS1="$PS1\$(parse_git_branch)"
                

                典型的设置会产生类似于

                的提示

                user@machine:/path/to/git/project$ (branch-name)

                【讨论】:

                  【解决方案14】:

                  我在 python 中尝试了一个放在 bin 文件夹中的小脚本...... 'gitprompt' 文件

                  #!/usr/bin/env python
                  import subprocess, os
                  s = os.path.join(os.getcwd(), '.git')
                  def cut(cmd):
                      ret=''
                      half=0
                      record = False
                      for c in cmd:
                          if c == "\n":
                              if not (record):
                                  pass
                              else:
                                  break
                          if (record) and c!="\n":
                              ret = ret + c
                          if c=='*':
                              half=0.5
                          if c==' ':
                              if half == 0.5:
                                  half = 1
                          if half == 1:
                              record = True
                      return ret
                  if (os.path.isdir(s)):
                      out = subprocess.check_output("git branch",shell=True)
                      print cut(out)
                  else:
                      print "-"
                  

                  使其可执行和东西

                  然后相应地调整 bash 提示符:

                  \u:\w--[$(gitprompt)] \$ 
                  

                  【讨论】:

                    猜你喜欢
                    • 1970-01-01
                    • 1970-01-01
                    • 2020-12-16
                    • 2017-07-31
                    • 2015-06-18
                    • 2010-10-23
                    • 2016-05-19
                    • 2017-05-25
                    • 2017-08-23
                    相关资源
                    最近更新 更多