Global

The following options affect all Commands.

--output-directory <PATH>

Set the output directory for all Commands.

Default: ~/.readstor.

--databases-directory <PATH>

Set the directory containing macOS's Apple Books databases

Default: ~/Library/Containers/com.apple.iBooksX/Data/Documents

The databases directory should contain the databases for macOS's Apple Books. These databases are: AEAnnotation*.sqlite and BKLibrary*.sqlite. The directory should follow the following structure:

[databases-directory]
 │
 ├── AEAnnotation
 │   ├── AEAnnotation*.sqlite
 │   └── ...
 │
 ├── BKLibrary
 │   ├── BKLibrary*.sqlite
 │   └── ...
 └── ...

This can be useful when running ReadStor on databases backed-up with the backup command. Note that the backup command produces an output structure identical to this. So backing up and extracting data would require little effort.

--plists-directory <PATH>

Set the directory containing iOS's Apple Books plists

Experimental! Extracting data from Apple Books for iOS hasn't been tested as thoroughly as its macOS counterpart. Please submit an issue if you run into any.

The plists directory should contain the Books.plist and com.apple.ibooks-sync.plist. The directory should follow the following structure:

[plists-directory]
 │
 ├── Books.plist
 ├── com.apple.ibooks-sync.plist
 └── ...

See iOS - Library Location and iOS - Access Library on how to retrieve these files.

--force

Run even if Apple Books is currently running.

--quiet

Silence output messages.