Skip to content

Commit 3ab9663

Browse files
docs(readme): tighten the agent quickstart (#192)
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
1 parent 199b271 commit 3ab9663

2 files changed

Lines changed: 16 additions & 26 deletions

File tree

README.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,20 @@ git diff --no-color | hunk patch - # review a patch from stdin
6767

6868
### Working with agents
6969

70-
Load the [`skills/hunk-review/SKILL.md`](skills/hunk-review/SKILL.md) skill in your coding agent (e.g. Claude, Codex, Opencode, Pi).
70+
1. Open Hunk in another terminal with `hunk diff` or `hunk show`.
71+
2. Load the Hunk review skill: [`skills/hunk-review/SKILL.md`](skills/hunk-review/SKILL.md).
72+
3. Ask your agent to use the skill against the live Hunk session.
7173

72-
You can get the absolute path to the skill file from your local install by running `hunk skill path`. Prefer loading or symlinking that file in your agent instead of copying it so Hunk upgrades stay in sync automatically.
74+
A good generic prompt is:
75+
76+
```text
77+
Load the Hunk skill and use it for this review.
78+
```
7379

74-
Open Hunk in another window, then ask your agent to leave comments. For the full live-session and `--agent-context` workflow guide, see [docs/agent-workflows.md](docs/agent-workflows.md).
80+
> [!NOTE]
81+
> `hunk skill path` lands in Hunk 0.10.0. Until that release is out, load the skill from the repo path above.
82+
83+
For the full live-session and `--agent-context` workflow guide, see [docs/agent-workflows.md](docs/agent-workflows.md).
7584

7685
## Feature comparison
7786

@@ -136,27 +145,6 @@ git config --global alias.hdiff "-c core.pager=\"hunk pager\" diff"
136145
git config --global alias.hshow "-c core.pager=\"hunk pager\" show"
137146
```
138147

139-
### Agent workflows
140-
141-
Hunk supports two agent workflows:
142-
143-
- steer a live Hunk window from another terminal with `hunk session ...` (recommended)
144-
- load agent comments from a file with `--agent-context`
145-
146-
Start by loading the Hunk review skill: [`skills/hunk-review/SKILL.md`](skills/hunk-review/SKILL.md).
147-
148-
You can get the absolute path to the skill file from your local install by running `hunk skill path`.
149-
150-
A good generic prompt is:
151-
152-
```text
153-
Load the Hunk skill and use it for this review.
154-
```
155-
156-
That skill teaches the agent how to inspect a live Hunk session, navigate it, reload it, and leave inline comments.
157-
158-
For more, see [docs/agent-workflows.md](docs/agent-workflows.md).
159-
160148
### OpenTUI component
161149

162150
Hunk also publishes `HunkDiffView` from `hunkdiff/opentui` for embedding the same diff renderer in your own OpenTUI app.

docs/agent-workflows.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ Use Hunk with agents in two ways:
99

1010
1. Open Hunk in one terminal with a normal review command such as `hunk diff` or `hunk show`.
1111
2. Load the Hunk review skill: [`skills/hunk-review/SKILL.md`](../skills/hunk-review/SKILL.md).
12-
3. If your agent needs an absolute path to the skill file, run `hunk skill path` from your local install.
13-
4. Ask the agent to use the skill and review the current session.
12+
3. Ask the agent to use the skill and review the current session.
13+
14+
> [!NOTE]
15+
> `hunk skill path` lands in Hunk 0.10.0. Until that release is out, load the skill from the repo path above.
1416
1517
A good generic prompt is:
1618

0 commit comments

Comments
 (0)