HipChat CLI 项目技术文档

1. 安装指南

1.1 环境要求

• 操作系统：Linux 或 macOS
• 依赖工具：curl

1.2 安装步骤

1. 克隆项目仓库到本地：

   git clone https://github.com/your-repo/hipchat-cli.git
   

2. 进入项目目录：

   cd hipchat-cli
   

3. 赋予执行权限：

   chmod +x hipchat_room_message
   

2. 项目的使用说明

2.1 发送消息到房间

使用 hipchat_room_message 脚本可以向指定的 HipChat 房间发送消息。以下是基本用法：

$ cat message.txt | ./hipchat_room_message -t <token> -r <room> -f "System"

2.2 配置选项

hipchat-cli 支持通过以下三种方式进行配置：

• 命令行选项
• 环境变量
• 配置文件

2.2.1 命令行选项

通过命令行选项传递参数，可以使用 -h 查看所有可用选项：

$ ./hipchat_room_message -h

2.2.2 环境变量

所有命令行选项都可以通过环境变量传递，例如：

$ cat message.txt | HIPCHAT_TOKEN=<token> HIPCHAT_ROOM_ID=1234 ./hipchat_room_message -f "System"

2.2.3 配置文件

所有环境变量可以在 /etc/hipchat 配置文件中指定，例如：

HIPCHAT_TOKEN=<token>
HIPCHAT_ROOM_ID=1234

然后通过命令行调用：

$ cat message.txt | HIPCHAT_FROM="System" ./hipchat_room_message -c green

3. 项目API使用文档

3.1 API 版本

默认使用 v1 版本的 API，可以通过 -v 选项指定 API 版本：

$ ./hipchat_room_message -vv2 -t <TOKEN> -r <ROOM> -i "This is a message"

3.2 消息颜色

可以通过 -c 选项指定消息的颜色，支持的颜色有：yellow, red, green, purple, gray, random（默认：yellow）。

3.3 消息格式

可以通过 -m 选项指定消息的格式，支持的格式有：html, text（默认：html）。

3.4 通知触发

通过 -n 选项可以触发房间内人员的通知：

$ ./hipchat_room_message -t <token> -r <room> -i "This is a message" -n

3.5 自定义 API 主机

通过 -o 选项可以指定自定义的 API 主机：

$ ./hipchat_room_message -t <token> -r <room> -i "This is a message" -o api.customhost.com

4. 项目安装方式

4.1 手动安装

按照 安装指南 中的步骤手动安装项目。

4.2 配置文件安装

通过配置文件 /etc/hipchat 进行安装和配置，具体步骤参考 配置文件 部分。

4.3 环境变量安装

通过设置环境变量进行安装和配置，具体步骤参考 环境变量 部分。