ERRBOT(1)

✨ NAME ✨

Errbot — it's a chatbot, bestie 💖 and the whole point is that it's designed to be simple to extend with plugins written in Python. That's it, that's the vibe. 🐍✨

🦋 DESCRIPTION 🦋

Okay so here's the usage line, no cap, exactly as it is:

usage: errbot [-h] [-c CONFIG] [-v | -r [RESTORE] | -l | --new-plugin

       [NEW_PLUGIN] | -i [INIT] | --storage-set STORAGE_SET |
       --storage-merge STORAGE_MERGE | --storage-get STORAGE_GET | -T |
       -G] [-d] [-p PIDFILE]

This is literally the main entry point of the errbot. 👑

💅 options: 💅

• -h, --help — shows this help message and then dips out. 🌈
• -c CONFIG, --config CONFIG — the full path to your config.py. If you don't say anything, it just assumes config.py in the current working directory. 📁
• -v, --version — shows the program's version number and exits, iconic behaviour tbh. ⭐
• -r [RESTORE], --restore [RESTORE] — restores a bot from backup.py. Defaults to backup.py from the bot data directory if you don't hand it one. 🫶
• -l, --list — lists literally all the available backends. 📋
• --new-plugin [NEW_PLUGIN] — makes a new plugin in the directory you specify. 🎀
• -i [INIT], --init [INIT] — initializes a simple bot with a minimal configuration in the directory you optionally give it (if you don't, it's just the working directory). This is the glow-up starter kit: it creates a data subdirectory for the bot data dir and a plugins directory for your plugin development, with an example already in there so you can get started. 🧚✨
• --storage-set STORAGE_SET — DANGER: deletes the given storage namespace and sets the python dictionary expression that you passed on stdin. 💀
• --storage-merge STORAGE_MERGE — DANGER: merges the python dictionary expression passed on stdin into the given storage namespace. 😭
• --storage-get STORAGE_GET — dumps the given storage namespace in a format that's compatible with --storage-set and --storage-merge. 🔥
• -T, --text — forces the local text backend. 📝
• -G, --graphic — forces the local graphical backend. 🖼️

🎀 optional daemonization arguments: 🎀

• -d, --daemon — detaches the process from the console. Bye bestie, you're on your own now. 👋
• -p PIDFILE, --pidfile PIDFILE — specifies the pid file for the daemon. Defaults to the current bot data directory. 🗂️

Heads up fr fr: those --storage-set and --storage-merge ones are marked DANGER for a reason. They will eat your storage namespace. Respect them. 🙈

okay that's the whole page, you ate it, main character energy, periodt 💅✨

This was Errbot version 6.2.0, dated January 2024 — mwah, take care of her 🫶💖🦋