Skip to content

docs(readme): add keyboard shortcuts guide #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hugows wants to merge 2 commits into
base: main
Choose a base branch
from
+33 −0
Open

docs(readme): add keyboard shortcuts guide #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebd9f3f
docs(readme): add keyboard shortcuts guide
hugows May 7, 2026
b74ce64
Update README.md with Shift note
hugows May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ All notable user-visible changes to Hunk are documented in this file.

### Added

- Added a GitHub-facing keyboard shortcuts section to the README.

### Changed

### Fixed
Expand Down
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,37 @@ hunk # show help
hunk --version # print the installed version
```

## Keyboard shortcuts

Press `?` in Hunk to open the full in-app controls help.

### Navigation

- `↑` / `↓` or `j` / `k` — move line by line
- `Space` / `f` / `PageDown` — page down
- `b` / `PageUp` / `Shift+Space` — page up
- `d` / `u` — half page down / up
- `Home` / `End` — jump to top / bottom
- `[` / `]` — previous / next hunk
- `{` / `}` — previous / next comment
- `←` / `→` — scroll code horizontally (`Shift+←` / `Shift+→` for faster scrolling)

### View

- `1` / `2` / `0` — split / stack / auto layout
- `s` — toggle sidebar
- `t` — cycle theme
- `a` — toggle AI notes
- `l` / `w` / `m` — line numbers / wrap / metadata

### Review

- `/` — focus file filter
- `Tab` — toggle files/filter focus
- `F10` — open menus
- `r` — reload, when supported
- `q` / `Esc` — quit

### Working with Git

Hunk mirrors Git's diff-style commands, but opens the changeset in a review UI instead of plain text.
Expand Down