About this skill

Problem: WeRead notes stay trapped in the app

WeRead comments, highlights, and reading progress usually remain tied to the account and mobile app, with little structure for local search, version control, or downstream processing. The practical pain is not just exporting once; it is keeping a maintainable copy over time. weread-sync addresses that by pulling WeRead notes into local Markdown files.

How it works: login, incremental sync, export

The workflow is compact: use weread-sync login to establish a local session, then use weread-sync sync to fetch notes and export Markdown. Syncing is not a blind full download: it uses fingerprints such as note count, comment count, and progress to detect changed books, and skips unchanged ones. When a full re-export is needed, --force can be used.

Key capabilities include:
- Local Markdown export: useful for personal knowledge bases, full-text search, and static publishing.
- Incremental sync: reduces repeated fetching and fits periodic jobs.
- Single-book debugging: book-probe fetches live details, highlights, comments, and chapters for one book.
- Local visualization: demo opens a local page to browse synced books and cached Markdown notes.

Boundaries

This tool is best suited for turning existing reading traces into a local, inspectable corpus. It is not a replacement for WeRead’s reading experience, nor a guarantee that cloud data formats or availability will remain stable. For multi-account pipelines, strict auditing, or high-volume scraping, still review session security, request frequency, and interface stability.

Screenshots

Use Cases

When organizing personal reading notes, export WeRead highlights and comments as Markdown for search and citation.
When building a local knowledge base, periodically sync only changed books to avoid re-exporting unchanged content.
When debugging a sync issue, probe one book for live details, chapters, highlights, and comments.
When checking local cache state, inspect the export directory, login status, and synced book count.

Best For

Personal knowledge-base maintainers who need WeRead highlights and comments in local Markdown.
Analysts who need structured note text before doing reading-data statistics.
Developers debugging highlights, comments, and chapter sync for a single book.
Independent researchers who want a local visual page to inspect synced notes.