1. Requirements
- macOS 14 or later according to the app bundle metadata.
- A Swift 6 toolchain and Git. Xcode or the Command Line Tools provide Swift; development used Swift 6.3.2 with the Command Line Tools.
- An internet connection only for cloning and, if you choose one, a cloud provider. The Mock provider sends nothing; Ollama needs a locally available model.
The running app needs Accessibility access to read – and where possible replace – selected text in other apps.
2. Get the repository
The following command downloads the source into a new folder.
git clone https://github.com/masiv42/AYVI.git AYVI
cd AYVI
Expected: Git creates the folder AYVI. Do not run install commands from untrusted sources.
3. Check the build and create the app bundle
Run the SwiftPM build first. It compiles the app but does not start it.
swift --version
swift build -j 2
./scripts/bundle.sh
Expected: Swift reports version 6.x; the build ends with “Build complete”; the script verifies a temporary bundle and installs only the app at /Applications/AYVI.app. With IVY_INSTALL=0 it verifies the build and leaves no app bundle behind. Without the local developer certificate the script uses ad-hoc signing; then the Accessibility permission has to be granted again after every build. The bundle is not notarized.
open "/Applications/AYVI.app"
These build steps were run in the repository. They do not prove a successful start or working Accessibility integration on every macOS configuration.
4. Allow Accessibility access
- Start AYVI once.
- Open System Settings → Privacy & Security → Accessibility.
- Enable AYVI. If it is missing, add
/Applications/AYVI.appwith the app picker. - Quit and reopen the app if macOS asks for it.
After a new build: ad-hoc signed apps can look like a new app identity to macOS. If the permission is on but AYVI keeps asking, remove only the old AYVI entry and add the current bundle again. Do not reset other permissions wholesale.
If Gatekeeper warns about an unverified app, do not ignore or bypass the warning blindly. Check the origin and source yourself and then decide, using Apple’s official guidance, whether you want to open this development app.
5. A careful first test
- Start AYVI and check that the menu bar icon is there.
- Select harmless sample text first, no confidential data.
- Press the configured shortcut (default: ⌥ Space).
- Choose a local action in Quick Mode and check the provider shown.
- For a normal replacement, review the diff and confirm or cancel. Direct Improve is a separate mode, on by default, without a second confirmation; use it only when that is exactly what you want.
Real target-app compatibility has not been systematically checked. If the selection or panel does not appear as expected, see troubleshooting. To run the automated tests: ./scripts/test.sh.