Home

Awesome

puppeteer-github

GitHub automation driven by headless chrome.

NPM Build Status JavaScript Style Guide

This module also has a CLI.

Install

npm install --save puppeteer-github

Usage

This example signs into a GitHub account.

const PuppeteerGitHub = require('puppeteer-github')

const github = new PuppeteerGitHub()

await github.signin({ username: 'xxx', password: 'xxx' })
await github.starRepo('facebook/react')

await github.close()

API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

Table of Contents

PuppeteerGitHub

GitHub automation driven by headless chrome.

Type: function (opts)


isAuthenticated

Whether or not this instance is authenticated with GitHub.

Type: boolean


user

Authenticated user if authenticated with GitHub.

Type: Object


browser

Puppeteer Browser instance to use.

Type: function ()


signup

Automates the creation of a new GitHub account.

Type: function (user, opts): Promise


signin

Signs into an existing GitHub account.

Note: either username or email is required.

Type: function (user, opts): Promise


signout

Signs out of the currently authenticated GitHub account.

Type: function (): Promise


verifyEmail

Verifies the authenticated GitHub account's email via pupeteer-email.

Type: function (opts): Promise


starPackage

Stars an npm package's github repository.

Type: function (pkgName): Promise

Example:

const gh = new PuppeteerGitHub()
await gh.signin(...)
await gh.starPackage('react')
await gh.close()

unstarPackage

Unstars an npm package's github repository.

Type: function (pkgName): Promise


starRepo

Stars a github repository.

Type: function (repo): Promise

Example:

const gh = new PuppeteerGitHub()
await gh.signin(...)
await gh.starRepo('avajs/ava')
await gh.starRepo('https://github.com/facebook/react')
await gh.close()

unstarRepo

Unstars a github repository.

Type: function (repo): Promise


close

Closes the underlying browser instance, effectively ending this session.

Type: function (): Promise


Related

License

MIT © Travis Fischer

Support my OSS work by <a href="https://twitter.com/transitive_bs">following me on twitter <img src="https://storage.googleapis.com/saasify-assets/twitter-logo.svg" alt="twitter" height="24px" align="center"></a>