mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-09-05 19:08:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b90c72aea6838f9a70d79f95de89dcd40d21e522
ghostty/AGENTS.md
Mitchell Hashimoto b90c72aea6 Initial AGENTS.md 
I've been using agents a lot more with Ghostty and so are contributors.
Ghostty welcomes AI contributions (but they must be disclosed as AI
assisted), and this AGENTS.md will help everyone using agents work
better with the codebase.

This AGENTS.md has thus far been working for me very successfully,
despite being simple. I suspect we'll add to it as time goes on but I
also want to avoid making it too large and polluting the context.
2025-09-03 09:16:35 -07:00

561 B
Raw Blame History

Agent Development Guide

A file for guiding coding agents.

Commands

  • Build: zig build
  • Test (Zig): zig build test
  • Test filter (Zig): zig build test -Dtest-filter=<test name>
  • Formatting (Zig): zig fmt .
  • Formatting (other): prettier -w .

Directory Structure

  • Shared Zig core: src/
  • C API: include/ghostty.h
  • macOS app: macos/
  • GTK (Linux and FreeBSD) app: src/apprt/gtk-ng

macOS App

  • Do not use xcodebuild
  • Use zig build to build the macOS app and any shared Zig code