hubotio / hubot

Hubot **Note: v10.0.4 accidentally contains the removal of CoffeeScript; v10.0.5 puts it back in** **Note: v11 removes CoffeeScript and converts this codebase to ESM** Hubot is a framework to build chat bots, modeled after GitHub's Campfire bot of the same name, hubot. He's pretty cool. He's extendable with scripts and can work on many different chat services. This repository provides a library that's distributed by that you use for building your own bots. See the documentation for details on getting up and running with your very own robot friend. In most cases, you'll probably never have to hack on this repo directly if you are building your own bot. But if you do, check out CONTRIBUTING.md Create your own Hubot instance This will create a directory called in the current working directory. Review . Create more scripts in the folder. Command bus (robot.commands) Hubot includes a deterministic command subsystem for slash-style commands. It is safe by default and does not interfere with legacy and listeners. Basic Command Registration Invoke with addressing the bot: • • Commands that declare side effects will require confirmation before execution. The user is asked to confirm. They do so like so: Aliases are for discovery and search only. They do not execute commands or create proposals. They are intent utterances. Built-in Help Command Hubot automatically registers a command that provides command discovery and documentation: Search for Commands Custom Type Resolvers Extend validation with custom argument types: Configuration Options When creating a CommandBus instance, you can configure: • - Command prefix (default: '') • - Timeout for pending confirmations in milliseconds (default: 300000 = 5 minutes) • - Path to NDJSON event log file (default: ) • - Disable event logging to disk (default: true - logging is disabled by default) • - Custom permission checking handler (optional) Permissions Control who can execute commands using room-based and role-based permissions. Room-Based Permissions Restrict command execution to specific chat rooms: Users in other rooms get: Role-Based Permissions Restrict command execution to users with specific roles: To enable role checking, provide a when creating CommandBus: Without a permission provider, role-based permissions are ignored (allow by default). Room-based permissions are always enforced. License See the LICENSE file for license rights and limitations (MIT). Hubot History Say hello to Hubot Cartoon with Hubot The Most Important Startup's Hardest Worker Isn't a Person The Story of Hubot Hubot by Hubotics Automating Inefficiencies Getting Started with Hubot