AGENTS.md

1# macOS Ghostty Application
2 
3- Use `swiftlint` for formatting and linting Swift code.
4- If code outside of `macos/` directory is modified, use
5  `zig build -Demit-macos-app=false` before building the macOS app to update
6  the underlying Ghostty library.
7- Use `macos/build.nu` to build the macOS app, do not use `zig build`
8  (except to build the underlying library as mentioned above).
9  - Build: `macos/build.nu [--scheme Ghostty] [--configuration Debug] [--action build]`
10  - Output: `macos/build/<configuration>/Ghostty.app` (e.g. `macos/build/Debug/Ghostty.app`)
11- Run unit tests directly with `macos/build.nu --action test`
12 
13## AppleScript
14 
15- The AppleScript scripting definition is in `macos/Ghostty.sdef`.
16- Guard AppleScript entry points and object accessors with the
17  `macos-applescript` configuration (use `NSApp.isAppleScriptEnabled`
18  and `NSApp.validateScript(command:)` where applicable).
19- In `macos/Ghostty.sdef`, keep top-level definitions in this order:
20  1. Classes
21  2. Records
22  3. Enums
23  4. Commands
24- Test AppleScript support:
25  (1) Build with `macos/build.nu`
26  (2) Launch and activate the app via osascript using the absolute path
27      to the built app bundle:
28      `osascript -e 'tell application "<absolute path to build/Debug/Ghostty.app>" to activate'`
29  (3) Wait a few seconds for the app to fully launch and open a terminal.
30  (4) Run test scripts with `osascript`, always targeting the app by
31      its absolute path (not by name) to avoid calling the wrong
32      application.
33  (5) When done, quit via:
34      `osascript -e 'tell application "<absolute path to build/Debug/Ghostty.app>" to quit'`
35