Claudex Logo # Claudex **Professional conversation viewer and analysis tool for Claude Code** > **Category**: Development Tools ยท Conversation Analysis ยท Usage Monitoring Claudex is a full-stack web application designed for developers, QA engineers, and researchers who need to inspect, search, and analyze Claude Code conversation histories. Built with React and Fastify, it provides enterprise-grade full-text search using SQLite FTS5, universal template support for all Claude Code versions, and comprehensive analytics dashboards. [![Version](https://img.shields.io/github/v/release/kunwar-shah/claudex)](https://github.com/kunwar-shah/claudex/releases) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/kunwar-shah/claudex/blob/main/LICENSE) [![Documentation](https://img.shields.io/badge/docs-github--pages-blue)](https://kunwar-shah.github.io/claudex/) [![Discussions](https://img.shields.io/github/discussions/kunwar-shah/claudex)](https://github.com/kunwar-shah/claudex/discussions) [![Mentioned in Awesome Claude Code](https://awesome.re/mentioned-badge.svg)](https://github.com/hesreallyhim/awesome-claude-code) **๐Ÿ“š [Documentation](https://kunwar-shah.github.io/claudex/)** | **๐Ÿ’ฌ [Discussions](https://github.com/kunwar-shah/claudex/discussions)** | **๐Ÿ› [Issues](https://github.com/kunwar-shah/claudex/issues)** ![Claudex โ€” browse, search, and give Claude Code persistent memory. SQLite FTS5 full-text search across all sessions, MCP server with 10 tools, universal V1/V2/V3 template support.](screenshots/hero.gif)
--- ## ๐Ÿ†• What's New ### Version 1.3.0 (February 12, 2026) โ€” MCP Server - **๐Ÿง  MCP Server**: Model Context Protocol server gives Claude Code persistent memory across sessions - **๐Ÿ”ง 10 MCP Tools**: Project context, session search, conversation retrieval, structured memory CRUD - **๐Ÿ’พ Structured Memory System**: Store coding knowledge (conventions, architecture, decisions, error patterns) with priority, confidence, and TTL - **๐Ÿ“‹ 3 MCP Prompts**: `/recall`, `/catchup`, `/history` for quick access to past sessions - **๐ŸŽฏ Token Budgeting**: Three detail levels (minimal/standard/full) for context management - **๐Ÿ“– One-Command Setup**: `claude mcp add --transport stdio claudex -- claudex-mcp`
Previous releases ### Version 1.2.0 (November 11, 2025) - **๐ŸŽจ Comprehensive Theming System**: 10 professional themes (default, emerald, green, blue, purple, orange, red, rose, yellow, classic) - **๐Ÿ”ค Advanced Typography**: 29 font families with visual preview - **๐Ÿ“ Granular Font Sizing**: 5 precise font size options (14px-18px) - **๐Ÿ’พ Settings Persistence**: All customizations saved to localStorage ### Version 1.1.0 (October 27, 2025) - **๐ŸŽฏ Smart Title Extraction**: Meaningful session titles from conversation content - **๐Ÿ“Š Tremor Analytics Dashboard**: Tailwind-based charts and multi-scale visualizations - **๐Ÿณ Docker Multi-Platform**: amd64 and arm64 with optimized ~200MB images - **โšก Performance**: 121x faster async search index rebuild
[View full changelog](https://kunwar-shah.github.io/claudex/#/changelog) | [Troubleshooting guide](https://kunwar-shah.github.io/claudex/#/troubleshooting) --- ## ๐Ÿ“ธ Screenshots ### ๐ŸŽจ NEW in v1.2.0: Theming & Customization
10 Professional Themes

10 Professional Themes
Classic, Emerald, Blue, Purple, Orange, Red, Rose, Yellow, Green, Default

 29 Font Families

29 Font Families
Visual preview showing actual typefaces
Font Size & Border Radius

Granular Font Sizing
5 precise options (14px-18px) + border radius control

 Settings Modal

Settings Modal
Appearance functional, more settings coming soon
### Conversation View Conversation View ### Full-Text Search Search Results ## โœจ Features - **MCP Server**: Give Claude Code persistent memory โ€” conventions, architecture, decisions, and error patterns survive across sessions - **Structured Memory**: Store and recall coding knowledge with priority (1-10), confidence, and TTL-based expiration - **Auto Project Discovery**: Automatically scans `~/.claude/projects` directory to discover all conversations across multiple projects - **Full-Text Search**: Enterprise-grade SQLite FTS5 search engine with advanced filtering by project, session, role, date range, and content highlighting - **Universal Template Support**: Intelligent template detection and parsing for all Claude Code versions (V1.x, V2-mixed, V2.0+) with automatic format detection - **Smart Content Rendering**: Syntax-highlighted code blocks, markdown rendering, diff visualization, JSON formatting, and tool usage tracking - **Session Analytics**: Comprehensive analytics dashboard with message distribution charts, file operation tracking, and conversation statistics using Tremor React - **Export Options**: Export conversations to JSON (structured data), HTML (readable format), or plain TXT for archival and sharing - **Modern UI**: Responsive React interface with 10 themes, 29 fonts, session favorites, and optimized for developer workflows --- ## ๐Ÿ’– Support This Project Claudex is free and open source. If it saves you time and improves your workflow, please consider: - โญ **Star the repo** - Help others discover Claudex - ๐Ÿ› **Report bugs** - Your feedback makes us better - ๐Ÿ’ก **Share ideas** - Request features in [Discussions](https://github.com/kunwar-shah/claudex/discussions) - โ˜• **Buy me a coffee** - Support continued development
[![Ko-fi](https://img.shields.io/badge/Ko--fi-Buy%20me%20a%20coffee-FF5E5B?logo=ko-fi&style=for-the-badge)](https://ko-fi.com/kunwarshah) [![PayPal](https://img.shields.io/badge/PayPal-Donate-00457C?logo=paypal&style=for-the-badge)](https://paypal.me/kunwarJhamat) **Every contribution helps keep this project alive and growing!** ๐Ÿš€
--- ## ๐Ÿš€ Quick Start ### Prerequisites - Node.js 18+ and npm - Claude Code installed with conversation history in `~/.claude/projects` ### Installation #### Option 1: npm (Recommended) ```bash # Global installation npm install -g @kunwarshah/claudex [https://www.npmjs.com/package/@kunwarshah/claudex] # Then run anywhere: claudex # Custom port (if 3400 is in use): claudex --port 3500 # Custom project directory: claudex --project-root ~/my-claude-projects # Or use without installing (npx): npx @kunwarshah/claudex ``` **Add MCP Server** (gives Claude Code persistent memory): ```bash claude mcp add --transport stdio claudex -- claudex-mcp ``` See the [MCP Server Guide](https://kunwar-shah.github.io/claudex/#/mcp) for details. **CLI Options**: - `--help, -h`: Show help message - `--version, -v`: Show version - `--port, -p `: Custom server port (default: 3400) - `--project-root `: Custom Claude projects directory **Environment Variables**: - `PORT`: Server port (default: 3400) - `PROJECT_ROOT`: Claude projects directory (default: ~/.claude/projects) #### Option 2: From Source 1. **Clone the repository**: ```bash git clone https://github.com/kunwar-shah/claudex.git cd claudex ``` 2. **Run system check** (optional but recommended): ```bash npm run check ``` This validates your environment and catches common setup issues. 3. **Install dependencies** (or use auto-fix): ```bash # Option 1: Manual installation npm install cd server && npm install && cd .. cd client && npm install && cd .. # Option 2: Auto-fix (installs deps + creates .env) npm run check:fix ``` 4. **Configure environment** (if not using auto-fix): ```bash cd server cp .env.example .env # Edit .env if needed (default: PROJECT_ROOT=~/.claude/projects) cd .. ``` 5. **Start the application**: ```bash # Automatically runs system check, then starts servers npm run dev ``` 6. **Open your browser**: http://localhost:3000 The backend API runs on `http://localhost:3400` ### System Checker Claudex includes a comprehensive system checker that validates your environment: ```bash # Quick check npm run check # Detailed output npm run check:verbose # Auto-fix common issues npm run check:fix # JSON output (for CI/CD) npm run check:json ``` **What it checks:** - โœ… Node.js & npm versions - โœ… PROJECT_ROOT path & permissions - โœ… Port availability (3000, 3400) - โœ… Dependencies installation - โœ… Claude Code data (projects, sessions) - โœ… JSONL file validity - โœ… Database permissions - โœ… Search index status ### Global CLI Installation (Optional) Install globally to use `claudex` command anywhere: ```bash ./install.sh # Then run from anywhere: claudex ``` ## ๐Ÿ”ง Configuration ### Server Configuration (`.env`) ```env # Path to Claude Code projects directory # Supports ~ expansion (e.g., ~/.claude/projects) PROJECT_ROOT=~/.claude/projects # Server port PORT=3400 # Environment NODE_ENV=development ``` ### Default Ports - **Frontend**: http://localhost:3000 (Vite dev server) - **Backend**: http://localhost:3400 (Fastify API) - **Frontend build**: Uses port 3400 (served by backend in production) ## ๐Ÿ“‚ Project Structure ``` claudex/ โ”œโ”€โ”€ server/ # Backend (Node.js + Fastify) โ”‚ โ”œโ”€โ”€ src/ โ”‚ โ”‚ โ”œโ”€โ”€ parsers/ # Template detection & message parsing โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ templateDetector.js # V1/V2/V3 template detection โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ messageParser.js # Universal message parser โ”‚ โ”‚ โ”œโ”€โ”€ services/ # Core business logic โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ fileScanner.js # Project/session discovery โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ sessionParser.js # Full session parsing โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ searchDatabase.js # SQLite FTS5 search โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ searchIndexer.js # Search index builder โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ memoryService.js # Structured memory CRUD โ”‚ โ”‚ โ”œโ”€โ”€ mcp/ # MCP server (Claude Code integration) โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ index.js # MCP entry point + stdio transport โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ tools.js # 10 MCP tool handlers โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ resources.js # MCP resources โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ prompts.js # 3 MCP prompts โ”‚ โ”‚ โ”œโ”€โ”€ routes/ # API endpoints โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ projects.js # Project/session routes โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ search.js # Search routes โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ export.js # Export routes โ”‚ โ”‚ โ”œโ”€โ”€ utils/ # Helper utilities โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ pathHelper.js # Path expansion (~/ support) โ”‚ โ”‚ โ””โ”€โ”€ server.js # Main server โ”‚ โ”œโ”€โ”€ data/ # SQLite database (auto-created) โ”‚ โ”œโ”€โ”€ .env.example # Environment template โ”‚ โ””โ”€โ”€ package.json โ”œโ”€โ”€ client/ # Frontend (React + Vite) โ”‚ โ”œโ”€โ”€ src/ โ”‚ โ”‚ โ”œโ”€โ”€ components/ # React components โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ ProjectSelector.jsx โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ SessionList.jsx โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ ConversationThread.jsx โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ MessageBubble.jsx โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ ClaudeMessageRenderer.jsx โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ SearchPage.jsx โ”‚ โ”‚ โ”œโ”€โ”€ services/ # API client โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ api.js โ”‚ โ”‚ โ””โ”€โ”€ App.jsx # Main app โ”‚ โ””โ”€โ”€ package.json โ”œโ”€โ”€ bin/ # CLI entry point โ”œโ”€โ”€ test-search.sh # Search API testing script โ”œโ”€โ”€ install.sh # Global CLI installer โ”œโ”€โ”€ SETUP.md # Detailed setup guide โ”œโ”€โ”€ README.md # This file โ””โ”€โ”€ package.json # Root package (CLI + concurrently) ``` ## ๐ŸŽฏ Supported Claude Code Formats The viewer automatically detects and parses all Claude Code conversation formats: ### V3 Template (Universal - Recommended) - **Claude Code v2.0+**: New format with `role` field directly - **Claude Code v1.x**: Original format with `type` field - **Edge cases**: Mixed formats and migration states - **New message types**: `file-history-snapshot` support - **Role mapping**: All system messages โ†’ assistant (binary user/assistant classification) ### Legacy Templates (Auto-detected) - **V2-Mixed**: Transition format between V1 and V2 - **V1**: Original Claude Code format The template detector uses a waterfall detection strategy, automatically selecting the best parser for your conversation files. ## ๐Ÿ” Search System ### Building the Search Index The search index needs to be built before searching: ```bash # Option 1: Via API curl -X POST http://localhost:3400/api/search/index/build # Option 2: Via test script ./test-search.sh # Option 3: Via UI (Search page โ†’ "Rebuild Index" button) ``` ### When to Rebuild Index Rebuild the search index when: - First time setup - After template changes - When new conversations are added - If search results seem outdated ### Search API Examples ```bash # Basic search curl -X POST http://localhost:3400/api/search \ -H "Content-Type: application/json" \ -d '{"q": "migration", "limit": 10}' # Search with filters curl -X POST http://localhost:3400/api/search \ -H "Content-Type: application/json" \ -d '{ "q": "database", "projectId": "my-project", "role": "user", "limit": 20, "offset": 0 }' # Check index status curl http://localhost:3400/api/search/index/status ``` ## ๐Ÿ“ก API Endpoints ### Projects & Sessions | Endpoint | Method | Description | |----------|--------|-------------| | `/api/projects` | GET | List all projects | | `/api/projects/:id/sessions` | GET | Get sessions for project | | `/api/projects/:id/sessions/:sessionId` | GET | Get full session with messages | ### Search | Endpoint | Method | Description | |----------|--------|-------------| | `/api/search` | POST | Search conversations (FTS5) | | `/api/search/index/build` | POST | Build/rebuild search index | | `/api/search/index/status` | GET | Get index statistics | | `/api/search/index/clear` | POST | Clear search index | ### Export | Endpoint | Method | Description | |----------|--------|-------------| | `/api/export/session/:projectId/:sessionId?format=json` | GET | Export as JSON | | `/api/export/session/:projectId/:sessionId?format=html` | GET | Export as HTML | | `/api/export/session/:projectId/:sessionId?format=txt` | GET | Export as TXT | ### Health | Endpoint | Method | Description | |----------|--------|-------------| | `/api/health` | GET | Health check + system info | ## ๐Ÿ› ๏ธ Development ### Development Mode ```bash # Run both frontend + backend with hot reload npm run dev # Or run separately: # Terminal 1 - Backend (auto-restarts on changes) cd server && npm run dev # Terminal 2 - Frontend (hot module replacement) cd client && npm run dev ``` ### Testing the Search System ```bash # Run comprehensive search tests ./test-search.sh ``` This script will: 1. Check server health 2. Get index status 3. Build/rebuild index 4. Run test searches with various filters 5. Display results ### Adding New Templates 1. **Update Template Detector** (`server/src/parsers/templateDetector.js`): ```javascript 'my-template': { name: 'My Template Name', detect: (samples) => { return samples.some(s => s.myUniqueField !== undefined); }, parser: 'my-template' } ``` 2. **Add Parser Method** (`server/src/parsers/messageParser.js`): ```javascript parseMyTemplate(rawMessage) { return { id: rawMessage.id || this.generateId(), role: rawMessage.myRole === 'user' ? 'user' : 'assistant', content: rawMessage.myContent || '', timestamp: rawMessage.myTimestamp, // ... other fields }; } ``` 3. **Rebuild Search Index**: The new template will be automatically detected and used. ## ๐Ÿ“ Scripts Reference ### Claudex Directory - `npm run dev` - Run frontend + backend concurrently (with pre-check) - `npm start` - Run frontend + backend (production mode) - `npm run check` - Run system health check - `npm run check:verbose` - Run detailed system check - `npm run check:fix` - Auto-fix common setup issues - `npm run check:json` - JSON output for CI/CD - `./install.sh` - Install as global CLI command - `./test-search.sh` - Test search API endpoints ### Server Directory - `npm run dev` - Run with nodemon (auto-restart) - `npm start` - Run in production mode ### Client Directory - `npm run dev` - Vite dev server (http://localhost:3000) - `npm run build` - Build for production - `npm run preview` - Preview production build ## ๐Ÿ› Troubleshooting ### Quick Diagnosis Run the system checker first to identify issues: ```bash npm run check:verbose ``` This will check all common problems and provide actionable suggestions. ### Common Issues #### "No messages found" Despite Messages Existing **Fixed in v1.1.1** - If you see intermittent empty sessions or duplicate key warnings: ```bash # Update to latest version cd claude-viewer git pull origin main npm install && cd server && npm install && cd ../client && npm install && cd .. npm run dev ``` See [detailed troubleshooting guide](https://kunwar-shah.github.io/claudex/#/troubleshooting) for more information. #### No Projects Found ```bash # Check what the system sees npm run check # Verify path cat server/.env | grep PROJECT_ROOT ``` - Verify `PROJECT_ROOT` in `.env` points to `~/.claude/projects` - Check that Claude Code has created conversation files - Run `npm run check:fix` to auto-create missing directories #### Search Not Working ```bash # Quick fix via UI # Visit http://localhost:3000/search โ†’ Click "Rebuild Index" # Or via command line curl -X POST http://localhost:3400/api/search/index/build ``` #### Port Conflicts ```bash # System checker will detect port conflicts npm run check # Auto-detected ports in use show PID # Kill process: kill # Or change PORT in server/.env ``` #### Permission Errors ```bash # Check permissions npm run check:verbose # Fix permissions chmod +r ~/.claude/projects chmod +w claude-viewer/server/data ``` #### Dependencies Issues ```bash # Auto-install all dependencies npm run check:fix ``` ## ๐Ÿšข Production Deployment ### Using Docker (Recommended) Claudex includes production-ready Docker configuration with multi-stage builds for optimal image size. #### Quick Start with Docker ```bash # Build and start with docker-compose docker-compose up -d # View logs docker-compose logs -f # Stop docker-compose down ``` Access at: http://localhost:3400 #### Docker Configuration The default `docker-compose.yml` mounts your Claude projects directory as read-only: ```yaml volumes: # Adjust path to match your system - ~/.claude/projects:/root/.claude/projects:ro ``` **Common path configurations:** ```bash # Linux/macOS ~/.claude/projects:/root/.claude/projects:ro # Windows (WSL2) /mnt/c/Users/YourName/.claude/projects:/root/.claude/projects:ro # Custom path /path/to/your/projects:/root/.claude/projects:ro ``` #### Docker Commands ```bash # Build image manually docker build -t claudex:latest . # Run container manually docker run -d \ -p 3400:3400 \ -v ~/.claude/projects:/root/.claude/projects:ro \ -v claudex-data:/app/data \ --name claudex-web \ claudex:latest # Check health docker ps # Check STATUS column for "healthy" # View logs docker logs claudex-web -f # Stop and remove docker stop claudex-web && docker rm claudex-web ``` #### Docker Features - **Multi-stage build**: Optimized image size (~200MB) - **Non-root user**: Runs as nodejs user for security - **Health checks**: Automatic health monitoring - **Persistent volumes**: Stores search index and logs - **Read-only mounts**: Claude projects mounted read-only for safety - **Log rotation**: JSON logs with 10MB max size, 3 file rotation #### Docker Environment Variables ```bash # Override in docker-compose.yml or docker run -e PORT=3400 # Server port -e HOST=0.0.0.0 # Bind address -e NODE_ENV=production # Environment -e PROJECT_ROOT=/root/.claude/projects # Claude projects path ``` ### Manual Production Build For non-Docker deployments: ```bash # 1. Install dependencies npm run install-deps # 2. Build client npm run build # 3. Start server (serves built client) cd server && NODE_ENV=production npm start ``` Access at: http://localhost:3400 ## ๐Ÿ“‹ Roadmap - [x] SQLite FTS5 full-text search - [x] Universal template support (V1/V2/V3) - [x] Export to JSON/HTML/TXT - [x] Docker deployment (v1.1.0) - [x] Conversation analytics dashboard (v1.1.0) - [x] Theming system โ€” 10 themes, 29 fonts (v1.2.0) - [x] Session favorites/bookmarking (v1.2.4) - [x] MCP server for Claude Code (v1.3.0) - [x] Structured memory system (v1.3.0) - [ ] Token cost calculator - [ ] WebSocket live updates - [ ] Plugin system for custom parsers --- ## ๐Ÿ“„ License MIT License - see LICENSE file for details. ## ๐Ÿค Contributing 1. Fork the repository 2. Create a feature branch: `git checkout -b feature/amazing-feature` 3. Commit changes: `git commit -m 'Add amazing feature'` 4. Push to branch: `git push origin feature/amazing-feature` 5. Open a Pull Request ## ๐Ÿ“š Additional Documentation - [SETUP.md](SETUP.md) - Detailed setup and configuration guide - [INSTALL.md](INSTALL.md) - Legacy installation instructions ## ๐Ÿ’ก Tips - Use the search page to find conversations across all projects - Export conversations to share with team members - Rebuild search index after adding new conversations - Check `/api/health` endpoint to verify system status - Use `npm run dev` for the best development experience with hot reload