vic / keybase-scala-bot

A small library for creating keybase bots using scala.

Home Page:https://keybasebots.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Main workflow

About

A library for building Keybase Bots using scala.

Build your own keybase-bot in scala

To create a bot the user must create a Bot that has BotActions. A BotAction takes messages passed to the Bot and responds according to the Action. An Action is the command passed to the Bot (eg: !help, help would be the Action).

An example bot is available at example/src. And can be run via the following command

vi example/secrets.env # Follow example/README.md
./ci example # This will launch ExampleBot in docker

Security considerations

The authors are not responsible for any damage caused by a the use of this project. Use only under your own risk.

Please read the LICENSE file on this repo.

Arbitrary code execution.

Since you can feed any scala code snippet to this bot, you must be aware that it's possible to download any arbitrary maven dependency using ammonite, and hence you are solely responsible for who has access to this bot and what kind of code is evaluated by it.

Useful links:

About

A small library for creating keybase bots using scala.

https://keybasebots.com/

License:Apache License 2.0


Languages

Language:Scala 93.4%Language:Shell 6.6%