https://github.com/giannibyoung/kscribbler
Kobo highlight|annotation sync to hardcover.app
https://github.com/giannibyoung/kscribbler
ebook epub ereader-tools golang hardcover kepub kobo kobo-ereader
Last synced: 6 months ago
JSON representation
Kobo highlight|annotation sync to hardcover.app
- Host: GitHub
- URL: https://github.com/giannibyoung/kscribbler
- Owner: GianniBYoung
- License: gpl-3.0
- Created: 2025-04-06T01:24:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-20T15:29:05.000Z (about 1 year ago)
- Last Synced: 2025-07-21T11:56:38.946Z (about 1 year ago)
- Topics: ebook, epub, ereader-tools, golang, hardcover, kepub, kobo, kobo-ereader
- Language: Go
- Homepage:
- Size: 78.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# kscribbler
Sync your Kobo highlights to [hardcover.app](https://hardcover.app)!
Here is an [example](https://hardcover.app/books/crooked-kingdom/journals/@countmancy?referrer_id=28377) for the book Crooked Kingdom by Leigh Bardugo:
*K* - Kobo|kepub
*Scribe* - Someone who writes stuff to a new location
ps. add me on hardcover 🤓 [https://hardcover.app/@countmancy](https://hardcover.app/@countmancy?referrer_id=28377)
## Installation
1. Download and install [nickelmenu](https://pgaskin.net/NickelMenu)
2. Download the latest release of `kscribbler` from the [releases page](https://github.com/GianniBYoung/kscribbler/releases/latest)
3. Install `kscribbler` on your Kobo:
- Connect your Kobo to your computer and mount the device
- Navigate to the `.kobo` directory on your Kobo (might need to show hidden files)
- Copy the `KoboRoot.tgz` into this directory and unmount the device safely. This will trigger a reboot and upgrade.
4. Remount the device and navigate to `/mnt/onboard/.adds/kscribbler`.
- If you don't see this directory check for `/mnt/onboard/.adds/kscribbler`
5. Copy the example config file and add your token:
- `cp config.env.example config.env`
- `vi config.env`
## Upgrade
From the main menu of your Kobo device open nickelmenu and select `Update Kscribbler` to download and install the latest version.
## Usage
Once installed `nickelmenu` should have a new entry in the right corner of reading view that will trigger a sync when clicked.
This will trigger `kscribbler` to generate its database of quotes and upload them to hardcover.app.
WARNING: This will attempt to upload all quotes from all books on the device. If you want to tame this you will need to manipulate the `kscribblerdb` yourself. More info below.
The quotes are uploaded to hardcover.app based on the book's ISBN. See the note below or the troubleshooting section if quotes are not being uploaded.
- If your book doesn't have an ISBN saved to the kobo device's database you can highlight the book's ISBN on its copyright page and `kscribbler` will attempt to parse it and save it to the book's metadata.
- A note with `kscrib: Display hardcover *reading journal* quotes in your terminal or on a [trmnl e-ink display](https://usetrmnl.com)
- [simpleISBN](https://github.com/GianniBYoung/simpleISBN) -> A simple library to parse and convert ISBNs