Hubot 技术文档

1. 安装指南

1.1 环境准备

在开始安装之前，请确保您的系统已经安装了以下软件：

• Node.js（建议版本14.x或更高）
• npm（通常随Node.js一起安装）

1.2 安装步骤

1. 打开终端或命令行工具。

2. 使用以下命令创建一个新的Hubot实例：

   npx hubot --create myhubot --adapter @hubot-friends/hubot-slack
   

   您可以根据需要选择不同的适配器，例如：

   • Slack: @hubot-friends/hubot-slack
   • Discord: @hubot-friends/hubot-discord
   • Microsoft Teams: @hubot-friends/hubot-ms-teams
   • IRC: @hubot-friends/hubot-irc

3. 进入新创建的目录：

   cd myhubot
   

4. 安装依赖：

   npm install
   

2. 项目的使用说明

2.1 启动Hubot

在安装完成后，您可以通过以下命令启动Hubot：

bin/hubot

2.2 自定义脚本

Hubot支持通过脚本进行扩展。您可以在scripts目录下创建新的脚本文件，例如scripts/example.mjs。脚本文件可以使用JavaScript或CoffeeScript编写。

2.3 适配器配置

根据您选择的适配器，您需要在相应的配置文件中设置必要的参数，例如API密钥、令牌等。配置文件通常位于项目的根目录下，文件名为config.js或.env。

3. 项目API使用文档

3.1 基本API

• robot.hear(regex, callback): 监听特定正则表达式的消息。
• robot.respond(regex, callback): 响应特定正则表达式的消息。
• robot.send(envelope, strings...): 发送消息到指定的信封。
• robot.reply(envelope, strings...): 回复消息到指定的信封。

3.2 示例

以下是一个简单的示例脚本，当用户发送“hello”时，Hubot会回复“Hello, World!”：

module.exports = function(robot) {
  robot.hear(/hello/i, function(res) {
    res.send("Hello, World!");
  });
};

4. 项目安装方式

4.1 通过npm安装

您可以通过npm全局安装Hubot：

npm install -g hubot

4.2 通过npx创建实例

如前所述，您也可以直接使用npx命令创建一个新的Hubot实例：

npx hubot --create myhubot --adapter @hubot-friends/hubot-slack

通过以上步骤，您应该能够顺利安装并使用Hubot来构建自己的聊天机器人。