ReadStor is both an executable binary that can be run, and a library that can be used in Rust programs.
Installing the command-line executable
Assuming you have Rust/Cargo installed , run this command in a terminal:
cargo install readstor
It will make the readstor command available in your PATH if you've allowed the PATH to be modified when installing Rust . cargo uninstall readstor uninstalls.
Adding lib library as a dependency
Run this command in a terminal, in your project's directory:
cargo add readstor
To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:
readstor = "0.6.0"
The lib library will be automatically available globally.
Read the lib library documentation .
Back to the crate overview .
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 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 for usage information.
Installation
Using Homebrew
brew tap tnahs/formulas
brew install readstor
readstor -- version
Using Cargo
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
macOS Ventura 13.x
macOS Monterey 12.x
macOS Big Sur 11.x
iOS
Limitations
Libraries that are synced with iCloud Drive are not supported.