https://github.com/tnahs/readstor
A CLI for Apple Books annotations
https://github.com/tnahs/readstor
apple books highlights ibooks macos
Last synced: 15 days ago
JSON representation
A CLI for Apple Books annotations
- Host: GitHub
- URL: https://github.com/tnahs/readstor
- Owner: tnahs
- License: apache-2.0
- Created: 2021-10-30T02:07:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T15:52:57.000Z (4 months ago)
- Last Synced: 2025-04-15T01:39:55.486Z (about 1 month ago)
- Topics: apple, books, highlights, ibooks, macos
- Language: Rust
- Homepage: https://tnahs.github.io/readstor/
- Size: 71.1 MB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
ReadStor - A CLI for Apple Books annotations
ReadStor is a simple CLI for exporting user-generated data from Apple Books. The
goal of this project is to facilitate data-migration from Apple Books to any
other platform. Currently, Apple Books provides no simple way to do this.
Exporting is possible but not ideal and often times truncates long annotations.
Version `0.1.x` contained the core functionality: (1) save all annotations and
notes as JSON (2) render them via a custom (or the default) template using the
[Tera][tera] syntax or (3) backup the current Apple Books databases.
Note that this repository is a heavy work-in-progress and things are bound to
change.
## Usage
See the [documentation][documentation] for usage information.
## Installation
### Using Homebrew
```shell
brew tap tnahs/formulas
brew install readstor
```
```shell
readstor --version
```
### Using Cargo
```shell
cargo install readstor
```
## Version Support
Apple Books' data schema can change with any update. The following versions have been verified
as working. This is an ever-growing, non-exhaustive list of verified versions. If a version isn't
listed, it doesn't necessarily mean it isn't supported.
### macOS
- macOS Sonoma 14.x
- Apple Books 6.x
- macOS Ventura 13.x
- Apple Books 5.x
- macOS Monterey 12.x
- Apple Books 4.x
- macOS Big Sur 11.x
- Apple Books 3.x
### iOS
- iOS 16.x
## Limitations
Libraries that are synced with iCloud Drive are not supported.
[documentation]: https://tnahs.github.io/readstor/
[tera]: https://keats.github.io/tera/