Skip to content
A higher-level wrapper around the Github API. Intended for the browser.
JavaScript HTML
Latest commit ae8d5eb May 3, 2016 @clayreimann clayreimann 1.1.0


Downloads per month Latest version Gitter Travis

Github.js provides a minimal higher-level wrapper around Github's API. It was concieved in the context of Prose, a content editor for GitHub.


Read the docs


Github.js is available from npm or (soon) cdnjs.

npm install github-api


Github.js is tested on Node:

  • 0.10
  • 0.12
  • 4.x
  • 5.x

GitHub Tools

The team behind Github.js has created a whole organization, called GitHub Tools, dedicated to GitHub and its API. In the near future this repository could be moved under the GitHub Tools organization as well. In the meantime, we recommend you to take a look at other projects of the organization.


   Data can be retrieved from the API either using callbacks (as in versions < 1.0)
   or using a new promise-based API. For now the promise-based API just returns the
   raw HTTP request promise; this might change in the next version.
var GitHub = require('github-api');

// unauthenticated client
var gh = new GitHub();
var gist = gh.getGist(); // not a gist yet
   public: true,
   description: 'My first gist',
   files: {
      "file1.txt": {
         contents: "Aren't gists great!"
}).then(function(httpResponse) {
   // Promises!
   var gist =;, gist, xhr) {
      // if no error occurred then err == null

      // gist ==

      // xhr == httpResponse
var GitHub = require('github-api');

// basic auth
var gh = new GitHub({
   username: 'FOO',
   password: 'NotFoo'

var me = gh.getUser();
me.getNotification(function(err, notifcations) {
   // do some stuff

var clayreimann = gh.getUser('clayreimann');
   .then(function(httpPromise) {
      var repos =;
var GitHub = require('github-api');

// token auth
var gh = new GitHub({
   token: 'MY_OAUTH_TOKEN'

var yahoo = gh.getOrganization('yahoo');
yahoo.getRepos(function(err, repos) {
   // look at all the repos!
Something went wrong with that request. Please try again.