go-matrixbackup

command module
v0.0.0-...-43788a6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 21, 2025 License: GPL-3.0 Imports: 20 Imported by: 0

README

matrixbackup

This is a tool that implements downloading of data from all rooms user has access to, to a set of json files. The json files are stored in hierarchy room-human-readable-alias:room-id/yyyy-mm-dd.json, where each yyyy-mm-dd.json file contains all data for that particular day for that room.

The default credentials file is ~/.config/matrix-commander/credentials.json. Command-line flags always override values found in the config file.

Usage example ( git )

After checkout:

go run . --server <YOUR_HOMESERVER_URL> --user <YOUR_USER_ID> --token <YOUR_ACCESS_TOKEN> --dir ./my_matrix_backup

or, if you are Matrix Commander user, you have your credentials in ~/.config/matrix-commander/credentials.json, and you want backups in backup/ directory:

go run .

Installation ( non git )

This can be also installed using

go install github.com/fingon/go-matrixbackup@latest

and then you can use the command, assuming you have Go binary directory in your PATH:

go-matrixbackup ...

if you wish to use it without git.

Credits

  • mautrix go library ( maunium.net/go/mautrix ) does all the heavy lifting here (thanks, Tulir!)

  • LLM did the rest

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL