botio

Botio

Botio is a CLI to create and manage easily chatbots for different platforms with the possibility of using differents databases.

NOTE: Due to how filepaths work if you're a Windows user is recommended to use a shell like Git Bash.

Support

AUTH

• JWT-based auth.

Platforms

• Discord.
• Telegram.

Work is in progress to add support for:

• Alexa.
• Facebook Messenger.
• Google Assistant.
• Slack.

Databases

• BoltDB
• PostgreSQL
• SQLite 3.

Work is in progress to add support for:

• MongoDB.
• Redis.

Cache

• Ristretto.

Install

Go

go get -u github.com/danielkvist/botio

Docker

docker image pull danielkvist/botio

Snap

snap install --edge --devmode botio

Development

Clone

git clone https://github.com/danielkvist/botio.git botio

Setup

cd ./botio

And

make setup

CLI

Botio provides a simple CLI to manage your server, your chatbots and their commands.

$ botio --help
Botio is a CLI to create and manage easily chatbots for different platforms such as Telegram or Discord.  
It also let's you use different databases to manage their available commands wuch as BoltDB or PostgreSQL.

Botio is a project in development so use it with caution!

Usage:
  botio [command]

Examples:
botio server bolt --database ./data/commands.db --collection commands --key mysupersecretkey
botio client add --command start --response Hi --token <jwt-token>
botio bot --platform telegram --token <telegram-token> --jwt <jwt-token>

Available Commands:
  bot         Starts a chatbot for the specified platform.
  client      Client provides subcommands to manage your commands.
  help        Help about any command
  server      Server provides subcommands to initialize a server with differents databases.

Flags:
  -h, --help   help for botio

Use "botio [command] --help" for more information about a command.

Server

The server subcommand handles the initialization of a Botio server with the specified database.

$ botio server --help
Server provides subcommands to initialize a server with differents databases.

Usage:
  botio server [command]

Available Commands:
  bolt        Starts a Botio server with BoltDB.
  postgres    Starts a Botio server with PostgreSQL.
  sqlite      Starts a Botio server with SQLite3.

Flags:
  -h, --help   help for server

Use "botio server [command] --help" for more information about a command.

For example, if you want to initialize a Botio's server with BoltDB:

botio server bolt --key mysupersecretkey

IMPORTANT: Due to how PostgreSQL and SQLite 3 works you will need to have created the database before trying to connect Botio to it.

IMPORTANT: The first log message will contain your generated JWT for authentication.

Client

In the future you will have the option to manage your chabots commands with an HTTP client. For the moment you can use the client subcommand.

$ botio client --help
Client provides subcommands to manage your commands.

Usage:
  botio client [command]

Available Commands:
  add         Adds a new command.
  delete      Deletes the requested command
  list        List all the commands.
  print       Prints the requested command.
  update      Updates the requested command or adds it if don't exists.  

Flags:
  -h, --help   help for client

Use "botio client [command] --help" for more information about a command.

Each subcommand provides and example so feel free to check each one by one.

Bot

The bot subcommand handles the initialization of a chatbot for a specified platform.

$ botio bot --help
Starts a chatbot for the specified platform.

Usage:
  botio bot [flags]

Examples:
botio bot --platform telegram --token <telegram-token> --jwt <jwt-token>

Flags:
      --addr string       botio's gRPC server address (default ":9091")
      --goroutines int    number of goroutines (default 10)
  -h, --help              help for bot
      --jwt string        authentication token
      --platform string   platform (discord or telegram)
      --resp string       default response for when the bot fails to respond to a command (default "I'm sorry but something's happened and I can't answer that command rigth now")
      --sslca string      ssl client certification file
      --sslcrt string     ssl certification file
      --sslkey string     ssl certification key file
      --token string      bot's token

If for example you want to initialize a chatbot for Telegram:

botio bot --platform telegram --token <telegram-token>

Please, check the documentation provided by the differents plaforms about how to get a token for a chatbot.

gRPC HTTP endpoint

Botio provides HTTP endpoints using Google's gRPC gateway. For the moment is work in progress.

For more information check this file.

Other things that need to improve

You can secure with TLS your server or not. To do this you simply have to leave the flags --sslca, --sslcrt and --sslkey empty. The same goes for the client and the chabot's client.

I know that right now managing the configuration and generation of certificates to get a secure server or client is a bit clumsy and I'm actively working to solve it.