Programmatically check if HEAD is detached?

user_5958455 0
Viewed 2841

I want to know whether I'm in a "HEAD detached" state in a script.

Currently I parse the output of git status but I dislike doing so because I've heard that it's a bad practice to parse Git output that's meant for human - I want a program-friendly interface to tell me whether HEAD is detached. I also don't want to manually look into .git/HEAD or parse git description or git branch.

Any ideas?

git-detached-head git
4 Answers

The easiest command is probably:

$ git symbolic-ref -q HEAD

and check the exit status: 0 means normal; 1 is detached.

From the docs of git-symbolic-ref:

-q, --quiet
   Do not issue an error message if the <name> is not a symbolic ref
   but a detached HEAD; instead exit with non-zero status silently.
user_8658740

Programmatically you need to a wrapper for Git protocol.

For example, by GitPython you're able to find out the repo detached or not repo.head.is_detached

user_31470460

Use git branch to find a detached HEAD...

$ git branch -q
* (HEAD detached at c61a6d2)
  master
user_6673010

From git 2.22, you can also use:

git branch --show-current

This prints nothing when not on a branch.

user_2370620
Related