File: git-info.1

package info (click to toggle)
git-extras 7.3.0-1
  • links: PTS
  • area: main
  • in suites: trixie
  • size: 1,988 kB
  • sloc: sh: 4,235; python: 634; makefile: 146
file content (171 lines) | stat: -rw-r--r-- 3,140 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-INFO" "1" "August 2020" "" "Git Extras"
.
.SH "NAME"
\fBgit\-info\fR \- Returns information on current repository
.
.SH "SYNOPSIS"
\fBgit\-info\fR [\-c|\-\-color] [\-\-no\-config]
.
.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>