{ "info": { "author": "Sander Smits", "author_email": "jhmsmits@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: BSD License", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python", "Topic :: Software Development :: Bug Tracking" ], "description": "=============================================\r\nGitHub Issues API v2 - command-line interface\r\n=============================================\r\n\r\nabout\r\n*****\r\n`github-cli `_ provides an \r\nexecutable called ``ghi``, that can be used to access all of `GitHub \r\n`_'s documented `Issues API \r\n`_ (v2) functionality from your \r\ncommand-line\r\n\r\ngithub-cli is written in `Python `_\r\n\r\ninstallation\r\n************\r\n\r\n*on most UNIX-like systems, you'll probably need to run the following \r\n`install` commands as root or by using sudo*\r\n\r\n**pip**\r\n\r\n::\r\n\r\n pip install github-cli\r\n\r\n**from source**\r\n\r\n::\r\n\r\n pip install git+http://github.com/jsmits/github-cli\r\n\r\n*or*\r\n\r\n::\r\n\r\n git clone git://github.com/jsmits/github-cli.git\r\n cd github-cli\r\n python setup.py install\r\n\r\nas a result, the ``ghi`` executable will be installed into a system ``bin`` \r\ndirectory\r\n\r\nconfiguration\r\n*************\r\nmake sure your GitHub username and API token are added to the global git config::\r\n\r\n git config --global github.user \r\n git config --global github.token \r\n\r\nor you can specify the environment variables GITHUB_USER and GITHUB_TOKEN\r\n\r\nyou can find the username and API token on your GitHub's account page\r\n\r\nusage\r\n*****\r\nfrom within a working directory with a remote that is hosted on\r\nGitHub (remote named either ``origin`` or ``github`` for git repositories or \r\n``default`` or ``github`` for mercurial/`hg-git `_ repositories), you can do this (note: with\r\nthe -r option, commands can be invoked from anywhere):\r\n\r\n::\r\n\r\n (github-cli)[jsmits@imac:~]$ ghi --help\r\n Usage: ghi command [args] [options]\r\n \r\n Examples:\r\n ghi list [-s open|closed|all] show open, closed or all issues\r\n (default: open)\r\n ghi [-s o|c|a] -v same as above, but with issue details\r\n ghi same as: ghi list\r\n ghi -v same as: ghi list -v\r\n ghi [-s o|c] -w show issues' GitHub page in web browser\r\n (default: open)\r\n ghi list -u show issues created by specified user\r\n \r\n ghi show show issue \r\n ghi show -v same as above, but with comments\r\n ghi same as: ghi show \r\n ghi -w show issue 's GitHub page in web\r\n browser\r\n ghi open (o) create a new issue (with $EDITOR)\r\n ghi open (o) -m create a new issue with content \r\n (optionally, use \\n for new lines; first \r\n line will be the issue title)\r\n ghi close (c) close issue \r\n ghi open (o) reopen issue \r\n ghi edit (e) edit issue (with $EDITOR)\r\n ghi label add (al)