A command-line interface to the GitHub Issues API v2.
Available items
No Items, yet!
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
=============================================
GitHub Issues API v2 - command-line interface
IMPORTANT: github-cli does not function anymore since API v2 has been replaced by
API v3. A possible alternative for github-cli that addresses API v3 is Stephen Celis'
ghi.
about
github-cli_ provides an executable called
ghi, that can be used to access all of
GitHub's documented
Issues API(v2) functionality from your command-line
github-cli is written in
Python_
installation
on most UNIX-like systems, you'll probably need to run the following
installcommands 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
ghiexecutable will be installed into a system
bindirectory
configuration
make sure your GitHub username and API token are added to the global git config::
git config --global github.user git config --global github.token
or you can specify the environment variables GITHUBUSER and GITHUBTOKEN
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
originor
githubfor git repositories or
defaultor
githubfor mercurial/
hg-git_ repositories), you can do this (note: with the -r option, commands can be invoked from anywhere):
::
(github-cli)[[email protected]:~]$ 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 show issues created by specified user
ghi show show issue ghi show -v same as above, but with comments ghi same as: ghi show ghi -w show issue 's GitHub page in web browser ghi open (o) create a new issue (with $EDITOR) ghi open (o) -m create a new issue with content (optionally, use \n for new lines; first line will be the issue title) ghi close (c) close issue ghi open (o) reopen issue ghi edit (e) edit issue (with $EDITOR) ghi label add (al)
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 CREATEDBY, --user=CREATEDBY issues created by [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/repoor 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