Git branch command behaves like 'less'

Question

When I use the git branch command to list all branches, I see the output of git branch | less.

The command git branch is supposed to show a list of branches, like ls does for files.

This is the output I get:

How do I get the default behaviour of git branch? What causes the paged output?

I am using ZSH with oh_my_zsh (nothing for Git in there), and my .gitconfig looks like this:

[user]
  email = myemail@mail.com
  name = Dennis Haegler
[push]
  default = simple
[merge]
   tool = vimdiff
[core]
  editor = nvim
  excludesfile = /Users/dennish/.gitignore_global
[color]
  ui = true
[alias]
  br = branch
  ci = commit -v
  cam = commit -am
  co = checkout
  df = diff
  st = status
  sa = stash
  mt = mergetool
  cp = cherry-pick
  pl = pull --rebase
[difftool "sourcetree"]
  cmd = opendiff \"$LOCAL\" \"$REMOTE\"
[mergetool "sourcetree"]
  cmd = /Applications/SourceTree.app/Contents/Resources/opendiff-w.sh 
  \"$LOCAL\" \"$REMOTE\" -ancestor \"$BASE\" -merge \"$MERGED\"
  trustExitCode = true

score 953 · Accepted Answer · edited Oct 27 '19 at 20:41

953

As mentioned in comments to Mark Adelsberger's answer, this was a default behavior change introduced in Git 2.16.

You can turn paged output for git branch back off by default with the pager.branch config setting:

git config --global pager.branch false

edited Oct 27 '19 at 20:41

Peter Mortensen

28,342
21
95
123

answered Jan 21 '18 at 18:30

Zach Schneider

9,739
1
11
6

183

That is an odd, odd decision to make default. I expect my unix-y cli tools to behave like dumb simple programs that you can chain if you want to, but I guess that discussion is for another site. – Stragulus Apr 06 '18 at 17:56
10

