reMarkableSync

How to Get DEBUG Logs

When filing a bug report, a DEBUG log helps us diagnose the issue quickly. The log captures detailed information about every step reMarkableSync performs.

Getting a DEBUG Log

Re-run the command that caused the issue with --log-level DBG:

# Examples:
reMarkableSync sync --log-level DBG
reMarkableSync sync --wifi --log-level DBG
reMarkableSync convert --log-level DBG

This does two things:

  1. Prints detailed debug output to the console
  2. Writes a full log to remarkablesync.log in your backup directory’s parent folder

Finding the Log File

The log file is written to your backup directory’s parent:

Platform Default Location
macOS ~/Library/Application Support/remarkablesync/remarkablesync.log
Windows %LOCALAPPDATA%\remarkablesync\remarkablesync.log
Linux ~/.local/share/remarkablesync/remarkablesync.log

If you’ve set a custom backup directory, the log file is in its parent folder.

Attaching to a Bug Report

  1. Copy the console output or open the remarkablesync.log file
  2. Paste it into the Debug Log field in the bug report template
  3. For long logs, attach the file directly to the GitHub issue

Sensitive Information

The DEBUG log may contain file paths and notebook names from your reMarkable tablet. It does not log passwords or API tokens. Review the log before posting if you’re concerned about privacy.

This site is open source. Improve this page.