Jyoti - A simple IRC bot for use with shell scripts

Zero dependencies.

Simple usage.

Hackable.

Usage

The idea is that Jyoti can be repurposed easily with shell scripts, removing the need to write a new bot each time.

Here is how Jyoti should be used in general, using all its options:

jyoti                     \
  "rust-repl-bot"         \ # Name
  'irc.freenode.net:9997' \ # Server
  '##rust'                \ # Channel
  './shell-script.sh'       # Script

All arguments are required.

The following are then passed to shell-script.sh as separate lines:

The message sent to the user.

At this point the script does some work and returns everything on stdout.

You should use the timeout program or similar from coreutils to stop the program if it takes too long to execute in shell scripts.

Run Jyoti multiple times if multiple bots are needed.

Licensing

This software is (c) lf94. If you wish to use it for any reason, contact me, and more than likely I will grant you full permissions; this means the ability to modify, distribute, and even sell the software. This is an effort to fight individual exploitation in the FOSS community.

You might also like...

Comments

Consider passwords support; limitations of position-based CLI args
Hi @lf94, a nice project you have here! It checks the right boxes with me to take a closer look. :)

Having worked on some IRC tools myself, the position-based CLI you chose for your bot instantly reminds me of the struggles I had with adding more features people requested (to be able to integrate a bot in their environments):

channel passwords

server passwords

server SSL

So, I guess I just like to suggest to you to keep those in mind.

They are doable as CLI options, but I myself went with a configuration file at some point (done in Weitersager, and actually ongoing these days in syslog2IRC) – to keep passwords out of CLI history and process lists, to ease version control, and to enable more structurally complex application-specific configuration.

Maybe considering this early can save you some headaches later on.
opened by homeworkprod 2