github-cli

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

github-cli Ranking & Summary

Advertisement

  • Rating:
  • License:
  • BSD License
  • Price:
  • FREE
  • Publisher Name:
  • Sander Smits
  • Publisher web site:
  • http://github.com/jsmits/github-cli

github-cli Tags


github-cli Description

A command-line interface to the GitHub Issues API v2. github-cli is a Python module that provides a script 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 PythonInstallationpipsudo pip install github-clieasy_installsudo easy_install github-clifrom sourcesudo pip install -e git://github.com/jsmits/github-cli.git#egg=github-cliorgit clone git://github.com/jsmits/github-cli.gitcd github-clipython setup.py buildsudo python setup.py installthe ghi executable will be installed into a system bin directoryConfigurationmake 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 >you can find the username and API token on your GitHub's account pageUsageinside a git working directory with an origin that is hosted on GitHub, you can do this (note: with the -r option, commands can be invoked from anywhere):(github-cli)$ ghi --helpUsage: ghi command Examples:ghi list # show open, closed or all issues (default: open)ghi -v # same as above, but with issue detailsghi # same as: ghi listghi -v # same as: ghi list -vghi -w # show issues' GitHub page in web browser (default: open)ghi show < nr > # show issue < nr >ghi < nr > # same as: ghi show < nr >ghi < nr > -w # show issue < nr >'s GitHub page in web browserghi open (o) # create a new issue (with $EDITOR)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 in open or closed issues (default: open)ghi s < term > -v # same as above, but with detailsghi comment (m) < nr > # create a comment for issue < nr > (with $EDITOR)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 list and search commands) -s STATE, --state=STATE specify state (only for list and search (except `all`) commands) choices are: open (o), closed (c), all (a) -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) Requirements: · Python


github-cli Related Software