55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
# matrix-send
|
|
|
|
A script that sends messages to Matrix rooms.
|
|
|
|
[Read the manual page](https://jtbx.codeberg.page/man/matrix-send.1)
|
|
|
|
---
|
|
|
|
matrix-send is a simple script that sends a message to a Matrix room.
|
|
|
|
It does this by sending a JSON message to your Matrix server. The message types that are supported are `m.text`, and `m.notice`.
|
|
|
|
It is mainly designed for automation.
|
|
|
|
There aren't any plans for matrix-send to support encryption.
|
|
|
|
## Get started
|
|
|
|
In order to start using matrix-send, you need a config file. To copy the default configuration to .config, clone this repository and type `make config` as the desired user (not root).
|
|
|
|
Now edit the file ~/.config/matrix-send.conf. You will see three (uncommented) lines.
|
|
|
|
```
|
|
Server ...
|
|
Username ...
|
|
Password ...
|
|
```
|
|
|
|
Delete the example values and enter in your credentials.
|
|
|
|
If you don't want to put your password in plain text, as matrix-send.conf is a shell script, you could do something like this:
|
|
|
|
```shell
|
|
Password $(gpg -d /path/to/passwd.gpg)
|
|
```
|
|
|
|
/path/to/passwd.gpg is a GPG-encrypted file containing only your password, once decrypted.
|
|
|
|
For more configuration options, see [matrix-send.conf(5)](https://jtbx.codeberg.page/man/matrix-send.conf.5).
|
|
|
|
---
|
|
|
|
To install matrix-send, run `make install` as root, in the cloned repository's directory.
|
|
|
|
In order to send messages, you will need the Room ID of your choice. Find the room you want to send to, and find its Room ID in the settings or somewhere else. It will likely be under Advanced or something similar.
|
|
|
|
To send a message, type `matrix-send` followed by your message and then your Room ID. You may need to escape the exclamation mark(s). For example:
|
|
|
|
```shell
|
|
matrix-send 'Hi!' \!asdfasdfasdfasdf:matrix.org
|
|
```
|
|
|
|
That will send the message "Hi!" to the Matrix room !asdfasdfasdfasdf:matrix.org.
|
|
|
|
For more information, see [matrix-send(1)](https://jtbx.codeberg.page/man/matrix-send.1).
|