A hubot script for management of your the IBM Bluemix Cloudant instance.
Steps for adding this to your existing hubot:
cd
into your hubot directory- Install the cloudant management functionality with
npm install hubot-ibmcloud-cloudant --save
- Add
hubot-ibmcloud-cloudant
to yourexternal-scripts.json
- 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>
- Start up your bot & off to the races!
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 supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:
This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.
Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:
- Create
config
folder in root of this project. - Create
env
in theconfig
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>
- In order to view content in chat clients you will need to add
hubot-ibmcloud-formatter
to yourexternal-scripts.json
file. Additionally, if you want to usehubot-help
to make sure your command documentation is correct. Createexternal-scripts.json
in the root of this project
[
"hubot-help",
"hubot-ibmcloud-formatter"
]
- Lastly, run
npm install
to obtain all the dependent node modules.
Hubot supports a variety of adapters to connect to popular chat clients.
If you just want to use:
- Terminal: run
npm run start
- Slack: link to setup instructions
- Facebook Messenger: link to setup instructions
See LICENSE.txt for license information.
Please check out our Contribution Guidelines for detailed information on how you can lend a hand.