Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 4.68 KB

README.md

File metadata and controls

94 lines (70 loc) · 4.68 KB
Raw

Build Status Coverage Status Dependency Status npm

hubot-ibmcloud-cloudant

A hubot script for management of your the IBM Bluemix Cloudant instance.

Getting Started

Usage

Steps for adding this to your existing hubot:

  1. cd into your hubot directory
  2. Install the cloudant management functionality with npm install hubot-ibmcloud-cloudant --save
  3. Add hubot-ibmcloud-cloudant to your external-scripts.json
  4. Add the necessary environment variables:
export HUBOT_CLOUDANT_ENDPOINT=<Bluemix Cloudant Endpoint 
          (https://xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-bluemix.cloudant.com:443)>
export HUBOT_CLOUDANT_KEY=<Bluemix Cloudant User ID>
export HUBOT_CLOUDANT_PASSWORD=<Password for the Bluemix Cloudant user>
  1. Start up your bot & off to the races!

Commands

  • hubot cloudant help - Show available commands for cloudant management.
  • hubot cloudant list databases - List databases.
  • hubot cloudant info database [database] - Show details for a database.
  • hubot cloudant create database [database] - Create a database.
  • hubot cloudant set permissions [database] [user/apikey] - Set permissions for a user/apikey for a database.
  • hubot cloudant list views [database] - List all views for a database.
  • hubot cloudant run view [database] [view] - Run the view for a database.

Hubot Adapter Setup

Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:

Cognitive Setup

This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.

Development

Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:

Configuration Setup

  1. Create config folder in root of this project.
  2. Create env in the config folder, with the following contents:
export HUBOT_CLOUDANT_ENDPOINT=<Bluemix Cloudant Endpoint 
          (https://xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-bluemix.cloudant.com:443)>
export HUBOT_CLOUDANT_KEY=<Bluemix Cloudant User ID>
export HUBOT_CLOUDANT_PASSWORD=<Password for the Bluemix Cloudant user>
  1. In order to view content in chat clients you will need to add hubot-ibmcloud-formatter to your external-scripts.json file. Additionally, if you want to use hubot-help to make sure your command documentation is correct. Create external-scripts.json in the root of this project
[
    "hubot-help",
    "hubot-ibmcloud-formatter"
]
  1. Lastly, run npm install to obtain all the dependent node modules.

Running Hubot with Adapters

Hubot supports a variety of adapters to connect to popular chat clients.

If you just want to use:

License

See LICENSE.txt for license information.

Contribute

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