Skip to content

Installation on MacOS

Jakub Tymejczyk edited this page Apr 4, 2026 · 5 revisions

⚠️ Known Issues

  • No binarie downloads on the release page yet, but you can download artifacts from each commit/PR tests.
  • The App won't ever be sandboxed, hardened, notarized or signed. If you do not trust the binaries otherwise, please build the app from source yourself.

Installation

  1. Choose a release from the releases page.
  2. Click on the release tag.
An arrow points to the tag field of a release
  1. View workflows for the latest commit and select details for any macOS release. (Click on the little green checkmark or little red x, which will open a dialog, where you need to look for "macOS". Then click on "Details" at the end of the same line.)
image
  1. Click on the heading "Summary" on the left hand side. Then download the artifact appropriate for the CPU architecture of your device. Apple Silicon macs use arm64. You have to be logged in into GitHub account in order to download listed file.
  2. Decompress the zip file.
  3. Move the application somewhere outside of the ~/Downloads folder.
  4. On macOS below 15.6: Right click and open the application to bypass gatekeeper. On macOS > 15.7: Right click and open the application. Close the warning. Open "System Settings" > "Privacy & Security" and scroll all the way down. There it will say '"KOReader" was blocked to protect your Mac.". Click on "Open Anyway". You only need to do this for the first launch.

CLI interface

If you want to access koreader using the commandline don't do a symlink. Just export the PATH.

For example: for /Applications/KOReader.app do export PATH=$PATH:/Applications/KOReader.app/Contents/MacOS

Usage

Basic reading controls (click to open)
Advanced reading controls (click to open)

Clone this wiki locally