repos / zmx

AGENTS.md

 1# zmx
 2
 3The goal of this project is to create a way to attach and detach terminal sessions without killing the underlying linux process.
 4
 5When researching `zmx`, also read the @README.md in the root of this project directory to learn more about the features, documentation, prior art, etc.
 6
 7## tech stack
 8
 9- `zig` v0.15.1
10- `libghostty-vt` for terminal escape codes and terminal state management
11
12## commands
13
14- **Build:** `zig build`
15- **Build Check (Zig)**: `zig build check`
16- **Test (Zig):** `zig build test`
17- **Test filter (Zig)**: `zig build test -Dtest-filter=<test name>`
18- **Formatting (Zig)**: `zig fmt .`
19
20## find any library API definitions
21
22Before trying anything else, run the `zigdoc` command to find an API with documentation:
23
24```
25zigdoc {symbol}
26# examples
27zigdoc ghostty-vt
28zigdoc std.ArrayList
29zigdoc std.mem.Allocator
30zigdoc std.http.Server
31```
32
33Only if that doesn't work should you grep the project dir.
34
35## find zig std library source code
36
37To inspect the source code for zig's standard library, look inside the `zig_std_src` folder.
38
39## find ghostty library source code
40
41To inspect the source code for zig's standard library, look inside the `ghostty_src` folder.
42
43## Issue Tracking
44
45We use bd (beads, https://github.com/steveyegge/beads) for issue tracking instead of Markdown TODOs or external tools.
46
47Run `bd quickstart` to learn how to use it.