Skip to content

Commit 357363f

Browse files
committed
docs: update README with new features since v0.1.0
Added documentation for: - Help overlay (? key) - Vim-style line jumping (:number) - Mouse scroll support - Filter history navigation (Up/Down arrows) Updated keyboard controls section and marked completed features in the roadmap.
1 parent 6c588a0 commit 357363f

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,15 @@ A fast, universal terminal-based log viewer with live filtering and follow mode.
99
- **TUI interface** - Clean terminal UI with ratatui
1010
- **Line selection** - Navigate through logs with keyboard controls
1111
- **Live filtering** - See results instantly as you type your search string
12+
- **Filter history** - Navigate previous filter patterns with Up/Down arrows
1213
- **Background filtering** - Non-blocking regex and string matching filters
1314
- **File watching** - Auto-reload when log file is modified (using inotify on Linux)
1415
- **Follow mode** - Auto-scroll to show latest logs as they arrive (like `tail -f`)
1516
- **ANSI color support** - Parses and renders ANSI escape codes in full color
1617
- **Raw view mode** - Display logs in their original format with line numbers
1718
- **Memory efficient** - Viewport-based rendering keeps RAM usage low
19+
- **Help overlay** - Built-in keyboard shortcut reference (`?` key)
20+
- **Vim-style navigation** - Line jumping (`:123`), vim keybindings, mouse scroll
1821

1922
### Keyboard Controls
2023

@@ -25,17 +28,21 @@ A fast, universal terminal-based log viewer with live filtering and follow mode.
2528
- `PgDn` - Scroll down one page
2629
- `g` - Jump to start (first line)
2730
- `G` - Jump to end (last line)
31+
- `:123` - Jump to line 123 (vim-style)
2832
- `f` - Toggle follow mode (auto-scroll to new logs)
33+
- Mouse wheel - Scroll up/down (selection follows scroll)
2934

3035
**Filtering:**
3136
- `/` - Enter live filter mode
3237
- Type any text - Results update instantly as you type
38+
- ``/`` - Navigate filter history (in filter mode)
3339
- `Backspace` - Delete characters
3440
- `Enter` - Close filter prompt (keeps filter active, shown in title bar)
3541
- `Esc` - Clear filter and close prompt
3642
- Active filter phrase is always visible in the window title
3743

3844
**General:**
45+
- `?` - Show help overlay with all keyboard shortcuts
3946
- `q` or `Ctrl+C` - Quit
4047

4148
## Installation
@@ -95,6 +102,22 @@ Options:
95102

96103
The filter searches through all lines in the background without blocking the UI, so even with large files the interface remains responsive.
97104

105+
**Filter History:**
106+
- Press `` while in filter mode to recall previous filter patterns
107+
- Press `` to navigate forward through history
108+
- Up to 50 recent filter patterns are saved
109+
- Selecting from history immediately applies the filter
110+
111+
### Jumping to Line Numbers
112+
113+
You can jump directly to any line number using vim-style syntax:
114+
1. Press `:` to enter line jump mode
115+
2. Type the line number - e.g., `:150`
116+
3. Press `Enter` to jump to that line
117+
4. Press `Esc` to cancel
118+
119+
This works in both normal and filtered views. In filtered view, it jumps to the nearest matching line.
120+
98121
### Using Follow Mode
99122

100123
**Follow Mode** allows you to automatically scroll to new log lines as they're written to the file (like `tail -f`):
@@ -156,12 +179,15 @@ Any plain text log file works - from development logs to production system logs,
156179
- [x] Interactive filter input
157180
- [x] Live filter preview
158181
- [x] Follow mode (tail -f style)
182+
- [x] Line number jump (vim-style `:number`)
183+
- [x] Filter history navigation
184+
- [x] Mouse scroll support
185+
- [x] Help overlay
159186
- [ ] STDIN support for piping logs
160187
- [ ] Regex filter mode (regex parsing already implemented)
161188
- [ ] JSON log parsing and formatting
162189
- [ ] Multiple display modes
163190
- [ ] Search highlighting
164-
- [ ] Line number jump
165191
- [ ] Copy selected line
166192
- [ ] Case-sensitive filter toggle
167193
- [ ] Bookmark lines

0 commit comments

Comments
 (0)