Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 

hub api utils

This is a collection of small utility scripts to showcase examples of automating GitHub tasks from the command-line via the hub api command.

Some available commands are:

Prerequisites:

  • hub 2.12+
  • git 1.8+
  • bash (for many scripts)
  • jq (for some scripts)
  • standard POSIX tools such as grep, awk, sed

Installation with Homebrew:

brew install hub jq

Then drop individual scripts from this repo into your $PATH and edit them or use them as you see fit.

How to contribute

I would love to accept your scripts into this repository! Please send your pull requests. The prerequisites for submission are simple:

  • Your script should do something useful or interesting with the GitHub API using the hub api command. Either REST or GraphQL APIs might be used.

  • The script should be written in one of the widespread shells such as bash or zsh, or in often-available interpreted languages such as ruby, node, or python.

  • When shelling out to other commands, please try to stick to jq and the POSIX set of command-line utilities to keep scripts portable.

  • There are no other rules. Go wild! But please note that when you do submit contributions to this repository, you are releasing your code into the public domain per LICENSE.

Tips for hub api

The GitHub REST API can be queried like so:

# The placeholders "{owner}" and "{repo}" get populated with values from the
# current git repository:
hub api 'repos/{owner}/{repo}/issues'

The response is always JSON, which can be parsed using jq in shell scripts. Alternatively, you may specify the --flat flag to have hub api output data in a line-based format.

The GraphQL API can be queried like this:

hub api graphql -f query='QUERY'

For more information/examples, see https://hub.github.com/hub-api.1.html.

About

A collection of `hub api` examples

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages