Matrix Notify

发送消息到 Matrix 聊天室的控制台工具。

安装

要开始，请使用以下命令安装 Matrix Notify：

cargo install matrix-notify

配置

在开始使用 Matrix Notify 之前，您需要设置一个名为 matrix-notify.toml 的配置文件。要在当前目录中生成一个示例配置文件，请运行以下命令：

matrix-notify generate

生成的配置文件应根据您的连接设置进行修改。

在运行 matrix-notify 时，配置文件中提供的令牌将用于身份验证。如果发生身份验证错误或未提供令牌，则将使用密码。如果密码身份验证成功，则配置文件将自动更新为新令牌。

一旦生成令牌，您可以从配置文件中安全地删除 password 字段。但是，如果令牌无效，您需要再次提供密码以获取新的令牌。

示例 matrix-notify.toml

base_url = "https://example.org"
local_username = "matrix-bot"
full_username = "@matrix-bot:example.org"
password = "Plaintext password"

用法

为了最佳安全性，建议为该工具创建一个专用的 Matrix 用户，因为用户凭据和/或访问令牌将存储在明文配置文件中。

要向聊天室发送消息，请确保首先邀请机器人用户到聊天室。如果机器人用户尚未是成员，它将自动加入聊天室并发送消息。

示例用法：发送消息

matrix-notify --room "\!roomid:matrix.org" --message "Lorem ipsum dolor sit amet"