Countly Chatbot
This is the open source repository of Countly chatbot for Slack. It's in beta stage.
Installation
Chatbot can run on Ubuntu/RHEL/CentOS with systemd init model.
It requires Node.js, so install it before moving further with installation steps below:
git clone http://github.com/countly/countly-chatbot
cd countly-chatbot
cp config.sample.js config.js
# Add required information in config.js (comment out conversations you want to have)
npm install
bash bin/install.sh
# Countly chatbot should be online in Slack
Chatbot commands
Here are currently implemented commands for Countly Chatbot:
- show apps: show all apps defined on the Countly instance
- show stats for {APP_NAME}: show latest usage stats for APP_NAME
- show errors: show latest api and dashboard errors
- hello: pings bot
- call me {name}: defines your name
- what is my name: acknowledges your name
- uptime: for how long the bot is running
- what is {term}: looks up from dictionary
- translate "{term}" from {ln} to {ln}: translation service from a language to another language
- weather {city}: outputs city weather
- wiki {term}: queries Wikipedia for term
- show me {term}: shows an image defining term
- ask yes or no question: Ask a simple question so bot can answer (fun)
- shut up: deactives (silences) bot
- speak up: activates bot
Example:
You:
Show stats for MyMobileApp
Countly bot:
Some stats for last 30 days:
You totally had 2435 users, which is 65.5% increase than in previous period
All of them had 4389 session and spent on average 3.1 min
2131 or user were new
Adding a new conversation
We suggest that you create new conversations by creating new module and adding it to configuration file. You can create module under conversations directory exporting function accepting four arguments - controller instance, bot instance, array for help texts, conversation specific config.
For more information about controller and bot instances, see this documentation.
Helps is array to push all possible commands to which will be outputed by main file if asked for help.
Conversation specific configuration, can be provided in main config file, when enabling specific conversation. If you develop conversation, which might require some configuration or, for example, API key, it should go into main config.js config.conversations.convetsation_name.yourconfig