find the public keys of a given github user
Last updated 6 years ago by michaelrhodes .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install github-keys 
SYNC missed versions from official npm registry.


github-keys is a simple module that finds the public keys of a given Github user. Its code is based on a private function in substack/cipherhub, however github-keys maintains a streaming API and doesn’t filter the returned keys.

Build status


$ npm install [-g] github-keys


var keys = require('github-keys')
var through = require('through2')

  function (key, enc, next) {


Sometimes you just want all the keys in an array, so github-keys provides an alternate endpoint to facilitate that use-case.

var keys = require('github-keys/all')

keys('alice', function (err, array) {
Running the usage examples

To run either of these examples in node or the browser, use the following commands:

# node
$ npm run example
$ npm run example-all

# browser, obviously
$ npm run example-browser
$ npm run example-all-browser

Because Github doesn’t support CORS for the /{user}.keys endpoint, github-keys needs to go through a reverse proxy in order to work in the browser. This is easily configured, however, with the browserify transform, envify:

$ CORS_PROXY='' browserify -t envify program.js > bundle.js

Command-line usage

If you install github-keys with the -g flag, you can access the command-line version:

$ github-keys {username}



Current Tags

  • 1.0.1                                ...           latest (6 years ago)

2 Versions

  • 1.0.1                                ...           6 years ago
  • 1.0.0                                ...           6 years ago
Maintainers (1)
Today 0
This Week 1
This Month 3
Last Day 0
Last Week 0
Last Month 1
Dependencies (5)
Dev Dependencies (3)
Dependents (1)

Copyright 2014 - 2017 © |