Skip to content

Commit 70efd31

Browse files
ozgesolidkeyclaude
andcommitted
Update README with comprehensive feature list and 14M+ line scale
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 8a90515 commit 70efd31

1 file changed

Lines changed: 60 additions & 19 deletions

File tree

README.md

Lines changed: 60 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,49 @@
11
# LOGAN - Log Analyzer
22

3-
A fast, feature-rich log file viewer built with Electron.
3+
A blazing-fast log file viewer built with Electron, designed for **massive log files**. Tested and working with files up to **14 million+ lines** — virtual scrolling keeps it smooth no matter how big the file gets.
44

55
## Features
66

7-
- **Virtual scrolling** - Handle multi-million line log files smoothly
8-
- **Fast search** - Powered by ripgrep when available
9-
- **Multiple tabs** - Open and switch between multiple log files
10-
- **Bookmarks** - Mark important lines with comments
11-
- **Highlights** - Color-code patterns (per-file or global)
12-
- **Save to Notes** - Extract code snippets for later analysis
13-
- **Minimap** - Visual overview with error/warning indicators
14-
- **File splitting** - Split large files into manageable parts
15-
- **Zoom** - Adjust font size with Ctrl+/Ctrl-
7+
### Core Viewer
8+
- **Virtual scrolling** — Handles multi-million line files with constant memory usage and smooth 60fps scrolling
9+
- **Fast search** — Powered by ripgrep (10-100x faster), with regex, wildcard, whole word, and case-sensitive modes
10+
- **Multiple tabs** — Open and switch between log files without losing state
11+
- **Minimap** — Bird's-eye overview with color-coded error/warning indicators, click to jump
12+
- **Word wrap & zoom** — Toggle wrapping, adjust font size with Ctrl+/- or mouse wheel
13+
- **Column visibility** — Auto-detect delimited columns and show/hide them
14+
15+
### Analysis & Filtering
16+
- **Log analysis** — Pattern detection, duplicate grouping, level distribution, and time range stats
17+
- **Advanced filtering** — Multi-group filter expressions (AND/OR), level filters, include/exclude patterns, context lines
18+
- **Time gap detection** — Find gaps between timestamps with configurable thresholds and line/pattern ranges
19+
- **Search configs** — Persistent multi-pattern search with color-coded highlighting (Ctrl+8)
20+
21+
### Annotations
22+
- **Bookmarks** — Mark lines with comments and colors, save/load bookmark sets, export
23+
- **Highlights** — Color-code patterns with regex support, per-file or global, organized in groups
24+
- **Notes drawer** — Freeform notes per file with auto-save (Ctrl+Shift+N)
25+
- **Save snippets** — Extract selected line ranges to `.notes.txt` files for later reference
26+
27+
### Split & Diff
28+
- **File splitting** — Break huge files into manageable parts
29+
- **Split view** — View two files side by side
30+
- **Diff view** — Compare files with aligned hunk display, additions/deletions/modifications
31+
32+
### Video Player
33+
- **Log-to-video sync** — Open a screen recording alongside logs, set a sync point from any log line, then click lines to seek the video to the corresponding moment (Ctrl+9)
34+
- **Drag & drop** — Drop MP4/WebM/OGG files directly onto the panel
35+
- **Per-file persistence** — Video path and sync offset remembered per log file
36+
37+
### Integrations
38+
- **Built-in terminal** — Quake-style drop-down terminal, auto-cds to file directory (Ctrl+`)
39+
- **Datadog** — Fetch logs directly from Datadog APIs
40+
- **Folder browser** — Open folders, browse files, search across multiple files
41+
- **Activity history** — Track searches, filters, bookmarks, and other actions per file (Ctrl+7)
42+
43+
### Local Persistence
44+
- Per-file `.logan/` sidecar storage for bookmarks, highlights, notes, video sync, and history
45+
- Global `~/.logan/` for highlight groups, bookmark sets, and settings
46+
- State survives across sessions — reopen a file and everything is restored
1647

1748
## Requirements
1849

@@ -88,18 +119,28 @@ npm start
88119
| Shortcut | Action |
89120
|----------|--------|
90121
| Ctrl+O | Open file |
91-
| Ctrl+F | Find |
122+
| Ctrl+T | Open in new tab |
123+
| Ctrl+W | Close tab |
124+
| Ctrl+Tab / Ctrl+Shift+Tab | Next / previous tab |
125+
| Ctrl+F | Focus search |
92126
| F3 / Ctrl+G | Next match |
93127
| Shift+F3 | Previous match |
94128
| Ctrl+B | Toggle bookmark |
95-
| Ctrl+H | Highlight selection |
96-
| Ctrl+Shift+S | Save to notes |
97-
| Ctrl++ | Zoom in |
98-
| Ctrl+- | Zoom out |
99-
| Ctrl+0 | Reset zoom |
100-
| Ctrl+Tab | Next tab |
101-
| Ctrl+Shift+Tab | Previous tab |
102-
| Ctrl+W | Close tab |
129+
| Ctrl+H | Highlight all occurrences of selection |
130+
| Ctrl+Shift+H | Highlight first occurrence per line |
131+
| Ctrl+Shift+S | Save selected lines to notes |
132+
| Ctrl++ / Ctrl+- / Ctrl+0 | Zoom in / out / reset |
133+
| Ctrl+1...7 | Toggle panels (Folders/Stats/Analysis/Gaps/Bookmarks/Highlights/History) |
134+
| Ctrl+8 | Toggle search configs |
135+
| Ctrl+9 | Toggle video player |
136+
| Ctrl+\ | Toggle panel visibility |
137+
| Ctrl+` | Toggle terminal |
138+
| Ctrl+Shift+N | Toggle notes drawer |
139+
| Ctrl+Shift+R | Toggle search results |
140+
| Alt+Z | Toggle word wrap |
141+
| Esc | Close active panel/overlay |
142+
| Shift+Click | Select line range |
143+
| Right-click | Context menu (bookmark, copy, highlight) |
103144

104145
## License
105146

0 commit comments

Comments
 (0)