Skip to content

Commit 1ab29ff

Browse files
ozgesolidkeyclaude
andcommitted
Bump v0.5.0 — update README, description, and keywords
Rewrite README to cover AI agent integration (MCP, Chat tab, built-in agent), live connections (serial, logcat, SSH), Context Search pattern correlation, baseline comparison, image viewer, and other features added since v0.4.0. Add comprehensive keywords to package.json. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 799d585 commit 1ab29ff

File tree

2 files changed

+80
-42
lines changed

2 files changed

+80
-42
lines changed

README.md

Lines changed: 57 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,79 @@
11
# LOGAN - Log Analyzer
22

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.
3+
A fast, AI-ready log file viewer built with Electron. Handles **14 million+ lines** with virtual scrolling, integrates with AI agents via MCP, connects to live serial/logcat/SSH streams, and provides deep analysis tools — all in one desktop app.
44

55
## Features
66

77
### Core Viewer
8-
- **Virtual scrolling**Handles multi-million line files with constant memory usage and smooth 60fps scrolling
8+
- **Virtual scrolling**Constant memory usage and smooth 60fps, even with multi-million line files
99
- **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
10+
- **Multiple tabs** — Open and switch between files without losing state
1111
- **Minimap** — Bird's-eye overview with color-coded error/warning indicators, click to jump
1212
- **Word wrap & zoom** — Toggle wrapping, adjust font size with Ctrl+/- or mouse wheel
1313
- **Column visibility** — Auto-detect delimited columns and show/hide them
14+
- **JSON auto-format** — Pretty-print JSON files on open
15+
16+
### AI Agent Integration
17+
- **MCP support** — 30+ tools auto-discovered by Claude Code, Cursor, and other MCP clients via `.mcp.json`
18+
- **Agent Chat tab** — Bidirectional messaging between LOGAN and AI agents with SSE real-time bridge
19+
- **Built-in agent** — One-click launch from the Chat tab, handles triage/search/crash analysis/bookmarking
20+
- **HTTP API** — Full REST API for custom agents (bash, Node.js, Python) — see [LOGAN-AGENT.md](LOGAN-AGENT.md)
21+
- **Connection indicator** — Shows agent name and status, enforces single-agent connection
22+
- **Custom agent scripts** — Point to your own agent via `~/.logan/agent-config.json`
23+
24+
### Live Connections
25+
- **Serial monitor** — Connect to serial ports with auto-device discovery
26+
- **Android logcat** — Stream logcat output with device listing
27+
- **SSH shell** — Remote log tailing via SSH with key/password auth
28+
- **Datadog** — Fetch logs directly from Datadog APIs
29+
- **Multi-connection** — Up to 4 parallel connections, each with its own live card and density minimap
30+
- **Session recording** — Save live sessions to file for later analysis
31+
- **SSH profiles** — Save, load, and manage connection profiles; auto-import from `~/.ssh/config`
32+
- **SFTP browser** — Browse and download remote files
1433

1534
### Analysis & Filtering
1635
- **Log analysis** — Pattern detection, duplicate grouping, level distribution, and time range stats
36+
- **Context Search** — Define multi-pattern contexts (must + clue patterns) with proximity-based correlation for root cause analysis; tree view and timeline density bar
1737
- **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
38+
- **Time gap detection** — Find gaps between timestamps with configurable thresholds
39+
- **Crash investigation** — Deep-dive into crash sites with surrounding context and auto-bookmarking
40+
- **Component analysis** — Investigate a specific component's health across the log
41+
- **Time-range analysis** — Focus on a specific time window
42+
- **Baseline comparison** — Save log fingerprints and compare future logs against them to detect regressions
1943
- **Search configs** — Persistent multi-pattern search with color-coded highlighting (Ctrl+8)
2044

2145
### Annotations
2246
- **Bookmarks** — Mark lines with comments and colors, save/load bookmark sets, export
2347
- **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
48+
- **Notes drawer** — Freeform notes per file with auto-save and Save-As (Ctrl+Shift+N)
49+
- **Save snippets** — Extract selected line ranges to `.notes.txt` files
2650