@Stragulus Note that the new default doesn’t stop you from chaining `git branch` with something else. Using [pipe detection](https://stackoverflow.com/q/911168/578288), Git will output the branch list to stdout within the commands `git branch > branches.txt` or `git branch | wc -l`. – Rory O'Kane Jun 14 '18 at 15:28
4

@RoryO'Kane but with pager, I have a type an extra `ESC/q` after a simple `git branch` check. – mitnk Oct 17 '18 at 03:09
26

@mitnk Not necessarily. If your pager is `less`, you can add `--no-init --quit-if-one-screen` to your `LESS` environment variable, which will cause `less` to just write to stdout if the text can be viewed without scrolling. See [`man less`](https://linux.die.net/man/1/less) for more details. – Rory O'Kane Oct 17 '18 at 07:38
13

If you want to add it into your config file manually, it's `[pager] branch = false` (on two lines). – Sam Oct 23 '18 at 10:56
@Sam's tip works the same for paginated results for `git diff`, `git stash` etc. for anybody having this issue with those commands. Just add any variation of `stash = false` under a header of `[pager]` in your .gitconfig file. – Peemster May 29 '19 at 19:22
I use the following command to list remote branches using a pattern `git branch --list "*" -r | tr -d " *"` – David Douglas Jun 04 '19 at 11:04
3

In response to @RoryO'Kane's comment, you may want to do `export LESS = "--no-init --quit-if-one-screen -R"` (with -R) in your .zshrc, .bash_profile, etc., to honor raw color control characters. Otherwise, your git log will suffer. – joseph Aug 07 '19 at 17:29
Setting `git config --global pager.branch 'less --quit-if-one-screen -R'` with a version of less >= 530 works great! – johankj Nov 26 '19 at 09:40
2

`git config --global core.pager ''` Will turn of the pager on all git commands – Fractalf Feb 07 '20 at 20:04
Are you really sure? The behaviour shows up only under zsh, but not bash. I happen to have both shells installed. – Yongwei Wu Mar 03 '20 at 01:11
3

I hate when default behavior is changed leaving you to figure out how to revert it, and specifically I hate this behavior of git branch :/ – Andre Nickatina Mar 05 '20 at 18:43
Works also with tag subcommand: `git config --global pager.tag false`. – gsscoder Apr 08 '20 at 09:46
Some of the other answers give a reason as to why this behaviour differs between zsh and bash, and a better solution too (e.g. https://stackoverflow.com/a/60498979/1836776) – Marc Durdin Nov 23 '20 at 00:14

score 72 · Answer 2 · edited Oct 27 '19 at 20:36

As other answers pointed out, Git defaults to piping itself into a pager (less by default) for most commands.

An important point, though, is that when the LESS environment variable is unset, Git sets it to FRX, and the consequence is that the user-visible behavior is the same as if the pager was not used when the command's output is short (i.e. if you have only few branches). See man less:

-F or --quit-if-one-screen
Causes less to automatically exit if the entire file can be displayed on the first screen.

-R or --RAW-CONTROL-CHARS
[...]ANSI "color" escape sequences are output in "raw" form.

-X or --no-init
Disables sending the termcap initialization and deinitialization strings to the terminal. This is sometimes desirable if the deinitialization string does something unnecessary, like clearing the screen.

If you get the behavior you describe, you most likely have $LESS set to something else, and unsetting it (unset LESS) would get rid of the issue while keeping the "pager" behavior for long output. Alternatively, you can activate the behavior for while keeping $LESS as-is by adding this to your .gitconfig file:

[core]
    pager = less -FRX

If you really dislike the pager thing, you can deactivate it globally or on a per-command basis (see other answers).

I had `pager = less -FR` as the option `X` seems to be disabling the mouse scrolling. — zyy, Nov 23 '20 at 18:36

score 56 · Answer 3 · edited Oct 27 '19 at 20:34

56

Not to argue semantics, but the behavior you're getting is the default. That's why you get it when you don't ask for something different. By default, branch (and numerous other Git commands) use a pager when sending output to the terminal.

You can override this default by using the --no-pager option:

git --no-pager branch

Or if you redirect the output to a file, Git should detect that it isn't writing to a terminal and so should not use a pager anyway. (On the other hand, that suggests a scripting use case, in which case you should consider using a plumbing command like git for-each-ref in preference to git branch.)

edited Oct 27 '19 at 20:34

Peter Mortensen

28,342
21
95
123

answered Jan 19 '18 at 13:33

Mark Adelsberger

32,904
2
24
41

`git --no-pager branch` works. But how is this set? Only the `PAGER` environment variable is set to `less`. This is not the default behaviour. All of my colleges have an output as a list printed out to the terminal. – DenniJensen Jan 19 '18 at 13:41
Which version of git are you using? And which one are your colleagues using? – Lasse V. Karlsen Jan 19 '18 at 13:45
2.16.0! Is this a feature introduced to git in this version? – DenniJensen Jan 19 '18 at 13:51
Yeah it is default now. https://github.com/git/git/blob/master/Documentation/RelNotes/2.16.0.txt#L85 My college next to me using the same version and does not have this issue :) thx @mark – DenniJensen Jan 19 '18 at 13:55
See my answer: it's not really the default. If you (or your distro) did not set `$LESS`, you get a different behavior because Git sets it for you. – Matthieu Moy Apr 16 '18 at 16:33
3

This is the most superior answer here, sad that it has so few upvotes, because I scrolled quite a bit to find this masterpiece. – codepleb Sep 05 '19 at 06:15
Are you really sure? The behaviour shows up only under zsh, but not bash. I happen to have both shells installed. – Yongwei Wu Mar 03 '20 at 01:12
`git --no-pager branch` seems best to me, so it helps you to remember the `--no-pager` option and can do both easily. When looking at remotes e.g. with `git branch -a`, the list of branches can easily fill the screen, so paging is preferable, but when looking at your local branches, there often won't be so many, and you may want to list them on the command line so that you can remind yourself what branches you have and then do e.g. `git checkout `. – drkvogel Mar 31 '21 at 12:05

score 38 · Answer 4 · edited Oct 27 '19 at 20:42

38

This Git behaviour was more and more annoying for me, too. I got my tag list in less when just wanting to list tags for example.

One can control this behaviour also by changing the default Git PAGER to cat instead of less. I'd rather scroll in iTerm than in an editor. I like to use the editor when I want.

So:

git config --global core.pager cat

edited Oct 27 '19 at 20:42

Peter Mortensen

28,342
21
95
123

answered Jan 14 '19 at 10:44

ionescu77

740
9
14

4

Yeah this should be a valid answer for me – Tura May 07 '19 at 03:25
2

thanks for the heads-up. I admit after a couple of months usage, I am still using cat, but for example when doing `git log` it is annoying. I just miss the original behaviour, but did not have time to improve my daily workflow in this pespective. – ionescu77 May 07 '19 at 09:52
You win!... Perfect! – sdlins Jun 22 '19 at 02:05
1

There is yet another solution that binds features from both words: `cat` and `less`: it's [`bat`](https://github.com/sharkdp/bat) *A cat(1) clone with wings*. A tiny summary: for short output (fits on one screen) it behaves like `cat`, and like `less` for long outputs (to large output for one screen). To me, it's *almost* a perfrect solution. – mi6th Aug 30 '20 at 12:29
This would be ideal. Interesting, did not know about `bat`, it's not on my mac bin, I see there's a link to the github bat project. I'll have a look. Thx. – ionescu77 Aug 31 '20 at 08:42

score 31 · Answer 5 · answered Mar 03 '20 at 01:47

31

The accepted answer seems wrong. There are two problems:

The behaviour is actually different between (default configured) bash and zsh. The ‘problem’ shows up only under zsh.
The suggested solution will make git branch not use a pager always, which will not be desired when there is a lot of output.

The real reason is that bash and zsh have different default definitions about LESS: bash defines nothing, while zsh defines it to -R. When I do unset LESS in zsh, everything goes back to normal....

The -R behaviour may still be desired. In that case, you can add the following instruction to your .zshrc to keep everything working:

export LESS=-FRX

-F ‘causes less to automatically exit if the entire file can be displayed on the first screen’. However, -X needs to be specified simultaneously, otherwise no output will be shown when there is less than a screenful of output.

answered Mar 03 '20 at 01:47

Yongwei Wu

3,650
30
42

1

I wish I could hit the Up Vote more than once. Thank You – GDR Sep 16 '20 at 17:01
This isn't true -- the behaviour shows up under most Linux variants when the LESS environment variable is set. zsh isn't special in this regard (or any other). – Software Engineer Jan 31 '21 at 12:25
@SoftwareEngineer What is not true? I said exactly that what mattered was whether LESS was set: ‘bash defines nothing, while zsh defines it to `-R`. When I do `unset LESS` in zsh, everything goes back to normal....’ As to whether this happens, it is that defaultly-configured bash does not define LESS, while defaultly-configured oh-my-zsh defines LESS. I know this because I had exactly the same oh-my-zsh environment in macOS (just like the asker), and I encountered exactly the same problem. – Yongwei Wu Feb 01 '21 at 15:22
In 1, you said that the behaviour only shows up in zsh. As I said, that's not true. The env var is set to -R in my ubuntu-bash too, so not just zsh. In 2, you implied that outputting to sdtout is not desirable when there is lots of output; also wrong. In my automated environments, paging is *never* desirable, no matter the length of the results. Given that automation is a large portion of operations these days I'd say that the stdout behaviour is highly desirable in a lot of cases, and 'maybe' less so for manual diagnostics and legacy work. So, this is wrong. The original answer is right. – Software Engineer Feb 01 '21 at 15:58
@SoftwareEngineer You completely failed to notice that the original question was asked about the behaviour under macOS (other systems, of course, may have different default behaviour). Take a closer look at the paths. — Your comment about the automated environments does not make sense as well, because paging is only enabled automatically in a TTY, but not when the output is redirected. – Yongwei Wu Feb 03 '21 at 02:16
Thanks a lot! Doing cmd+f in the VSCode terminal to search for branch names wasn't working for me but adding `export LESS=-FRX` in my .zshrc fixed it! – Genesis Algorithms Feb 12 '21 at 19:03
can confirm `-X` flag being required to get `-F` to work properly in zsh/Big Sur – worc May 04 '21 at 16:20

Imran Ahmad · Answer 6 · 2020-09-18T06:05:10.700

15

Git branch command behaves like 'less'

Because Git by default opens the output in pager (at least in Ubuntu). The accepted answer will completely replace pager, which you may not like if your git command output is very long.

I would recommend replacing the pager with less, so it doesn't "scroll" outputs less than the height of the terminal.

git config --global --replace-all core.pager "less -F -X"

edited Sep 18 '20 at 06:05

answered Mar 28 '19 at 11:00

Imran Ahmad

5,684
3
32
43

score 12 · Answer 7 · answered Oct 31 '18 at 21:12

12

For those that want to update their ~/.gitconfig to fix this, it would look like this:

[pager]
   branch = false

answered Oct 31 '18 at 21:12

Nick

8,822
6
41
65

strange thing here: this setting was working and since some days it's not anymore, did anything change or Is my config just not being applied? – Ahmed Hasn. Mar 04 '19 at 21:04
@ConquerorsHaki This solution is working for me with git v2.17.1 Try `git config --list --show-origin` to debug what settings are/aren't set for you/your system and from where (https://stackoverflow.com/q/12254076/1590950). – indivisible Jun 16 '20 at 19:00

score 3 · Answer 8 · edited Jan 10 '19 at 14:05

3

Do the following:

[alias]
  br = !git --no-pager branch

edited Jan 10 '19 at 14:05

Peter

7,458
6
48
87

answered Jan 10 '19 at 11:47

João Tiago

39
1

C-Otto · Answer 9 · 2018-10-10T07:15:49.970

0

https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables

GIT_PAGER controls the program used to display multi-page output on the command line. If this is unset, PAGER will be used as a fallback.

To solve your issue, you could unset PAGER and GIT_PAGER in your shell.

edited Oct 10 '18 at 07:15

answered Jan 19 '18 at 13:13

C-Otto

4,941
3
25
60

1

Unset `PAGER` (`GIT_PAGER` was unset) issue is still there. Are there any location I have to check this env vars? – DenniJensen Jan 19 '18 at 13:24
@DenniJensen You can set the pager on the command like `PAGER= git branch` (with one space after and none before the equals sign exactly like written). No idea, whether it's any better than e.g., `git branch | cat`. – maaartinus Jan 07 '20 at 12:26

Git branch command behaves like 'less'

9 Answers9

Linked

Related