https://github.com/robrohan/stitch
Command line application to extract highlights from Kobos and Kindle ebook readers
https://github.com/robrohan/stitch
cli highlights kindle kindle-highlights kobo kobo-highlights
Last synced: about 1 month ago
JSON representation
Command line application to extract highlights from Kobos and Kindle ebook readers
- Host: GitHub
- URL: https://github.com/robrohan/stitch
- Owner: robrohan
- License: mit
- Created: 2022-12-18T00:46:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T06:03:03.000Z (10 months ago)
- Last Synced: 2025-04-01T15:23:01.068Z (7 months ago)
- Topics: cli, highlights, kindle, kindle-highlights, kobo, kobo-highlights
- Language: C
- Homepage:
- Size: 2.22 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Stitch
Stitch is a command line application that extracts highlights from Kindle and Kobo devices. It puts the output into
a local json file which can then be further processed.
Quick example:
```bash
./stitch -t kindle -o kindle.json; \
jq ".[].text" kindle.json \
| sort \
| uniq
```
```bash
cat kobo.json | jq '.[] | select(.title | contains("Le petit Nicolas")) | .'
```
## Running
### Mac
Since the binary is not signed, you must first let Mac OS know the binary is ok to run. Do the following:
- Download the zip file
- Double click it. It will extract the file.
- Using Finder, right click on the file _stitch_, and select _Open_.
- A terminal window will open, and then close.
After that process, you can then use the binary via terminal.
Now, you can open terminal.app, and run:
```bash
% ./stitch -h
[KS] main (src/main.c:27) Using user: robrohan
Usage: ./stitch [-i input_file] [-o output_file.json] -t [kobo|kindle]
Input example:
Kindle: '/media/robrohan/Kindle/documents/My Clippings.txt'
Kobo: '/media/robrohan/KOBOeReader/.kobo/KoboReader.sqlite'
```
**Importing from Kindle**
Here is an example of using Mac OS to extract highlights from Kindle:
```bash
./stitch -t kindle -i "/Volumes/Kindle/documents/My Clippings.txt" -o kindle.json
```
**Importing from Kobo**
Kobo is similar:
```bash
./stitch -t kobo -i "/Volumes/KOBOeReader/.kobo/KoboReader.sqlite" -o kobo.json
```
### Linux
Importing data on Linux is similar to Mac. However the path is based on the current user not
a global location:
**Kobo**
```bash
stitch -t kobo -i '/media/username/KOBOeReader/.kobo/KoboReader.sqlite' -o kobo.json
```
**Kindle**
```bash
stitch -t kindle -i '/media/username/Kindle/documents/My Clippings.txt' -o kindle.json
```
## Building from Source
Stitch is using _clang_ by default. You'll need to make sure that is installed and setup.
### The Basics
```bash
make
```
### SQLite
SQLite code is already included in the source directory, however to update the code you'll need
to do the following:
- Download the source into vendor (_vendor/sqlite3_).
- Then run from within that directory:
```bash
sh configure
make sqlite3.c
```
- Then move _sqlite3.c_ and _sqlite3.h_ into the src directory.
- From that point forward, the _vendor/sqlite3_ directory is not used.