This repository has been archived by the owner on Mar 3, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 142
/
ghi.1
133 lines (132 loc) · 3.24 KB
/
ghi.1
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
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GHI" "1" "April 2012" "Stephen Celis" "GHI Manual"
.
.SH "NAME"
\fBghi\fR \- the stupid issue tracker
.
.SH "SYNOPSIS"
\fBghi\fR [\fB\-\-version\fR] [\fB\-p\fR|\fB\-\-paginate\fR|\fB\-\-no\-pager\fR] [\fB\-\-help\fR] \fIcommand\fR [\fIargs\fR]
.
.br
\fB\fR \fB\fR \fB\fR \fB\fR [ \fB\-\-\fR [\fIuser\fR/]\fIrepo\fR]]
.
.SH "DESCRIPTION"
GHI is the alphabetical acronym for GitHub Issues\. GHI provides an easy way to manage your issues from the comfort of the command line and your editor of choice\.
.
.P
GHI should look familiar if you\'re familiar with Git\. When invoked from a repository directory with a GitHub remote, GHI will default to work with the repository\'s issues\. Otherwise, GHI will work with your global issues or with a repository terminating its arguments\.
.
.P
The \fIcommand\fR is either the name of a GHI command (see below) or an alias\.
.
.SH "OPTIONS"
.
.TP
\fB\-\-version\fR
Prints the GHI version number\.
.
.TP
\fB\-\-help\fR
Prints the synopsis and a list of commonly\-used commands\. If a GHI command is named, this option will bring up the manual page for that command\.
.
.IP
See \fBghi\-help\fR(1) for more information\.
.
.TP
\fB\-p\fR, \fB\-\-paginate\fR
Pipe all output into less if standard output is a terminal\.
.
.TP
\fB\-\-no\-pager\fR
Do not pipe output into a pager\.
.
.TP
\fB\-\-[no\-]color\fR
Toggle colorized output\.
.
.SH "GHI COMMANDS"
.
.TP
\fBghi\-assign\fR(1)
Assign an issue to yourself (or someone else)\.
.
.TP
\fBghi\-close\fR(1)
Close an issue\.
.
.TP
\fBghi\-comment\fR(1)
Leave a comment on an issue\.
.
.TP
\fBghi\-config\fR(1)
Configure GHI\.
.
.TP
\fBghi\-edit\fR(1)
Modify an existing issue\.
.
.TP
\fBghi\-label\fR(1)
Create, list, modify, or delete labels\.
.
.TP
\fBghi\-list\fR(1)
List your issues (or a repository\'s)\.
.
.TP
\fBghi\-milestone\fR(1)
Manage project milestones\.
.
.TP
\fBghi\-open\fR(1)
Open (or reopen) an issue\.
.
.TP
\fBghi\-show\fR(1)
Show an issue\'s details\.
.
.SH "ENVIRONMENT VARIABLES"
Various GHI commands use the following environment variables:
.
.TP
\fIGHI_REPO\fR
The GitHub repository to be used by the issued GHI command\.
.
.TP
\fIGHI_TOKEN\fR
The OAuth access token used to authenticate you\.
.
.TP
\fIGHI_PAGER\fR
This environment variable overrides \fI$GIT_PAGER\fR and \fI$PAGER\fR\. If it is set to an empty string or to the value "cat", git will not launch a pager\.
.
.TP
\fIGHI_EDITOR\fR
This environment variable overrides \fI$GIT_EDITOR\fR, \fI$VISUAL\fR, and \fI$EDITOR\fR\.
.
.TP
\fIGITHUB_USER\fR
Your GitHub username: used to authenticate and identify you\.
.
.TP
\fIGITHUB_PASSWORD\fR
If you store your GitHub password in an environment variable, GHI will automatically attempt to fetch an access token using it\.
.
.P
All environment variables may also be stored in Git configuration files where the variable is in lowercase form and the underscore is a period (e\.g\., \fI$GHI_REPO\fR would become the ghi\.repo option)\.
.
.SH "AUTHORS"
GHI is maintained by Stephen Celis\. A full list of contributors can be found at \fIhttps://github\.com/stephencelis/ghi/contributors\fR\.
.
.SH "REPORTING BUGS"
.
.nf
ghi open \-\- stephencelis/ghi
.
.fi
.
.P
Or visit \fIhttps://github\.com/stephencelis/ghi/issues\fR\.