Skip to content

Commit f8b9e57

Browse files
ozgesolidkeyclaude
andcommitted
Update docs with Agent Setup Wizard instructions
- README: Add wizard to AI Agent Integration section with quick start guide - AGENT_CHAT_GUIDE: Add Quick Start section with wizard steps and config format - CLAUDE.md: Document wizard feature and supported agent types Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent b3ab7d5 commit f8b9e57

File tree

3 files changed

+50
-4
lines changed

3 files changed

+50
-4
lines changed

CLAUDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ Use this pattern for interactive conversations with the LOGAN user:
3838
| `logan_baseline_save` / `logan_baseline_compare` | Save and compare baselines |
3939
| `logan_get_notes` / `logan_save_notes` | Read/write freeform notes |
4040

41+
### Agent Setup Wizard
42+
43+
LOGAN includes a setup wizard (gear icon in Chat tab) that:
44+
- Auto-detects Claude Code CLI, existing config, and built-in agent
45+
- Supports three agent types: Claude Code (AI), Built-in, Custom Script
46+
- Saves config to `~/.logan/agent-config.json`
47+
- Launches the agent immediately after setup
48+
4149
### Important
4250

4351
- Always call `logan_status` first to check if a file is open

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ A fast, AI-ready log file viewer built with Electron. Handles **14 million+ line
1414
- **JSON auto-format** — Pretty-print JSON files on open
1515

1616
### AI Agent Integration
17+
- **Setup Wizard** — Guided setup: auto-detects Claude Code CLI and configures the agent connection
1718
- **MCP support** — 30+ tools auto-discovered by Claude Code, Cursor, and other MCP clients via `.mcp.json`
1819
- **Agent Chat tab** — Bidirectional messaging between LOGAN and AI agents with SSE real-time bridge
20+
- **Claude Code integration** — Launch Claude Code directly from LOGAN with full MCP tool access
1921
- **Built-in agent** — One-click launch from the Chat tab, handles triage/search/crash analysis/bookmarking
2022
- **HTTP API** — Full REST API for custom agents (bash, Node.js, Python) — see [LOGAN-AGENT.md](LOGAN-AGENT.md)
2123
- **Connection indicator** — Shows agent name and status, enforces single-agent connection
@@ -158,13 +160,23 @@ If LOGAN is already running, the file opens in the existing window. If not, a ne
158160

159161
## AI Agent Integration
160162

161-
LOGAN exposes a full log-analysis API that AI agents can use. Three integration paths:
163+
LOGAN exposes a full log-analysis API that AI agents can use. Four integration paths:
162164

163165
| Method | How |
164166
|--------|-----|
165-
| **MCP clients** (Claude Code, Cursor) | Tools auto-discovered via `.mcp.json` — just open the project |
167+
| **Claude Code** (recommended) | Click "Launch Agent" → Setup Wizard auto-detects CLI and configures MCP |
168+
| **MCP clients** (Cursor, Windsurf) | Tools auto-discovered via `.mcp.json` — just open the project |
166169
| **Custom scripts** | Hit the HTTP API directly or use the `logan-listen` CLI helper |
167-
| **Built-in agent** | Click "Launch Agent" in the Chat tab — no setup needed |
170+
| **Built-in agent** | Click "Launch Agent" → select "Built-in Agent" — no setup needed |
171+
172+
### Quick Start: Agent Setup Wizard
173+
174+
1. Open the **Chat tab** (bottom panel, chat icon)
175+
2. Click **Launch Agent** (or the gear icon next to it)
176+
3. The wizard auto-detects available tools (Claude Code CLI, etc.)
177+
4. Choose your agent type and click **Save & Launch**
178+
179+
The wizard saves configuration to `~/.logan/agent-config.json`. Subsequent launches skip the wizard.
168180

169181
See [LOGAN-AGENT.md](LOGAN-AGENT.md) for the full API reference, example scripts, and integration guide.
170182

docs/AGENT_CHAT_GUIDE.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LOGAN Agent Chat Integration Guide
22

3-
LOGAN supports real-time bidirectional chat between AI agents and the user through its built-in Chat panel. This guide covers three integration methods.
3+
LOGAN supports real-time bidirectional chat between AI agents and the user through its built-in Chat panel. This guide covers integration methods from simplest to most flexible.
44

55
## See Also
66

@@ -18,6 +18,32 @@ LOGAN supports real-time bidirectional chat between AI agents and the user throu
1818

1919
---
2020

21+
## Quick Start: Setup Wizard
22+
23+
The easiest way to connect an AI agent is through the built-in Setup Wizard:
24+
25+
1. Open the **Chat tab** (bottom panel)
26+
2. Click **Launch Agent** or the **gear icon** next to it
27+
3. The wizard auto-detects available tools:
28+
- **Claude Code CLI** — full AI with MCP tool access (recommended)
29+
- **Built-in Agent** — basic keyword-based command handler
30+
- **Custom Script** — your own agent script (Node.js, Python, Bash)
31+
4. Choose your agent type, configure if needed, and click **Save & Launch**
32+
33+
Configuration is saved to `~/.logan/agent-config.json`:
34+
```json
35+
{
36+
"type": "claude-code",
37+
"model": ""
38+
}
39+
```
40+
41+
Supported `type` values: `"claude-code"`, `"builtin"`, `"custom"` (requires `"scriptPath"`).
42+
43+
For Claude Code, LOGAN automatically generates an MCP config and launches Claude with `--print --permission-mode bypassPermissions --strict-mcp-config` for seamless non-interactive operation.
44+
45+
---
46+
2147
## Method 1: MCP Tools (Recommended)
2248

2349
For agents that support [Model Context Protocol](https://modelcontextprotocol.io) (Claude Code, Cursor, Windsurf, etc.).

0 commit comments

Comments
 (0)