chattransfer 0.0.0-stage → 2.0.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 suncx and ChatTransfer Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.ar.md

@@ -0,0 +1,208 @@
+# ChatTransfer
+
+[![GitHub Downloads](https://img.shields.io/github/downloads/turboxing/ChatTransfer/total?style=flat-square&logo=github&color=44cc11)](https://github.com/turboxing/ChatTransfer/releases)
+[![GitHub Release](https://img.shields.io/github/v/release/turboxing/ChatTransfer?style=flat-square&color=fe7d37)](https://github.com/turboxing/ChatTransfer/releases)
+[![GitHub last commit](https://img.shields.io/github/last-commit/turboxing/ChatTransfer?style=flat-square&color=a4a61d)](https://github.com/turboxing/ChatTransfer/commits/main)
+[![GitHub stars](https://img.shields.io/github/stars/turboxing/ChatTransfer?style=flat-square&color=dfb317)](https://github.com/turboxing/ChatTransfer/stargazers)
+[![MIT License](https://img.shields.io/github/license/turboxing/ChatTransfer?style=flat-square&color=007ec6)](./LICENSE)
+
+[English](./README.md) | [简体中文](./README.zh-CN.md) | العربية
+
+> أداة بسيطة للدردشة ونقل الملفات عبر الشبكة المحلية، موجهة للمطورين والمختبرين والفرق الصغيرة. امسح رمز QR، افتح المتصفح، وشارك النصوص والصور والملفات فورًا — بدون حسابات أو رفع سحابي أو تطبيقات إضافية.
+
+## عرض توضيحي
+
+- [عرض على YouTube](https://www.youtube.com/watch?v=gZxeBqd7vbY)
+- [عرض على Bilibili](https://www.bilibili.com/video/BV13QJp6vE3r/?vd_source=b4939bcf1ffecbca608b946bbdd9c475)
+
+## لماذا ChatTransfer
+
+أنا مهندس اختبار. في عملي اليومي، أنقل باستمرار الأشياء بين الكمبيوتر وهواتف الاختبار: حزم التثبيت ومعاملات الاختبار والروابط تذهب إلى الهاتف، والسجلات ولقطات الشاشة وتسجيلات الشاشة تعود إلى الكمبيوتر. كثيرًا ما يسألني زملائي:
+
+- “كيف أنقل تسجيل الشاشة إلى الكمبيوتر؟”
+- “هل يجب أن أجهّز أدوات تطوير لتثبيت حزمة الاختبار على الهاتف؟”
+- “هل يمكن تحويل هذه الصورة إلى رابط؟”
+- “هل يمكن تحويل هذا الرابط إلى رمز QR؟”
+
+تبدو هذه أمورًا صغيرة، لكنها تستهلك أكبر وقت عندما تكون مطلوبة فورًا. أريد أن يجعل ChatTransfer لحظات “المشاركة السريعة” بسيطة قدر الإمكان.
+
+هذه الاحتياجات دائمًا “مؤقتة”، لكن الحلول المعتادة ثقيلة: تثبيت تطبيق مراسلة، تسجيل الدخول، الرفع إلى منصة خارجية، القلق على الخصوصية بعد المشاركة، إلغاء التثبيت، وإعادة ضبط هواتف الاختبار المستعارة. بعد تكرار هذه الدورة مرات كثيرة، طوّرت ChatTransfer في عطلة الأسبوع: أداة نقل عبر الشبكة المحلية، متعددة المنصات، بدون تثبيت، وتُستخدم ثم تُترك، تجعل المشاركة المؤقتة بين الأجهزة بسيطة وقابلة للتحكم وخفيفة. بعد قرابة 3 سنوات من التطوير، أثبت ChatTransfer فعاليته في العديد من السيناريوهات الواقعية، لذلك قررت مشاركته هنا.
+
+أستخدمه يوميًا وأطوّره باستمرار بناءً على سيناريوهات واقعية. سيبقى مجانيًا. إذا واجهت مشكلة أو لديك فكرة أفضل، افتح Issue في هذا المستودع؛ ملاحظاتك تساعده على التطور.
+
+## الميزات
+
+- **امسح للاتصال** — يتم إنشاء رمز QR عند بدء التشغيل، ويمكنك فتح المحادثة في متصفح الهاتف.
+- **دردشة جماعية فورية** — عدة مستخدمين في نفس الغرفة المحلية مع مزامنة فورية.
+- **نقل الملفات** — إرسال نصوص وصور وملفات في ثوانٍ.
+- **رفع مجمّع** — اسحب وأفلت عدة ملفات دفعة واحدة.
+- **تثبيت وإبراز الرسائل** — إبقاء الرسائل المهمة ظاهرة.
+- **رمز QR للرسائل** — تحويل أي رسالة إلى رمز QR لسهولة المشاركة.
+- **سجل محادثات محلي** — تخزين مؤقت محلي مع إمكانية المسح.
+- **متعدد المنصات** — يدعم Windows و macOS.
+- **واجهة متعددة اللغات** — الصينية والإنجليزية.
+
+## حالات الاستخدام
+
+- **كمبيوتر ↔ كمبيوتر** — مشاركة السجلات وملفات الإعداد وحزم الاختبار ولقطات الشاشة والروابط.
+- **كمبيوتر ↔ هاتف** — إرسال روابط التصحيح ورموز QR ولقطات الشاشة إلى الهاتف، وإعادة الصور والتسجيلات إلى الكمبيوتر.
+- **هاتف ↔ هاتف** — مشاركة سريعة داخل فريق صغير دون تثبيت تطبيق مراسلة آخر.
+- **عروض مباشرة** — توزيع المواد فورًا أثناء الاجتماعات.
+
+## التحميل والتثبيت
+
+حمّل أحدث ملف تنفيذي من صفحة [الإصدارات](https://github.com/turboxing/ChatTransfer/releases).
+
+### npm
+
+إذا كنت تستخدم Node.js 20 أو أحدث، يمكنك تشغيل ChatTransfer مباشرة:
+
+```bash
+npx chattransfer
+```
+
+أو تثبيته عالميًا:
+
+```bash
+npm install -g chattransfer
+chattransfer
+```
+
+لخادم Linux بدون واجهة رسومية:
+
+```bash
+chattransfer --no-browser
+```
+
+| النظام | الملف |
+|--------|--------|
+| macOS | `ChatTransfer-macos-x64-v{version_with_underscores}` |
+| Windows | `ChatTransfer-windows-x64-v{version}.exe` |
+
+### Windows
+
+1. حمّل ملف Windows التنفيذي.
+2. انقر نقرًا مزدوجًا لتشغيله.
+3. إذا ظهرت رسالة أمان، اختر **Run anyway**.
+
+### macOS
+
+1. حمّل ملف macOS التنفيذي وانقله إلى المكان الذي تفضله.
+2. إذا ظهرت رسالة “لا يمكن التحقق من المطوّر”، اضغط **Cancel**.
+3. افتح **System Settings → Privacy & Security**، اضغط **Allow Anyway**، وأدخل كلمة المرور.
+4. افتح التطبيق مرة أخرى واختر **Open**.
+
+بعد بدء التطبيق، يفتح المتصفح تلقائيًا ويعرض رمز QR. امسحه بهاتفك للانضمام إلى المحادثة.
+
+## التشغيل من المصدر
+
+### المتطلبات
+
+- Node.js 20+
+- npm 9+
+
+### الأوامر
+
+```bash
+npm install
+cd frontend
+npm install
+cd ..
+npm run dev
+```
+
+يعمل التطبيق على `http://localhost:55556`.
+
+لتطوير الواجهة:
+
+```bash
+cd frontend
+npm run dev
+```
+
+### الاختبار والبناء
+
+```bash
+npm test
+cd frontend
+npm run build
+```
+
+### التغليف
+
+```bash
+sh publish.sh mac
+sh publish.sh win
+sh publish.sh all
+```
+
+تُكتب الملفات المُغلّفة في `dist/`.
+
+## دعم المنصات
+
+- macOS 10.15+
+- Windows 10+
+- أي متصفح حديث على الكمبيوتر أو الهاتف
+- الملفات التنفيذية الجاهزة لا تحتاج إلى Node.js أو تبعيات إضافية
+
+## البنية التقنية
+
+يعتمد ChatTransfer على مجموعة تقنيات خفيفة ومركّزة:
+
+- **الواجهة:** Vue 3 و Vite و Vue Router و Element Plus و Socket.IO Client.
+- **الخادم:** Node.js و Express و Socket.IO و `express-fileupload`.
+- **التغليف:** `pkg` لإنشاء ملفات تنفيذية مستقلة لـ macOS و Windows.
+
+### هيكل المشروع
+
+```text
+ChatTransfer/
+├── server/       # Express API وأحداث Socket.IO والخدمات والقياس
+├── frontend/     # تطبيق Vue 3
+├── tests/        # اختبارات الخادم والمستودع
+├── docs/         # أدلة التطوير والإصدار والقياس
+├── release/      # وثائق الإصدارات وسجل التغييرات
+└── publish.sh    # سكربت التغليف
+```
+
+لمزيد من التفاصيل، راجع [ARCHITECTURE.md](./ARCHITECTURE.md).
+
+## الخصوصية والأمان
+
+- يتم حفظ سجل المحادثات والملفات محليًا على جهازك.
+- يحدث النقل داخل شبكتك المحلية فقط.
+- لا يوجد نظام حسابات ولا تخزين سحابي مدمج.
+- القياس معطّل افتراضيًا، ولا تتضمن النسخة مفتوحة المصدر أي مفتاح مزوّد.
+- إذا فعّلت القياس، يجب أن تضع مفتاح API الخاص بك في `config/local.json`؛ بدون مفتاح، لا يرسل ChatTransfer أي طلب قياس خارجي.
+
+راجع [docs/telemetry.md](./docs/telemetry.md).
+
+## التطوير
+
+- [دليل التطوير](./docs/development.md)
+- [دليل الإصدار](./docs/release.md)
+- [دليل المساهمة](./CONTRIBUTING.md)
+- [مدونة قواعد السلوك](./CODE_OF_CONDUCT.md)
+
+## الأسئلة الشائعة
+
+**لا تفتح الصفحة بعد مسح رمز QR.**
+تأكد من أن هاتفك وكمبيوترك على نفس الشبكة المحلية.
+
+**فشل نقل الملف.**
+تحقق من تجاوز الملف للحد المسموح، ثم أعد المحاولة.
+
+**كيف أبدّل اللغة؟**
+افتح **الإعدادات** في الزاوية العلوية اليمنى واختر لغتك.
+
+## سجل التغييرات
+
+راجع [release/CHANGELOG.ar.md](./release/CHANGELOG.ar.md).
+
+## الترخيص
+
+[رخصة MIT](./LICENSE)
+
+## المؤلف
+
+Created by suncx.

package/README.md

@@ -1,3 +1,208 @@
-# Temporary Holding Version
+# ChatTransfer
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![GitHub Downloads](https://img.shields.io/github/downloads/turboxing/ChatTransfer/total?style=flat-square&logo=github&color=44cc11)](https://github.com/turboxing/ChatTransfer/releases)
+[![GitHub Release](https://img.shields.io/github/v/release/turboxing/ChatTransfer?style=flat-square&color=fe7d37)](https://github.com/turboxing/ChatTransfer/releases)
+[![GitHub last commit](https://img.shields.io/github/last-commit/turboxing/ChatTransfer?style=flat-square&color=a4a61d)](https://github.com/turboxing/ChatTransfer/commits/main)
+[![GitHub stars](https://img.shields.io/github/stars/turboxing/ChatTransfer?style=flat-square&color=dfb317)](https://github.com/turboxing/ChatTransfer/stargazers)
+[![MIT License](https://img.shields.io/github/license/turboxing/ChatTransfer?style=flat-square&color=007ec6)](./LICENSE)
+
+English | [简体中文](./README.zh-CN.md) | [العربية](./README.ar.md)
+
+> A minimal LAN chat and file-transfer tool for developers, testers, and small teams. Scan a QR code, open a browser, and share text, images, and files instantly—without accounts, cloud uploads, or extra apps.
+
+## Demo
+
+- [YouTube demo](https://www.youtube.com/watch?v=gZxeBqd7vbY)
+- [Bilibili demo](https://www.bilibili.com/video/BV13QJp6vE3r/?vd_source=b4939bcf1ffecbca608b946bbdd9c475)
+
+## Why ChatTransfer
+
+I am a QA engineer. In my daily work, I constantly move things between my computer and test phones: builds, test parameters, and links go to the phone; logs, screenshots, and screen recordings come back to the computer. Colleagues often ask:
+
+- “How do I get that screen recording onto my computer?”
+- “Do I need to set up dev tools to install this test build on a phone?”
+- “Can you turn this image into a link?”
+- “Can this link become a QR code?”
+
+These sound like small things, but they cost the most time exactly when you need them right now. I want ChatTransfer to make these “quick share” moments simple enough.
+
+These needs are always “temporary,” but the usual solutions are heavy: install an IM app, sign in, upload to a third-party platform, worry about privacy after sharing, uninstall it, and restore borrowed test phones. After repeating that cycle too many times, I built ChatTransfer on weekends: a cross-platform, no-install, use-and-leave LAN transfer tool that keeps temporary cross-device sharing simple, controllable, and lightweight. After nearly 3 years of iteration, ChatTransfer has proven effective in many real scenarios, so I decided to share it here.
+
+I use it every day and keep improving it based on real scenarios. It will stay free. If you run into a problem or have a better idea, please open an Issue; your feedback directly helps it grow.
+
+## Features
+
+- **Scan to connect** — generate a QR code on startup and open the chat in a phone browser.
+- **Real-time group chat** — multiple users can join the same LAN room and sync instantly.
+- **File transfer** — send text, images, and files in seconds.
+- **Batch upload** — drag and drop multiple files at once.
+- **Pin and highlight messages** — keep important messages visible.
+- **Message QR codes** — turn any message into a QR code for easy sharing.
+- **Local chat history** — cache messages locally and clear them when needed.
+- **Cross-platform** — supports Windows and macOS.
+- **Multi-language UI** — Chinese and English.
+
+## Use Cases
+
+- **PC ↔ PC** — share logs, config snippets, test builds, screenshots, and links.
+- **PC ↔ Phone** — send debug links, QR codes, and screenshots to phones; return photos and recordings to computers.
+- **Phone ↔ Phone** — share files quickly in a small team without installing another IM app.
+- **Live demos** — distribute materials instantly during meetings.
+
+## Download and Install
+
+Download the latest executable from the [Releases](https://github.com/turboxing/ChatTransfer/releases) page.
+
+### npm
+
+If you use Node.js 20 or later, you can run ChatTransfer directly:
+
+```bash
+npx chattransfer
+```
+
+Or install it globally:
+
+```bash
+npm install -g chattransfer
+chattransfer
+```
+
+For a headless Linux server:
+
+```bash
+chattransfer --no-browser
+```
+
+| System | File |
+|--------|------|
+| macOS | `ChatTransfer-macos-x64-v{version_with_underscores}` |
+| Windows | `ChatTransfer-windows-x64-v{version}.exe` |
+
+### Windows
+
+1. Download the Windows executable.
+2. Double-click to run it.
+3. If Windows shows a security prompt, choose **Run anyway**.
+
+### macOS
+
+1. Download the macOS executable and move it to your preferred location.
+2. If macOS says it cannot verify the developer, click **Cancel**.
+3. Open **System Settings → Privacy & Security**, click **Allow Anyway**, and enter your password.
+4. Open the app again and confirm with **Open**.
+
+After the app starts, a browser window opens automatically with a QR code. Scan it with your phone to join the chat.
+
+## Run from Source
+
+### Requirements
+
+- Node.js 20+
+- npm 9+
+
+### Commands
+
+```bash
+npm install
+cd frontend
+npm install
+cd ..
+npm run dev
+```
+
+The app starts at `http://localhost:55556`.
+
+For frontend development:
+
+```bash
+cd frontend
+npm run dev
+```
+
+### Test and Build
+
+```bash
+npm test
+cd frontend
+npm run build
+```
+
+### Package
+
+```bash
+sh publish.sh mac
+sh publish.sh win
+sh publish.sh all
+```
+
+Packaged files are written to `dist/`.
+
+## Platform Support
+
+- macOS 10.15+
+- Windows 10+
+- Any modern browser on desktop or mobile
+- Prebuilt executables require no Node.js or additional dependencies
+
+## Architecture
+
+ChatTransfer uses a small, focused stack:
+
+- **Frontend:** Vue 3, Vite, Vue Router, Element Plus, and Socket.IO Client.
+- **Backend:** Node.js, Express, Socket.IO, and `express-fileupload`.
+- **Packaging:** `pkg` for standalone macOS and Windows executables.
+
+### Project Structure
+
+```text
+ChatTransfer/
+├── server/       # Express API, Socket.IO events, services, telemetry
+├── frontend/     # Vue 3 application
+├── tests/        # Backend and repository-level tests
+├── docs/         # Development, release, and telemetry guides
+├── release/      # Release-page documentation and changelogs
+└── publish.sh    # Packaging script
+```
+
+See [ARCHITECTURE.md](./ARCHITECTURE.md) for more details.
+
+## Privacy and Security
+
+- Chat history and files are stored locally on your device.
+- Transfers stay inside your local network.
+- There is no account system and no built-in cloud storage.
+- Telemetry is disabled by default and never contains a provider key.
+- If you enable telemetry, you must provide your own API key in `config/local.json`; without a key, ChatTransfer makes no external telemetry request.
+
+See [docs/telemetry.md](./docs/telemetry.md) for details.
+
+## Development
+
+- [Development guide](./docs/development.md)
+- [Release guide](./docs/release.md)
+- [Contributing guide](./CONTRIBUTING.md)
+- [Code of Conduct](./CODE_OF_CONDUCT.md)
+
+## FAQ
+
+**The page will not open after scanning the QR code.**
+Make sure your phone and computer are on the same local network.
+
+**File transfer failed.**
+Check whether the file exceeds the configured size limit, then try uploading again.
+
+**How do I switch languages?**
+Open **Settings** in the top-right corner and choose your language.
+
+## Changelog
+
+See [release/CHANGELOG.en.md](./release/CHANGELOG.en.md).
+
+## License
+
+[MIT License](./LICENSE)
+
+## Author
+
+Created by suncx.

package/README.zh-CN.md

@@ -0,0 +1,208 @@
+# ChatTransfer（聊天快传）
+
+[![GitHub Downloads](https://img.shields.io/github/downloads/turboxing/ChatTransfer/total?style=flat-square&logo=github&color=44cc11)](https://github.com/turboxing/ChatTransfer/releases)
+[![GitHub Release](https://img.shields.io/github/v/release/turboxing/ChatTransfer?style=flat-square&color=fe7d37)](https://github.com/turboxing/ChatTransfer/releases)
+[![GitHub last commit](https://img.shields.io/github/last-commit/turboxing/ChatTransfer?style=flat-square&color=a4a61d)](https://github.com/turboxing/ChatTransfer/commits/main)
+[![GitHub stars](https://img.shields.io/github/stars/turboxing/ChatTransfer?style=flat-square&color=dfb317)](https://github.com/turboxing/ChatTransfer/stargazers)
+[![MIT License](https://img.shields.io/github/license/turboxing/ChatTransfer?style=flat-square&color=007ec6)](./LICENSE)
+
+[English](./README.md) | 简体中文 | [العربية](./README.ar.md)
+
+> 一款面向开发者、测试人员和小团队的极简局域网聊天与文件互传工具。扫码即用，无需账号、无需云上传、无需额外安装 App，即可在浏览器中实时互发文字、图片和文件。
+
+## 演示
+
+- [YouTube 演示](https://www.youtube.com/watch?v=gZxeBqd7vbY)
+- [B 站演示](https://www.bilibili.com/video/BV13QJp6vE3r/?vd_source=b4939bcf1ffecbca608b946bbdd9c475)
+
+## 为什么做 ChatTransfer
+
+我本职是一名测试工程师。日常工作里，我经常要在电脑和测试手机之间来回传东西：安装包、测试参数、链接要发到手机；日志、截图、录屏又要从手机回传到电脑。很多时候同事也会随口来一句：
+
+- “刚刚录屏怎么传到电脑上？”
+- “测试包要装手机上，是不是还得装开发工具？”
+- “能把这张图片生成一个链接吗？”
+- “这个链接能不能直接生成二维码？”
+
+这些看似小事，往往临时要用的时候最费时间。我希望 ChatTransfer 能把这类“随手分享”的动作做到足够简单。
+
+这些需求都很“临时”，但解决起来总是很“重”：装个 IM、登账号、传三方平台、传完怕隐私还得卸载，借来的测试机还要恢复干净……反复折腾，浪费时间。于是我在周末开发了 ChatTransfer：一个跨平台、免安装、用完即走的局域网互传工具，尽量把“临时跨设备传输”这件事做得简单、可控、无负担。经过我长达 3 年的迭代，ChatTransfer 已经在多个场景下被证明是有效的。所以决定把它上传到这里，分享给大家！
+
+这个工具我自己每天都在用，也会持续根据真实场景迭代。软件长期免费，如果你在使用中遇到任何问题、或者对功能有更好的想法，欢迎在仓库的 Issues 里提建议；你的反馈会直接帮助它变得更好。
+
+## 核心功能
+
+- **扫码即连** — 启动后自动生成二维码，手机扫码即可在浏览器中打开聊天页面。
+- **实时群聊** — 多人同时在线，消息实时同步。
+- **文件传输** — 支持文本、图片、各类文件的秒级互传。
+- **批量上传** — 支持拖拽批量上传文件。
+- **Pin 与置顶消息** — 固定重要消息，方便随时查看。
+- **消息二维码** — 任意消息皆可生成二维码，方便分享。
+- **本地聊天记录** — 本地缓存聊天记录，支持清空。
+- **跨平台** — 支持 Windows 和 macOS。
+- **多语言界面** — 支持中文和英文切换。
+
+## 使用场景
+
+- **电脑 ↔ 电脑** — 开发联调时互传日志、配置片段、测试包、截图和链接。
+- **电脑 ↔ 手机** — 把调试链接、二维码、截图发到手机，或把照片、录屏回传到电脑。
+- **手机 ↔ 手机** — 小团队临时共享文件，不想再安装一个复杂 IM。
+- **现场演示** — 会议中即时分发资料，无需加好友。
+
+## 下载与安装
+
+前往 [Releases](https://github.com/turboxing/ChatTransfer/releases) 页面下载最新可执行文件。
+
+### npm
+
+如果你使用 Node.js 20 或更高版本，可以直接运行：
+
+```bash
+npx chattransfer
+```
+
+也可以全局安装：
+
+```bash
+npm install -g chattransfer
+chattransfer
+```
+
+无桌面 Linux 服务器可使用：
+
+```bash
+chattransfer --no-browser
+```
+
+| 系统 | 文件 |
+|------|------|
+| macOS | `ChatTransfer-macos-x64-v{版本号_下划线}` |
+| Windows | `ChatTransfer-windows-x64-v{版本号}.exe` |
+
+### Windows
+
+1. 下载 Windows 可执行文件。
+2. 双击运行。
+3. 如果系统出现安全提示，选择 **允许运行**。
+
+### macOS
+
+1. 下载 macOS 可执行文件，并移动到你想保存的位置。
+2. 如果首次运行提示“无法验证开发者”，先点击 **取消**。
+3. 打开 **系统设置 → 隐私与安全性**，点击 **仍然允许**，并输入密码。
+4. 再次打开应用，在确认弹窗中选择 **打开**。
+
+应用启动后会自动打开浏览器并显示二维码，手机扫码即可加入聊天。
+
+## 从源码运行
+
+### 环境要求
+
+- Node.js 20+
+- npm 9+
+
+### 命令
+
+```bash
+npm install
+cd frontend
+npm install
+cd ..
+npm run dev
+```
+
+应用默认运行在 `http://localhost:55556`。
+
+前端单独开发：
+
+```bash
+cd frontend
+npm run dev
+```
+
+### 测试与构建
+
+```bash
+npm test
+cd frontend
+npm run build
+```
+
+### 打包
+
+```bash
+sh publish.sh mac
+sh publish.sh win
+sh publish.sh all
+```
+
+打包产物会输出到 `dist/`。
+
+## 平台支持
+
+- macOS 10.15+
+- Windows 10+
+- 桌面或移动端的现代浏览器
+- 预编译可执行文件无需安装 Node.js 或其他依赖
+
+## 技术架构
+
+ChatTransfer 使用轻量、聚焦的技术栈：
+
+- **前端：** Vue 3、Vite、Vue Router、Element Plus、Socket.IO Client。
+- **后端：** Node.js、Express、Socket.IO、`express-fileupload`。
+- **打包：** 使用 `pkg` 生成 macOS 和 Windows 独立可执行文件。
+
+### 项目结构
+
+```text
+ChatTransfer/
+├── server/       # Express API、Socket.IO 事件、服务与埋点
+├── frontend/     # Vue 3 应用
+├── tests/        # 后端与仓库级测试
+├── docs/         # 开发、发布与埋点文档
+├── release/      # 发布页文档与更新日志
+└── publish.sh    # 打包脚本
+```
+
+更多细节见 [ARCHITECTURE.md](./ARCHITECTURE.md)。
+
+## 隐私与安全
+
+- 聊天记录和文件默认仅保存在本机。
+- 传输只发生在局域网内。
+- 无账号体系，无内置云存储。
+- 埋点默认关闭，开源版本不包含任何提供方 key。
+- 如果你启用埋点，需要在 `config/local.json` 中填写自己的 API key；没有 key 时不会发起任何外部埋点请求。
+
+详见 [docs/telemetry.md](./docs/telemetry.md)。
+
+## 开发
+
+- [开发指南](./docs/development.md)
+- [发布指南](./docs/release.md)
+- [贡献指南](./CONTRIBUTING.md)
+- [行为准则](./CODE_OF_CONDUCT.md)
+
+## 常见问题
+
+**扫码后页面打不开。**
+请确认手机和电脑是否在同一个局域网。
+
+**文件传输失败。**
+请检查文件是否超过限制大小，然后重新上传。
+
+**如何切换语言？**
+点击右上角 **设置**，选择语言。
+
+## 更新日志
+
+见 [release/CHANGELOG.md](./release/CHANGELOG.md)。
+
+## 许可证
+
+[MIT License](./LICENSE)
+
+## 作者
+
+Created by suncx.

package/bin/chattransfer.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+process.env.CHATTRANSFER_RUNTIME = process.env.CHATTRANSFER_RUNTIME || 'npm';
+
+const { getHelpText, parseCliArguments, toStartOptions } = require('../server/cli-options');
+const { start } = require('../server/index');
+const pkg = require('../package.json');
+
+async function main() {
+  const cliValues = parseCliArguments();
+
+  if (cliValues.help) {
+    console.log(getHelpText());
+    return;
+  }
+
+  if (cliValues.version) {
+    console.log(pkg.version);
+    return;
+  }
+
+  const options = toStartOptions(cliValues);
+
+  if (options.dataDir) {
+    process.env.CHATTRANSFER_DATA_DIR = options.dataDir;
+  }
+
+  if (options.publicUrl) {
+    process.env.CHATTRANSFER_PUBLIC_URL = options.publicUrl;
+  }
+
+  const server = await start(options);
+  if (!server) {
+    process.exitCode = 1;
+  }
+}
+
+main().catch((error) => {
+  console.error(`ChatTransfer: ${error.message}`);
+  process.exitCode = 1;
+});