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
|
Metadata-Version: 1.0
Name: github-cli
Version: 1.0.0
Summary: A command-line interface to the GitHub Issues API v2.
Home-page: http://packages.python.org/github-cli
Author: Sander Smits
Author-email: jhmsmits@gmail.com
License: BSD
Description: =============================================
GitHub Issues API v2 - command-line interface
=============================================
about
*****
`github-cli <http://packages.python.org/github-cli/>`_ provides an
executable called ``ghi``, that can be used to access all of `GitHub
<https://github.com/>`_'s documented `Issues API
<http://develop.github.com/p/issues.html>`_ (v2) functionality from your
command-line
github-cli is written in `Python <http://www.python.org/>`_
installation
************
*on most UNIX-like systems, you'll probably need to run the following
`install` commands as root or by using sudo*
**pip**
::
pip install github-cli
**from source**
::
pip install git+http://github.com/jsmits/github-cli
*or*
::
git clone git://github.com/jsmits/github-cli.git
cd github-cli
python setup.py install
as a result, the ``ghi`` executable will be installed into a system ``bin``
directory
configuration
*************
make sure your GitHub username and API token are added to the global git config::
git config --global github.user <your GitHub username>
git config --global github.token <your GitHub API token>
or you can specify the environment variables GITHUB_USER and GITHUB_TOKEN
you can find the username and API token on your GitHub's account page
usage
*****
from within a working directory with a remote that is hosted on
GitHub (remote named either ``origin`` or ``github`` for git repositories or
``default`` or ``github`` for mercurial/`hg-git <http://hg-git.github.com/>`_ repositories), you can do this (note: with
the -r option, commands can be invoked from anywhere):
::
(github-cli)[jsmits@imac:~]$ ghi --help
Usage: ghi command [args] [options]
Examples:
ghi list [-s open|closed|all] show open, closed or all issues
(default: open)
ghi [-s o|c|a] -v same as above, but with issue details
ghi same as: ghi list
ghi -v same as: ghi list -v
ghi [-s o|c] -w show issues' GitHub page in web browser
(default: open)
ghi list -u <github_user> show issues created by specified user
ghi show <nr> show issue <nr>
ghi show <nr> -v same as above, but with comments
ghi <nr> same as: ghi show <nr>
ghi <nr> -w show issue <nr>'s GitHub page in web
browser
ghi open (o) create a new issue (with $EDITOR)
ghi open (o) -m <msg> create a new issue with <msg> content
(optionally, use \n for new lines; first
line will be the issue title)
ghi close (c) <nr> close issue <nr>
ghi open (o) <nr> reopen issue <nr>
ghi edit (e) <nr> edit issue <nr> (with $EDITOR)
ghi label add (al) <label> <nr> add <label> to issue <nr>
ghi label remove (rl) <label> <nr> remove <label> from issue <nr>
ghi search (s) <term> search for <term> (default: open)
ghi s <term> [-s o|c] -v same as above, but with details
ghi s <term> -s closed only search in closed issues
ghi comment (m) <nr> create a comment for issue <nr>
(with $EDITOR)
ghi comment (m) <nr> -m <msg> create a comment for issue <nr>
with <msg> content. (optionally use \n
for new lines)
ghi -r <user>/<repo> specify a repository (can be used for
all commands)
ghi -r <repo> specify a repository (gets user from
global git config)
Description: command-line interface to GitHub's Issues API (v2)
Options:
-h, --help show this help message and exit
-v, --verbose show issue details (only for show, list and search
commands) [default: False]
-s STATE, --state=STATE
specify state (only for list and search (except `all`)
commands) choices are: open (o), closed (c), all (a)
[default: open]
-u CREATED_BY, --user=CREATED_BY
issues created by <github_username> [default: all]
-m MESSAGE, --message=MESSAGE
message content for opening or commenting on an issue
without using the editor
-r REPO, --repo=REPO, --repository=REPO
specify a repository (format: `user/repo` or just
`repo` (latter will get the user from the global git
config))
-w, --web, --webbrowser
show issue(s) GitHub page in web browser (only for
list and show commands) [default: False]
-V, --version show program's version number and exit
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Bug Tracking
|
