node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

cloudbot

Build Status Dependency Status npm

cloudbot

  • A robot may not injure a human being or, through inaction, allow a human being to come to harm.
  • A robot must obey orders given it by human beings except where such orders would conflict with the First Law.
  • A robot must protect its own existence as long as such protection does not conflict with the First or Second Law.

Getting Started

Setup

Setting up your bot is simple. Install the dependencies:

npm install

Usage

With the dependencies installed, starting cloudbot requires the environment variables HUBOT_NAME and ADAPTER be set. The booting sequence will begin with

npm start

Certain scripts may require other environment variables to be set. Check out the documentation for each of these scripts, as it will provide the proper information.

Included Scripts

Community

Demos

Please check out our YouTube videos to learn more about cloudbot and how quickly your DevOps team can embrace our bot capabilities across a variety of integrations.

Deploying to IBM Bluemix

Before deploying your custom cloudbot to IBM Bluemix, you need to create a manifest.yml file with the properties you need for specific scripts. There is a sample manifest file with minimum required configuration, follow these instructions to customize and deploy a cloudbot to your IBM Bluemix account:

  1. Clone this repo and cd to the the folder where you have this repo.

  2. If you have not already logged into IBM Bluemix, use the following commands to login:

cf api https://api.ng.bluemix.net/
cf login
  1. Create Cloudant and Watson Natural Language Classifier services.
cf cs cloudantNoSQLDB Shared cloudbot-cloudant
cf cs natural_language_classifier standard cloudbot-nlc
  1. Copy the manifext_sample.yml to manifest.yml and update the properties in manifest file, based on the scripts you need for your bot.

  2. Deploy your bot to IBM Bluemix.

cf push -f manifest.yml
  1. It will take several minutes to deploy the node application to IBM Bluemix. Once your application is started, you should be able to interact with the newly deployed bot from your Slack account.

Enhancing

More functionality can be added to cloudbot; it knows no limits. Add the script to the dependency list in package.json, and reference that script in the array of external-scripts.json.

License

See LICENSE.txt for license information.

Contribute

Please check out our Contributing Guidelines for detailed information on how you can lend a hand.