agentleFS
Sign inStart free
ghostty-orgghostty-org/ghostty/example/AGENTS.md

ghostty / example

AGENTS.md63k starsChanged 8 months agoMITView on GitHub

Each example is a standalone project with its own build.zig, build.zig.zon, README.md, and src/main.c (or .zig). Examples are auto-discovered by CI via example/*/build.zig.zon, so no workflow file edits are needed when adding a new example. 1. Copy an existing example directory (e.g., c-vt-encode-focus/) as a starting point. 2. Update build.zig.zon: change .name, generate a new unique .fingerprint value (a random u64 hex literal), and keep .minimumzigversion matching the others. 3. Update build.zig: change the executable .name to match the directory.…

We split this AGENTS.md into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Update build.zig.zon: change .name, generate a new unique .fingerprint value (a random u64 hex literal), and keep .minimum_zig_version …

    line 12
  2. Very specific:

    Update build.zig: change the executable .name to match the directory.

    line 15
  3. Distinctive:

    Write a README.md following the existing format.

    line 16
  4. Very specific:

    All C examples link ghostty-vt via lazyDependency("ghostty", ...).

    line 38

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Example Libghostty Projects

Each example is a standalone project with its own build.zig, build.zig.zon, README.md, and src/main.c (or .zig). Examples are auto-discovered by CI via example/*/build.zig.zon, so no workflow file edits are needed when adding a new example.

Adding a New Example

  1. Copy an existing example directory (e.g., c-vt-encode-focus/) as a starting point.
  2. Update build.zig.zon: change .name, generate a new unique .fingerprint value (a random u64 hex literal), and keep .minimum_zig_version matching the others.
  3. Update build.zig: change the executable .name to match the directory.
  4. Write a README.md following the existing format.

Doxygen Snippet Tags

Example source files use Doxygen @snippet tags so the corresponding header in include/ghostty/vt/ can reference them. Wrap the relevant code with //! [snippet-name] markers:

//! [my-snippet]
int main() { ... }
//! [my-snippet]

The header then uses @snippet <dir>/src/main.c my-snippet instead of inline @code blocks. Never duplicate example code inline in the headers — always use @snippet. When modifying example code, keep the snippet markers in sync with the headers in include/ghostty/vt/.

Conventions

  • Executable names use underscores: c_vt_encode_focus (not hyphens).
  • All C examples link ghostty-vt via lazyDependency("ghostty", ...).
  • build.zig files follow a common template — keep them consistent.

Download now (ZIP)

Trending

Less talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 5 mentionsFeb 2026: 7 mentionsMar 2026: 8 mentionsApr 2026: 6 mentionsMay 2026: 2 mentionsJun 2026: 1 mentionJul 2026: 2 mentionsAug 2026: 7 mentionsSep 2026: 0 mentionsOct 2026: 1 mentionNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the ghostty-org/ghostty repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about ghostty-org/ghostty

The biggest 5 of 103 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 103

Talked about on GitHub, YouTube, Hacker News, Bluesky and the web (103 times).

On GitHub · 35

30 more on GitHub

On YouTube · 24

19 more on YouTube

On Hacker News · 20

15 more on Hacker News

On Bluesky · 20

15 more on Bluesky
  • Other versions1 project uses a version of this.

    Word for word · 1

    1. Wescholm/ghostty-fleet★ 1100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free