Skip to content

Commit d4b80f4

Browse files
authored
docs: group README setup under Advanced (#82)
* docs: group README setup under Advanced * docs: format Hunk skill prompt as block
1 parent 378b8b9 commit d4b80f4

1 file changed

Lines changed: 33 additions & 29 deletions

File tree

README.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,26 @@ Open Hunk in another window, then ask your agent to leave comments.
8585

8686
Hunk is optimized for reviewing a full changeset interactively.
8787

88-
## Git integration
88+
## Advanced
89+
90+
### Config
91+
92+
You can persist preferences to a config file:
93+
94+
- `~/.config/hunk/config.toml`
95+
- `.hunk/config.toml`
96+
97+
Example:
98+
99+
```toml
100+
theme = "graphite" # graphite, midnight, paper, ember
101+
mode = "auto" # auto, split, stack
102+
line_numbers = true
103+
wrap_lines = false
104+
agent_notes = false
105+
```
106+
107+
### Git integration
89108

90109
Set Hunk as your Git pager so `git diff` and `git show` open in Hunk automatically:
91110

@@ -107,47 +126,26 @@ git config --global alias.hdiff "-c core.pager=\"hunk pager\" diff"
107126
git config --global alias.hshow "-c core.pager=\"hunk pager\" show"
108127
```
109128

110-
## Examples
111-
112-
Ready-to-run demo diffs live in [`examples/`](examples/README.md).
113-
114-
Each example includes the exact command to run from the repository root.
115-
116-
## Config
117-
118-
You can persist preferences to a config file:
119-
120-
- `~/.config/hunk/config.toml`
121-
- `.hunk/config.toml`
122-
123-
Example:
124-
125-
```toml
126-
theme = "graphite" # graphite, midnight, paper, ember
127-
mode = "auto" # auto, split, stack
128-
line_numbers = true
129-
wrap_lines = false
130-
agent_notes = false
131-
```
132-
133-
## Working with Agents
129+
### Agent workflows
134130

135131
Hunk supports two agent workflows:
136132

137133
- steer a live Hunk window from another terminal with `hunk session ...` (recommended)
138134
- load agent comments from a file with `--agent-context`
139135

140-
### Steer a live Hunk window
136+
#### Steer a live Hunk window
141137

142138
Use the Hunk review skill: [`skills/hunk-review/SKILL.md`](skills/hunk-review/SKILL.md).
143139

144140
A good generic prompt is:
145141

146-
- "Load the Hunk skill and use it for this review."
142+
```text
143+
> Load the Hunk skill and use it for this review
144+
```
147145

148146
That skill teaches the agent how to inspect a live Hunk session, navigate it, reload it, and leave inline comments.
149147

150-
### How remote control works
148+
#### How remote control works
151149

152150
When a Hunk TUI starts, it registers with a local loopback daemon. `hunk session ...` talks to that daemon to find the right live window and control it.
153151

@@ -174,7 +172,7 @@ hunk session comment clear --repo . --file README.md --yes
174172

175173
`hunk session reload ... -- <hunk command>` swaps what a live session is showing without opening a new TUI window.
176174

177-
### Load agent comments from a file
175+
#### Load agent comments from a file
178176

179177
Use `--agent-context` to attach agent-written comments or rationale from a JSON sidecar file. For a compact real example, see [`examples/3-agent-review-demo/agent-context.json`](examples/3-agent-review-demo/agent-context.json).
180178

@@ -183,6 +181,12 @@ hunk diff --agent-context notes.json
183181
hunk patch change.patch --agent-context notes.json
184182
```
185183

184+
## Examples
185+
186+
Ready-to-run demo diffs live in [`examples/`](examples/README.md).
187+
188+
Each example includes the exact command to run from the repository root.
189+
186190
## Contributing
187191

188192
For source setup, tests, packaging checks, and repo architecture, see [CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)