xonecas.io
725
Ds

diff-scope / files

diff-scope / AGENTS.md

1.5 KB
1# diff-scope — Agent Guide
2
3## Project
4
5Build a live git diff viewer as a terminal app with `cel-tui`.
6
7## Stack
8
9- Runtime, package management, and script execution: `bun`
10- One-off tools like Prettier or Biome: `bunx`
11- Language: TypeScript
12- TUI framework: `cel-tui`
13
14## Current Repo Layout
15
16- `src/index.ts` — current app entrypoint and TUI
17- `package.json` — Bun scripts and dependencies
18- `.agents/skills/cel-tui/` — local cel-tui skill and references
19
20## Current App Status
21
22The current app already has:
23
24- a scrollable git diff view
25- staged and unstaged diff rendering in one snapshot
26- diff highlighting and wrapped long lines
27- a bottom status bar with cwd, branch, git status summary, and refresh mode
28- pending-change detection every 5 seconds
29- manual refresh with `r`
30- auto-refresh toggle with `ctrl+r`
31- adjustable auto-refresh interval controls with `pageup` / `pagedown`
32- a help/about modal toggled with `?` and closed with `?` or `Esc`
33
34## Commands
35
36```bash
37bun install
38bun run start
39bun run dev
40bun run typecheck
41```
42
43## Working Rules
44
45- Use `bun` and `bunx` instead of `node`, `npm`, `npx`, or `yarn`.
46- Use `cel-tui` for the UI. Do not introduce another TUI framework unless the user asks for it.
47- Keep the app focused on the git diff live viewer; avoid side systems the user did not request.
48- Prefer simple shelling out to `git` over adding a git library unless the user asks for one.
49- When making `cel-tui` implementation decisions or checking framework behavior, load `.agents/skills/cel-tui/SKILL.md` first.