docs/manual/install.org

• macOS 26 or later.
• Xcode 27 (the Swift 6.2 toolchain).
• Optional: GNU Emacs, for the features that hand work to it on the Mac (Emacs Lisp code blocks that need full Emacs, Lisp table formulas the built-in interpreter can't run, and export to PDF, LaTeX, ODT and other formats). See Working alongside Emacs and other tools.

git clone https://gitbay.org/krz/orgstar.git
cd orgstar
scripts/build-app.sh
open .build/app/Orgstar.app

scripts/build-app.sh builds a release binary and assembles .build/app/Orgstar.app with its Quick Look and Spotlight extensions, signed ad hoc for use on your own Mac. Move it to /Applications to keep it. Pass a version number as the first argument to stamp the bundle (scripts/build-app.sh 1.0.0); the default is 0.1.0.

Once the app has been launched, Finder opens .org files with it, Quick Look shows them formatted, and Spotlight indexes their headings and text.

The iOS app (iOS 26 or later) is built with Xcode from ios/Orgstar.xcodeproj:

1. Open ios/Orgstar.xcodeproj.
2. Select the Orgstar iOS target, then Signing & Capabilities, and choose your team. Change the bundle identifiers (sh.krz.orgstar and the three extensions' .share, .quicklook and .widgets) and the App Group (group.sh.krz.orgstar) to ones your team can register.
3. Choose your iPhone or iPad (or a Simulator) as the destination and Run (⌘R).

On a device, Developer Mode must be on (Settings ▸ Privacy & Security ▸ Developer Mode).

For the Simulator without opening Xcode (this build has no widgets):

scripts/build-ios-app.sh
xcrun simctl install booted .build/ios-app/Orgstar.app

See iPhone and iPad for what it does.

Pull and build again:

git pull
scripts/build-app.sh

Your settings live in ~/.config/orgstar/ and survive rebuilds.

Delete Orgstar.app. To remove your settings as well, delete ~/.config/orgstar/. Your org files are never stored inside the app.