Skip to content

Commit 4d141b2

Browse files
committed
docs: refresh agent guidance
1 parent cd14a61 commit 4d141b2

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,17 @@
1010

1111
```text
1212
CLI input
13+
-> parse runtime + config-backed view options
1314
-> normalize into one Changeset / DiffFile model
14-
-> App shell coordinates state and pane layout
15+
-> App shell coordinates state, layout, and review navigation
1516
-> pane components render review UI
1617
-> Pierre-backed terminal renderer draws diff rows
1718
```
1819

19-
- Input modes: `git`, `diff`, `patch`, `difftool`.
20+
- CLI entrypoints: `diff`, `show`, `stash show`, `patch`, `pager`, `difftool`.
2021
- All input sources normalize into one internal changeset model.
22+
- Pager mode has two paths: full diff UI for patch-like stdin, plain-text fallback for non-diff pager content.
23+
- View defaults are layered through built-ins, user config, repo `.hunk/config.toml`, command sections, pager sections, and CLI flags.
2124
- Agent rationale is optional sidecar JSON matched onto files/hunks.
2225
- The order of `files` in the sidecar is intentional. Hunk uses that order for the sidebar and main review stream.
2326

@@ -54,10 +57,12 @@ CLI input
5457
## commands
5558

5659
- install deps: `bun install`
57-
- run from source: `bun run src/main.tsx -- git`
58-
- fast smoke test: `bun run src/main.tsx diff /tmp/before.ts /tmp/after.ts`
60+
- run from source: `bun run src/main.tsx -- diff`
61+
- review a commit from source: `bun run src/main.tsx -- show HEAD~1`
62+
- fast smoke test: `bun run src/main.tsx -- diff /tmp/before.ts /tmp/after.ts`
5963
- typecheck: `bun run typecheck`
6064
- tests: `bun test`
65+
- TTY smoke test: `bun run test:tty-smoke`
6166
- build binary: `bun run build:bin`
6267
- install binary: `bun run install:bin`
6368

@@ -69,7 +74,8 @@ CLI input
6974

7075
## verification
7176

72-
- For rendering changes: run `bun run typecheck`, `bun test`, and do one real TTY smoke run on an actual diff.
77+
- For rendering changes: run `bun run typecheck`, `bun test`, `bun run test:tty-smoke`, and do one real TTY smoke run on an actual diff.
78+
- For CLI, config, or pager work: make sure the relevant source invocation still works (`diff`, `show`, `patch`, or `pager`).
7379
- Preserve current interaction model unless the user asks to change it explicitly.
7480

7581
## repo notes

0 commit comments

Comments
 (0)