https://github.com/etkecc/emm
cli matrix-org
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/etkecc/emm
- Owner: etkecc
- License: agpl-3.0
- Created: 2024-08-11T20:06:22.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-15T10:45:05.000Z (29 days ago)
- Last Synced: 2025-04-15T11:43:24.216Z (29 days ago)
- Topics: cli, matrix-org
- Language: Go
- Size: 2.12 MB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-matrix-bots - emm (etke.cc)
README
# emm: Export Matrix Messages
A CLI tool that joins the room and exports last N messages to the file you specified.
## Features
* Get messages from any matrix room with pagination (if limit greather than page, to prevent timeout errors) or without it (if limit less or equals page)
* Export messages to one file for all messages
* Export each message in separate file
* Custom templates supported (`contrib` contains an example of hugo post template, [etke.cc/news](https://etke.cc/news) can be used as reference)
* Delegation and aliases supported
* `Anyone`/`world_readable` access supported without invite
## Usage
### Full example
That's how [etke.cc/news](https://etke.cc/news) generated
```bash
# using event ID for filename
emm -hs hs.url -u user -p pass -r "#room:hs.url" -t contrib/hugo-post-template.md -o /tmp/%s.md
# using a custom slug for filename
emm -hs hs.url -u user -p pass -r "#room:hs.url" -t contrib/hugo-post-template.md -o /tmp/{{ .CreatedAtDate }}.md
```
### Documentation
```bash
Usage of emm:
-hs string
Homeserver URL (supports delegation)
-l int
Messages limit
-o string
Output filename. If it contains %s, it will be replaced with event ID (one message per file, old way), or you can use Go template syntax to use all fields (new way)
-p string
Password of the matrix user
-r string
Room ID or alias
-t string
Template file. Default is JSON message struct
-u string
Username/Login of the matrix user
```
**Template syntax**
You can modify the output file name using Go template syntax. The following fields are available:
* `{{ .ID }}` - event ID
* `{{ .URLSafeID }}` - event ID with URL-safe encoding
* `{{ .Replace }}` - old event ID that was replaced by this message
* `{{ .ReplacedNote }}` - a simple ` (updated)` note if this message replaces another one
* `{{ .Author }}` - author's MXID
* `{{ .Title }}` - first line of the message with partially-stripped markdown
* `{{ .Text }}` - full message text (markdown plain-text)
* `{{ .HTML }}` - full message text (HTML, if available)
* `{{ .CreatedAtDate }}` - created at date in 2006-01-02 format (date only)
* `{{ .CreatedAt }}` - created at date in 2006-01-02 15:04:05 UTC format (date and time)
* `{{ .CreatedAtFull }}` - created at date in default Go's representation format
Using those vars you could have output files likes:
```
-o /tmp/{{ .CreatedAtDate }}-{{ .Title }}.md
```
All fields used in the output filename will be converted to URL-safe format, and the length of the filename will be truncated to 100 characters (to prevent filesystem errors).
## How to get
* Arch Linux [AUR](https://aur.archlinux.org/packages/export-matrix-messages-git/)
* [Releases](https://github.com/etkecc/emm/releases)
* or `go install github.com/etkecc/emm/cmd/emm@latest`
* or `just install` from source code