2751
### Split & Diff
2852
- **File splitting** — Break huge files into manageable parts
2953
- **Split view** — View two files side by side
3054
- **Diff view** — Compare files with aligned hunk display, additions/deletions/modifications
3155

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
56+
### Media
57+
- **Video sync** — Open a screen recording alongside logs, set a sync point, click lines to seek video (Ctrl+9)
58+
- **Image viewer** — View PNG, JPG, SVG images with zoom in the bottom panel
3659

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
60+
### Built-in Tools
61+
- **Tabbed terminal** — Quake-style drop-down with multiple shells and SSH sessions (Ctrl+`)
4062
- **Folder browser** — Open folders, browse files, search across multiple files
4163
- **Activity history** — Track searches, filters, bookmarks, and other actions per file (Ctrl+7)
4264

43-
### Local Persistence
65+
### Persistence
4466
- Per-file `.logan/` sidecar storage for bookmarks, highlights, notes, video sync, and history
45-
- Global `~/.logan/` for highlight groups, bookmark sets, and settings
67+
- Global `~/.logan/` for highlight groups, bookmark sets, baselines, and settings
4668
- State survives across sessions — reopen a file and everything is restored
4769

4870
## Requirements
4971

5072
- **Node.js** 18+
51-
- **ripgrep** (optional, but highly recommended for fast search)
73+
- **ripgrep** (optional, recommended for fast search)
5274

5375
### Installing ripgrep
5476

55-
ripgrep provides ~10-100x faster search performance.
56-
5777
**macOS:**
5878
```bash
5979
brew install ripgrep
@@ -67,35 +87,29 @@ sudo apt install ripgrep
6787
**Windows:**
6888
```bash
6989
choco install ripgrep
70-
# or
71-
winget install BurntSushi.ripgrep
7290
```
7391

7492
**Arch Linux:**
7593
```bash
7694
sudo pacman -S ripgrep
7795
```
7896

79-
If ripgrep is not installed, LOGAN falls back to a stream-based search which is still faster than traditional methods.
97+
If ripgrep is not installed, LOGAN falls back to a stream-based search.
8098

8199
## Installation
82100

83101
### Download Pre-built Packages
84102

85103
Download the latest release from [GitHub Releases](https://github.com/SolidKeyAB/logan/releases).
86104

87-
**macOS:**
88-
- Download `LOGAN-x.x.x-arm64.dmg` (Apple Silicon) or `LOGAN-x.x.x-x64.dmg` (Intel)
89-
- Open the DMG and drag LOGAN to Applications
90-
- On first launch, right-click and select "Open" to bypass Gatekeeper
91-
92-
**Linux:**
93-
- **AppImage:** Download `LOGAN-x.x.x.AppImage`, make executable (`chmod +x`), and run
94-
- **Debian/Ubuntu:** Download `logan_x.x.x_amd64.deb` and install with `sudo dpkg -i logan_x.x.x_amd64.deb`
95-
96-
**Windows:**
97-
- **Installer:** Download and run `LOGAN.Setup.x.x.x.exe`
98-
- **Portable:** Download `LOGAN.x.x.x.exe` and run directly (no installation needed)
105+
| Platform | Download |
106+
|----------|----------|
107+
| **macOS** (Apple Silicon) | `LOGAN-x.x.x-arm64.dmg` |
108+
| **macOS** (Intel) | `LOGAN-x.x.x-x64.dmg` |
109+
| **Linux** (AppImage) | `LOGAN-x.x.x.AppImage` |
110+
| **Linux** (Debian) | `logan_x.x.x_amd64.deb` |
111+
| **Windows** (Installer) | `LOGAN.Setup.x.x.x.exe` |
112+
| **Windows** (Portable) | `LOGAN.x.x.x.exe` |
99113

100114
### Build from Source
101115

@@ -107,12 +121,17 @@ npm run build
107121
npm start
108122
```
109123

110-
## Development
124+
## AI Agent Integration
111125

112-
```bash
113-
npm run build
114-
npm start
115-
```
126+
LOGAN exposes a full log-analysis API that AI agents can use. Three integration paths:
127+
128+
| Method | How |
129+
|--------|-----|
130+
| **MCP clients** (Claude Code, Cursor) | Tools auto-discovered via `.mcp.json` — just open the project |
131+
| **Custom scripts** | Hit the HTTP API directly or use the `logan-listen` CLI helper |
132+
| **Built-in agent** | Click "Launch Agent" in the Chat tab — no setup needed |
133+
134+
See [LOGAN-AGENT.md](LOGAN-AGENT.md) for the full API reference, example scripts, and integration guide.
116135

117136
## Keyboard Shortcuts
118137

@@ -139,8 +158,6 @@ npm start
139158
| Ctrl+Shift+R | Toggle search results |
140159
| Alt+Z | Toggle word wrap |
141160
| Esc | Close active panel/overlay |
142-
| Shift+Click | Select line range |
143-
| Right-click | Context menu (bookmark, copy, highlight) |
144161

145162
## License
146163

package.json

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
{
22
"name": "logan",
3-
"version": "0.4.1",
4-
"description": "Fast log file viewer and analyzer for large files with pattern detection, search, and bookmarks",
3+
"version": "0.5.0",
4+
"description": "AI-powered log file viewer and analyzer — handles 14M+ lines with virtual scrolling, MCP agent integration, live serial/logcat/SSH connections, pattern correlation, diff view, and built-in terminal",
5+
"keywords": [
6+
"log-analyzer",
7+
"log-viewer",
8+
"electron",
9+
"typescript",
10+
"mcp",
11+
"ai-agent",
12+
"model-context-protocol",
13+
"serial-monitor",
14+
"logcat",
15+
"ssh",
16+
"developer-tools",
17+
"virtual-scrolling",
18+
"pattern-matching",
19+
"diff-viewer",
20+
"log-parser",
21+
"embedded-systems",
22+
"datadog",
23+
"debugging",
24+
"observability"
25+
],
526
"main": "dist/main/index.js",
627
"scripts": {
728
"postinstall": "electron-builder install-app-deps 2>/dev/null || true",

0 commit comments

Comments
 (0)