Skip to content

Export your Signal chats to markdown files with attachments

License

Notifications You must be signed in to change notification settings

carderne/signal-export

 
 

Repository files navigation

signal-export

PyPI version

⚠️ WARNING: Because the latest versions of Signal Desktop protect the database encryption key, this tool currently only works on macOS and Linux. Solutions for Windows will hopefully come soon from the community. Discussion happening in this thread.

Export chats from the Signal Desktop app to Markdown and HTML files with attachments. Each chat is exported as an individual .md/.html file and the attachments for each are stored in a separate folder. Attachments are linked from the Markdown files and displayed in the HTML (pictures, videos, voice notes).

Currently this seems to be the only way to get chat history out of Signal!

Adapted from mattsta/signal-backup, which I suspect will be hard to get working now.

Example

An export for a group conversation looks as follows:

[2019-05-29, 15:04] Me: How is everyone?
[2019-05-29, 15:10] Aya: We're great!
[2019-05-29, 15:20] Jim: I'm not.

Images are attached inline with ![name](path) while other attachments (voice notes, videos, documents) are included as links like [name](path) so a click will take you to the file.

This is converted to HTML at the end so it can be opened with any web browser. The stylesheet .css is still very basic but I'll get to it sooner or later.

🐧 Installation

  1. Make sure you have Python installed.

  2. Install this package:

pip install signal-export
  1. Then run the script!
sigexport ~/signal-chats

# or for Windows:
python -m sigexport C:\Temp\SignalExport

🪟 Installation: Windows

If you need step-by-step instructions on things like enabling WSL2, please see the dedicated Windows Installation instructions.

🚀 Usage

Please fully exit your Signal app before proceeding, otherwise you will likely encounter an I/O disk error, due to the message database being made read-only, as it was being accessed by the app.

See the full help info:

sigexport --help

Disable pagination on HTML:

sigexport --paginate=0 ~/signal-chats

List available chats and exit:

sigexport --list-chats

Export only the selected chats:

sigexport --chats=Jim,Aya ~/signal-chats

You can add --source /path/to/source/dir/ if the script doesn't manage to find the Signal config location. Default locations per OS are below. The directory should contain a folder called sql with db.sqlite inside it.

  • Linux: ~/.config/Signal/
  • macOS: ~/Library/Application Support/Signal/
  • Windows: ~/AppData/Roaming/Signal/

You can also use --old /previously/exported/dir/ to merge the new export with a previous one. Nothing will be overwritten! It will put the combined results in whatever output directory you specified and leave your previos export untouched. Exercise is left to the reader to verify that all went well before deleting the previous one.

Development

git clone https://github.com/carderne/signal-export.git
cd signal-export
rye sync --no-lock

Various dev commands:

rye fmt         # format
rye lint        # lint
rye run check   # typecheck
rye run test    # test
rye run sig     # run signal-export

Similar things

About

Export your Signal chats to markdown files with attachments

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Languages

  • Python 95.9%
  • CSS 4.1%