---

pkgbot

A statistics slack bot for npm packages and ruby gems The bot will fetch information from npmjs or rubygems and show it on screen.

Prerequisites

• Before creating the pkgbot, you need to create a new Slack bot and record your API token, export it as an environment variable named SLACK_TOKEN. You can, if you like, also use the bot image as your avatar for your bot.

• Please export your Snyk auth token (found here) to an environment variable named SNYK_AUTH_TOKEN

• Please add the following slack custom emojis:

:npm: npm.png
:rubygems: ruby.png
:highsev: highsev.png
:medsev: medsev.png
:lowsev: lowsev.png

Icons located at the /icons directory

The quick way

You can use the Heroku button below, and add the API token for the bot you created earlier:

Manual install and deploy

Using node 6, you can manually run the pkgbot using the following commands:

$ git clone https://github.com/Snyk/pkgbot.git
$ cd pkgbot
$ npm install
$ npm start

How-to

You can request information in a public channel by calling @pkgbot and stating npm/ruby [package]. Otherwise, in the direct channel you can query information by stating only by stating the package manager and the package.

Channel:

/invite @pkgbot
@pkgbot npm request
@pkgbot ruby actionpack
@pkgbot help

Direct Message:

npm moment
ruby httparty

License

License: Apache License, Version 2.0