.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-INFO" "1" "November 2023" "" "Git Extras"
.SH "NAME"
\fBgit\-info\fR \- Returns information on current repository
.SH "SYNOPSIS"
.TS
allbox;
\fBgit\-info\fR [\-c	\-\-color] [\-\-no\-config]
.TE
.SH "DESCRIPTION"
Shows the following information about a repository:
.IP "1." 4
Remote Url(s)
.IP "2." 4
Remote Branches
.IP "3." 4
Local Branches
.IP "4." 4
Submodule(s) (if present)
.IP "5." 4
Most recent commit
.IP "6." 4
Configuration Info
.IP "" 0
.SH "OPTIONS"
\-c, \-\-color
.P
Use color for information titles\.
.P
\-\-no\-config
.P
Don't show list all variables set in config file, along with their values\.
.SH "GIT CONFIGS"
You could customize the Most recent commit and Configuration Info format via git config options
.IP "" 4
.nf
$ git config \-\-global \-\-add git\-extras\.info\.log "<log\-command>"
.fi
.IP "" 0
.P
the default \fIlog\-command\fR is "git log \-\-max\-count=1 \-\-pretty=short"
.IP "" 4
.nf
$ git config \-\-global \-\-add git\-extras\.info\.config\-grep "<config\-grep\-command>"
.fi
.IP "" 0
.P
the default \fIconfig\-grep\-command\fR is "git config \-\-list"
.P
For example,
.P
to set global configuration to show last commit subject, without sha1
.IP "" 4
.nf
 $ git config \-\-global \-\-add git\-extras\.info\.log "git log \-\-max\-count=1 \-\-format=\e"Author: %an%nDate:   %ad (%ar)%n%n    %s\e" \-\-date=format:\e"%Y\-%m\-%d %a %H:%M\e""
.fi
.IP "" 0
.P
to set global configuration to show user's name and email
.IP "" 4
.nf
 $ git config \-\-global \-\-add git\-extras\.info\.config\-grep "git config \-\-list | grep \-\-color=never \-E \e"^user\.name|^user\.email\e""
.fi
.IP "" 0
.SH "EXAMPLES"
Outputs info about a repo:
.IP "" 4
.nf
$ git info

## Remote URLs:

origin		git@github\.com:sampleAuthor/git\-extras\.git (fetch)
origin		git@github\.com:sampleAuthor/git\-extras\.git (push)

## Remote Branches:

origin/HEAD \-> origin/master
origin/myBranch

## Local Branches:

myBranch
* master

## Submodule(s):

  a234567 path2submodule1/submodule1 (branch/tag)
+ b234567 path2submodule2/submodule2 (branch/tag)
\- c234567 path2submodule3/submodule3 (branch/tag)
  e234567 path2submodule4/submodule4 (branch/tag)

## Most Recent Commit:

commit e3952df2c172c6f3eb533d8d0b1a6c77250769a7
Author: Sample Author <sampleAuthor@gmail\.com>

Added git\-info command\.

## Configuration (\.git/config):

color\.diff=auto
color\.status=auto
color\.branch=auto
user\.name=Sample Author
user\.email=sampleAuthor@gmail\.com
core\.repositoryformatversion=0
core\.filemode=true
core\.bare=false
core\.logallrefupdates=true
core\.ignorecase=true
remote\.origin\.fetch=+refs/heads/*:refs/remotes/origin/*
remote\.origin\.url=git@github\.com:mub/git\-extras\.git
branch\.master\.remote=origin
branch\.master\.merge=refs/heads/master
.fi
.IP "" 0
.SH "AUTHOR"
Written by Leila Muhtasib <\fImuhtasib@gmail\.com\fR>
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>