\n\nChatLab is an open-source desktop app for understanding your social conversations. It combines a flexible SQL engine with AI agents so you can explore patterns, ask better questions, and extract insights from chat data, all on your own machine.\n\nCurrently supported: **WhatsApp, LINE, QQ, Discord, Instagram, Telegram, iMessage, and Google Chat**. Coming next: **Messenger and KakaoTalk**.\n\n> New install? Start here: [Getting started](https://docs.chatlab.fun/usage/quick-start)\n\n## Core Features\n\n- 🚀 **Built for large histories**: Stream parsing and multi-worker processing keep imports and analysis responsive, even at million-message scale.\n- 🔒 **Private by default**: Your chat data and settings stay local. No mandatory cloud upload of raw conversations.\n- 🤖 **AI that can actually operate on data**: Agent + Function Calling workflows (24+ tools) can search, summarize, and analyze chat records with context.\n- 📊 **Insight-rich visual views**: See trends, time patterns, interaction frequency, rankings, and more in one place.\n- 🧩 **Cross-platform normalization**: Different export formats are mapped into a unified model so you can analyze them consistently.\n\n## Installation\n\n### Desktop App\n\nDownload the installer for your OS from the [official website](https://chatlab.fun/?type=download) or [GitHub Releases](https://github.com/ChatLab/ChatLab/releases), then double-click to install.\n\n### CLI\n\nRequires Node.js ≥ 20.\n\n```bash\nnpm i chatlab-cli -g\n```\n\nStart ChatLab:\n\n```bash\nclb web # Start API + Web UI, auto-open in browser\nclb web --no-open # Start API + Web UI, skip auto-open\nclb web --headless # API only, no Web UI (for scripts / AI Agents)\n```\n\nCommon options: `--port ` (default 3110), `--host `, `--token `.\n\nTo run as a persistent background service (auto-start on login + auto-restart on crash):\n\n```bash\nclb web --daemon # Install as system service (macOS / Linux)\nclb status # Check service status\nclb stop # Stop and uninstall service\n```\n\nFor a full walkthrough, see the [Quick Start guide](https://docs.chatlab.fun/usage/quick-start).\n\n## Usage Guides\n\n- [Download Guide](https://chatlab.fun/?type=download)\n- [Chat Record Export Guide](https://docs.chatlab.fun/usage/how-to-export)\n- [Standardized Format Specification](https://docs.chatlab.fun/standard/chatlab-format)\n- [Troubleshooting Guide](https://docs.chatlab.fun/usage/troubleshooting)\n\n## Preview\n\nFor more previews, please visit the official website: [chatlab.fun](https://chatlab.fun/)\n\n\n\n## Architecture Overview\n\nChatLab is a pnpm monorepo built on Electron + Vue 3 + Nuxt UI + Tailwind CSS. Core business logic lives in shared packages (`@openchatlab/core`, `@openchatlab/node-runtime`, `@openchatlab/tools`), consumed by both the desktop app and the CLI service — so they stay in sync.\n\nData flows in five stages: **format detection → stream parsing → local persistence → SQL + AI query → visualization**.\n\nFor a deep dive, see the [architecture documentation](https://docs.chatlab.fun/intro).\n\n### Architecture Principles\n\n- **Local-first by default**: Raw chat data, indexes, and settings remain on-device unless you explicitly choose otherwise.\n- **Streaming over buffering**: Stream-first parsing and incremental processing keep large imports stable and memory-efficient.\n- **Composable intelligence**: AI features are assembled through Agent + Tool Calling, not hard-coded into one model path.\n- **Schema-first evolution**: Import, query, analysis, and visualization share a consistent data model that scales with new features.\n\n---\n\n## Local Development\n\nFor complete contributor instructions, see the [Development Guide](https://docs.chatlab.fun/contributing/development).\n\n### Requirements\n\n- Node.js >= 24 < 25\n- pnpm >= 11 < 12\n\n### Setup\n\n```bash\n# Install dependencies\npnpm install\n\n# Start dev mode — prompts you to choose which app to launch\npnpm dev\n```\n\nOr launch a specific target directly:\n\n```bash\npnpm dev:desktop # Electron desktop app\npnpm dev:cli-web # CLI Web frontend + local server\npnpm dev:web-wasm # Browser-only Web WASM\npnpm dev:serve # CLI server only\npnpm docs:dev # Docs site\n```\n\nIf Electron encounters exceptions during startup, you can try using `electron-fix`:\n\n```bash\nnpm install electron-fix -g\nelectron-fix start\n```\n\n## Privacy Policy & User Agreement\n\nBefore using this software, please read the [Privacy Policy & User Agreement](./src/assets/docs/agreement_en.md).\n\n## Community\n\nPlease follow these principles before submitting a Pull Request:\n\n- Obvious bug fixes can be submitted directly.\n- For new features, please submit an Issue for discussion first; **PRs submitted without prior discussion will be closed**.\n- Keep one PR focused on one task; if changes are extensive, consider splitting them into multiple independent PRs.\n- For local setup, repository structure, checks, and AI collaboration notes, see the [Development Guide](https://docs.chatlab.fun/contributing/development).\n\nThanks to all contributors:\n\n\n \n\n\n## License\n\nAGPL-3.0 License\n","readmeFilename":"README.md"}
![\"ChatLab\"](\"https://github.com/ChatLab/ChatLab/raw/main/public/images/banner-light.png\" "\\"ChatLab\\"")
\n