jsmits/ github-cli

Python

Need help with github-cli?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

jsmits

211 Stars

23 Forks

Other

162 Commits

3 Opened issues

Description

A command-line interface to the GitHub Issues API v2.

Services available

Need anything else?

Contributors list

Sander Smits jsmits

# 382,042

Python

142 commits

Sean M. Collins sc68cal

# 77,799

tfs

Git

c-sharp

2 commits

Geoffrey Huntley ghuntley

# 10,398

Xamarin

Univers...

f-sharp

2 commits

David Paleino dpaleino

# 142,351

complet...

Bash

C++

2 commits

Jonathan Wight schwa

# 116,052

Objecti...

carthag...

SDK

1 commit

Mark Norman Francis norm

# 390,680

CSS

HTML

Shell

1 commit

gregory tomlinson gtzilla

# 414,885

JavaScr...

Python

1 commit

Jeff Forcier bitprophet

# 13,505

Ruby

Python

Shell

sphinx

1 commit

James Rowe JNRowe

# 9,481

Shell

Vim

Perl

zsh-con...

1 commit

Readme

=============================================

GitHub Issues API v2 - command-line interface

Name: github-cli
Brand: github-cli
SKU: //jsmits/github-cli
Rating: 2.2775 (211 reviews)

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

install

commands as root or by using sudo

pip

pip install github-cli

from source

pip install git+http://github.com/jsmits/github-cli

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 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

origin

github

for git repositories or

default

github

for 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) add to issue ghi label remove (rl) remove from issue ghi search (s) search for (default: open) ghi s [-s o|c] -v same as above, but with details ghi s -s closed only search in closed issues ghi comment (m) create a comment for issue (with $EDITOR) ghi comment (m) -m create a comment for issue with content. (optionally use \n for new lines) ghi -r / specify a repository (can be used for all commands) ghi -r 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 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/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