chatlab-cli 0.0.0 → 0.21.0

package/README.md

@@ -1,5 +1,117 @@
-# chatlab-cli
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: light)" srcset="https://github.com/ChatLab/ChatLab/raw/main/public/images/banner-light.png">
+    <img src="https://github.com/ChatLab/ChatLab/raw/main/public/images/banner.png" alt="ChatLab" title="ChatLab" width="500" />
+  </picture>
 
-Reserved package name for the official ChatLab CLI.
+Your chat history, finally yours.
 
-This package is a placeholder. The real ChatLab CLI will be published in a future version.
+English | [简体中文](./docs/README.zh-CN.md)
+
+[Official Website](https://chatlab.fun/) · [Documentation](https://chatlab.fun/usage/) · [Roadmap](https://chatlab.fun/cn/roadmap/tasks)
+
+</div>
+
+ChatLab 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.
+
+Currently supported: **WhatsApp, LINE, WeChat, QQ, Discord, Instagram, and Telegram**. Coming next: **iMessage, Messenger, and KakaoTalk**.
+
+## Core Features
+
+- 🚀 **Built for large histories**: Stream parsing and multi-worker processing keep imports and analysis responsive, even at million-message scale.
+- 🔒 **Private by default**: Your chat data and settings stay local. No mandatory cloud upload of raw conversations.
+- 🤖 **AI that can actually operate on data**: Agent + Function Calling workflows can search, summarize, and analyze chat records with context.
+- 📊 **Insight-rich visual views**: See trends, time patterns, interaction frequency, rankings, and more in one place.
+- 🧩 **Cross-platform normalization**: Different export formats are mapped into a unified model so you can analyze them consistently.
+
+## Usage Guides
+
+- [Download Guide](https://chatlab.fun/?type=download)
+- [Chat Record Export Guide](https://chatlab.fun/usage/how-to-export)
+- [Standardized Format Specification](https://chatlab.fun/standard/chatlab-format)
+- [Troubleshooting Guide](https://chatlab.fun/usage/troubleshooting)
+
+## Preview
+
+For more previews, please visit the official website: [chatlab.fun](https://chatlab.fun/)
+
+![Preview Interface](/public/images/intro_en.png)
+
+## System Architecture
+
+### Architecture Principles
+
+- **Local-first by default**: Raw chat data, indexes, and settings remain on-device unless you explicitly choose otherwise.
+- **Streaming over buffering**: Stream-first parsing and incremental processing keep large imports stable and memory-efficient.
+- **Composable intelligence**: AI features are assembled through Agent + Tool Calling, not hard-coded into one model path.
+- **Schema-first evolution**: Import, query, analysis, and visualization share a consistent data model that scales with new features.
+
+### Runtime Architecture
+
+- **Main Process (control plane)**: `apps/desktop/main/index.ts` handles lifecycle and windows. `apps/desktop/main/ipc/` defines domain-scoped IPC. Core AI, query, NLP, import, and merge logic lives in shared packages (`packages/core`, `packages/node-runtime`, `packages/tools`); `apps/desktop/main/ai/` and `apps/desktop/main/i18n/` are thin Electron adaptation layers.
+- **Worker Layer (compute plane)**: `apps/desktop/main/worker/` runs import, indexing, and query tasks via `workerManager`, delegating core logic to `@openchatlab/core` and `@openchatlab/node-runtime`.
+- **Renderer Layer (interaction plane)**: Vue 3 + Nuxt UI + Tailwind CSS drive management, private chat, group chat, and analysis interfaces. `apps/desktop/preload/index.ts` exposes tightly scoped APIs for secure process boundaries.
+
+### Data Pipeline
+
+1. **Ingestion**: `parser/` detects file format and dispatches to the matching parser module.
+2. **Persistence**: Stream-based writes populate core local entities: sessions, members, and messages.
+3. **Indexing**: Session- and time-oriented indexes are built for timeline navigation and retrieval.
+4. **Query & Analysis**: `worker/query/*` powers activity metrics, interaction analysis, SQL Lab, and AI-assisted exploration.
+5. **Presentation**: The renderer turns query output into charts, rankings, timelines, and conversational analysis flows.
+
+### Extensibility & Reliability
+
+- **Pluggable parser architecture**: Adding a new import source is mostly an extension in `parser/formats/*`, without reworking downstream query logic.
+- **Full + incremental import paths**: `streamImport.ts` and `incrementalImport.ts` support both first-time onboarding and ongoing updates.
+- **Modular IPC boundaries**: Domain-based IPC segmentation reduces cross-layer coupling and limits permission spread.
+- **Unified i18n evolution**: Main and renderer processes share an i18n system that can evolve with product scope.
+
+---
+
+## Local Development
+
+### Requirements
+
+- Node.js >= 20
+- pnpm
+
+### Setup
+
+```bash
+# install dependencies
+pnpm install
+
+# run electron app in dev mode
+pnpm dev
+```
+
+If Electron encounters exceptions during startup, you can try using `electron-fix`:
+
+```bash
+npm install electron-fix -g
+electron-fix start
+
+```
+
+## Privacy Policy & User Agreement
+
+Before using this software, please read the [Privacy Policy & User Agreement](./src/assets/docs/agreement_en.md).
+
+## Community
+
+Please follow these principles before submitting a Pull Request:
+
+- Obvious bug fixes can be submitted directly.
+- For new features, please submit an Issue for discussion first; **PRs submitted without prior discussion will be closed**.
+- Keep one PR focused on one task; if changes are extensive, consider splitting them into multiple independent PRs.
+
+Thanks to all contributors:
+
+<a href="https://github.com/ChatLab/ChatLab/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ChatLab/ChatLab" />
+</a>
+
+## License
+
+AGPL-3.0 License

package/bin/chatlab.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import('../dist/cli.mjs').then((m) => m.run())

package/dist/chunk-2AIOU3PW.mjs

@@ -0,0 +1,26 @@
+import { createRequire as __createRequire } from 'module';
+import { dirname as __pathDirname } from 'path';
+import { fileURLToPath as __fileURLToPath } from 'url';
+const require = __createRequire(import.meta.url);
+const __filename = __fileURLToPath(import.meta.url);
+const __dirname = __pathDirname(__filename);
+
+// src/version.ts
+import { readFileSync } from "fs";
+import { resolve } from "path";
+var cached;
+function getVersion() {
+  if (cached) return cached;
+  try {
+    const pkgPath = resolve(__dirname, "../package.json");
+    cached = JSON.parse(readFileSync(pkgPath, "utf-8")).version;
+  } catch {
+    cached = "0.0.0-dev";
+  }
+  return cached;
+}
+
+export {
+  getVersion
+};
+//# sourceMappingURL=chunk-2AIOU3PW.mjs.map

package/dist/chunk-2AIOU3PW.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/version.ts"],"sourcesContent":["import { readFileSync } from 'fs'\nimport { resolve } from 'path'\n\nlet cached: string | undefined\n\n/**\n * Read version from apps/cli/package.json at runtime.\n * Works for both tsx dev (src/) and bundled (dist/).\n */\nexport function getVersion(): string {\n  if (cached) return cached\n  try {\n    const pkgPath = resolve(__dirname, '../package.json')\n    cached = JSON.parse(readFileSync(pkgPath, 'utf-8')).version\n  } catch {\n    cached = '0.0.0-dev'\n  }\n  return cached!\n}\n"],"mappings":";;;;;;;;AAAA,SAAS,oBAAoB;AAC7B,SAAS,eAAe;AAExB,IAAI;AAMG,SAAS,aAAqB;AACnC,MAAI,OAAQ,QAAO;AACnB,MAAI;AACF,UAAM,UAAU,QAAQ,WAAW,iBAAiB;AACpD,aAAS,KAAK,MAAM,aAAa,SAAS,OAAO,CAAC,EAAE;AAAA,EACtD,QAAQ;AACN,aAAS;AAAA,EACX;AACA,SAAO;AACT;","names":[]}