From 7ca9e8992d116ddbc0ff520134a066cf2fd06bd4 Mon Sep 17 00:00:00 2001 From: Olli Janatuinen Date: Mon, 17 Apr 2023 00:18:11 +0200 Subject: [PATCH] Initiate custom release repository --- README-ZH_CN.md | 265 ------------------------------------------------ README.md | 137 ++----------------------- 2 files changed, 9 insertions(+), 393 deletions(-) delete mode 100644 README-ZH_CN.md diff --git a/README-ZH_CN.md b/README-ZH_CN.md deleted file mode 100644 index 786fc463c..000000000 --- a/README-ZH_CN.md +++ /dev/null @@ -1,265 +0,0 @@ -

- ChatGPT -

ChatGPT

-

ChatGPT 桌面应用（Mac, Windows and Linux）

-

- -[![English badge](https://img.shields.io/badge/%E8%8B%B1%E6%96%87-English-blue)](./README.md) -[![简体中文 badge](https://img.shields.io/badge/%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-Simplified%20Chinese-blue)](./README-ZH_CN.md)\ -[![ChatGPT downloads](https://img.shields.io/github/downloads/lencx/ChatGPT/total.svg?style=flat-square)](https://github.com/lencx/ChatGPT/releases) -[![chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://discord.gg/aPhCRf4zZr) -[![lencx](https://img.shields.io/badge/follow-lencx__-blue?style=flat&logo=Twitter)](https://twitter.com/lencx_) - - - -Buy Me A Coffee - -**它是一个非官方项目，仅供个人学习研究。ChatGPT 桌面应用开源的这段时间，受到了很多关注，谢谢大家的支持。随着事情的发展，有两个问题严重影响了项目的下一步开发计划:** - -- **有人利用它进行二次打包销售，谋取私利** -- **ChatGPT 因名称和图标问题可能会涉及侵权** - -**新仓库：https://github.com/lencx/nofwl** - ---- - -## 📦 安装 - -- [📝 更新日志](./UPDATE_LOG.md) -- [🕒 历史版本...](https://github.com/lencx/ChatGPT/releases) - - - -### Windows - -- [ChatGPT_0.12.0_windows_x86_64.msi](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_windows_x86_64.msi) -- 使用 [winget](https://winstall.app/apps/lencx.ChatGPT): - - ```bash - # install the latest version - winget install --id=lencx.ChatGPT -e - - # install the specified version - winget install --id=lencx.ChatGPT -e --version 0.10.0 - ``` - -**注意：如果安装路径和应用名称相同，会导致冲突 ([#142](https://github.com/lencx/ChatGPT/issues/142#issuecomment-0.12.0))** - -### Mac - -- [ChatGPT_0.12.0_macos_aarch64.dmg](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_macos_aarch64.dmg) -- [ChatGPT_0.12.0_macos_x86_64.dmg](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_macos_x86_64.dmg) -- Homebrew \ - _[Homebrew 快捷安装](https://brew.sh) ([Cask](https://docs.brew.sh/Cask-Cookbook)):_ - ```sh - brew tap lencx/chatgpt https://github.com/lencx/ChatGPT.git - brew install --cask chatgpt --no-quarantine - ``` - 如果你坚持使用 _[Brewfile](https://github.com/Homebrew/homebrew-bundle#usage)_ ，则需要添加以下配置: - ```rb - repo = "lencx/chatgpt" - tap repo, "https://github.com/#{repo}.git" - cask "chatgpt", args: { "no-quarantine": true } - ``` - -如果在 macOS 上安装软件时遇到 `“ChatGPT” is damaged and can't be opened. You should move it to the Trash.` 错误消息，可能是由于 macOS 安全设置的限制导致的。为了解决此问题，请在终端尝试以下命令： - -```bash -sudo xattr -r -d com.apple.quarantine /YOUR_PATH/ChatGPT.app -``` - -### Linux - -- [ChatGPT_0.12.0_linux_x86_64.deb](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_linux_x86_64.deb) -- [ChatGPT_0.12.0_linux_x86_64.AppImage.tar.gz](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_linux_x86_64.AppImage.tar.gz): **工作可靠，`.deb` 运行失败时可以尝试它** - - - -## 📢 公告 - -这是一个令人兴奋的重大更新。像 `Telegram 机器人指令` 那样工作，帮助你快速填充自定模型，来让 ChatGPT 按照你想要的方式去工作。这个项目倾注了我大量业余时间，如果它对你有所帮助，宣传转发，或者 star 都是对我的巨大鼓励。我希望我可以持续更新下去，加入更多有趣的功能。 - -### 如何使用指令？ - -你可以从 [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) 来寻找有趣的功能来导入到应用。也可以使用 `Sync Prompts`，来一键同步所有，如果你不想让某些提示出现在你的斜杠命令，你可以禁用它们。 - -![chatgpt cmd](./assets/chatgpt-cmd.png) -![chatgpt sync prompts](./assets/chatgpt-sync-prompts.png) - - - -在 ChatGPT 文本输入区域，键入 `/` 开头的字符，则会弹出指令提示，按下空格键，它会默认将命令关联的文本填充到输入区域（注意：如果包含多个指令提示，它只会选择第一个作为填充，你可以持续输入，直到第一个提示命令为你想要时，再按下空格键。或者使用鼠标来点击多条指令中的某一个）。填充完成后，你只需要按下回车键即可。斜杠命令下，使用 TAB 键修改 `{q}` 标签内容（仅支持单个修改 [#54](https://github.com/lencx/ChatGPT/issues/54)）。使用键盘 `⇧` 和 `⇩`（上下键）来选择斜杠指令。 - -![chatgpt](assets/chatgpt.gif) -![chatgpt-cmd](assets/chatgpt-cmd.gif) - -## ✨ 功能概览 - -- 跨平台: `macOS` `Linux` `Windows` -- 导出 ChatGPT 聊天记录 (支持 PNG, PDF 和生成分享链接) -- 主窗口和系统托盘支持自定义 URL，将任意网站包装成一个桌面应用 -- 应用自动升级通知 -- 丰富的快捷键 -- 系统托盘悬浮窗 -- 应用菜单功能强大 -- 支持斜杠命令及其配置（可手动配置或从文件同步 [#55](https://github.com/lencx/ChatGPT/issues/55)） -- 自定义全局快捷键 ([#108](https://github.com/lencx/ChatGPT/issues/108)) -- 划词搜索 ([#122](https://github.com/lencx/ChatGPT/issues/122) 鼠标选中文本，不超过 400 个字符)：应用使用 Tauri 构建，因其安全限制，会导致部分操作按钮无效，建议前往浏览器操作。 - -### #️⃣ 菜单项 - -- **Preferences (喜好)** - - `Theme` - `Light`, `Dark`, `System` (仅支持 macOS 和 Windows) - - `Stay On Top`: 窗口置顶 - - `Titlebar`: 是否显示 `Titlebar`，仅 macOS 支持 - - `Inject Script`: 用于修改网站的用户自定义脚本 - - `Hide Dock Icon` ([#35](https://github.com/lencx/ChatGPT/issues/35)): 隐藏 Dock 中的应用图标 (仅 macOS 支持) - - 系统图盘右键单击打开菜单，然后在菜单项中点击 `Show Dock Icon` 可以重新将应用图标显示在 Dock（`SystemTrayMenu -> Show Dock Icon`） - - `Control Center`: ChatGPT 应用的控制中心，它将为应用提供无限的可能 - - 设置 `Theme`，`Stay On Top`，`Titlebar` 等 - - `User Agent` ([#17](https://github.com/lencx/ChatGPT/issues/17)): 自定义 `user agent` 防止网站安全检测，默认值为空 - - `Switch Origin` ([#14](https://github.com/lencx/ChatGPT/issues/14)): 切换网站源地址，默认为 `https://chat.openai.com`。需要注意的是镜像网站的 UI 需要和原网站一致，否则可能会导致某些功能不工作 - - `Go to Config`: 打开 ChatGPT 配置目录 (`path: ~/.chatgpt/*`) - - `Clear Config`: 清除 ChatGPT 配置数据 (`path: ~/.chatgpt/*`), 这是危险操作，请提前备份数据 - - `Restart ChatGPT`: 重启应用。如果注入脚本编辑完成，或者应用可卡死可以通过此菜单重新启动应用 - - `Awesome ChatGPT`: 一个很棒的 ChatGPT 推荐列表 -- **Edit** - `Undo`, `Redo`, `Cut`, `Copy`, `SelectAll`, ... -- **View** - `Go Back`, `Go Forward`, `Scroll to Top of Screen`, `Scroll to Bottom of Screen`, `Refresh the Screen`, ... -- **Help** - - `Update Log`: ChatGPT 应用更新日志 - - `Report Bug`: 报告 BUG 或反馈建议 - - `Toggle Developer Tools`: 网站调试工具，调试页面或脚本可能需要 - -## ⚙️ 应用配置 - -| 平台 | 路径 | -| ------- | ------------------------- | -| Linux | `/home/lencx/.chatgpt` | -| macOS | `/Users/lencx/.chatgpt` | -| Windows | `C:\Users\lencx\.chatgpt` | - -- `[.chatgpt]` - 应用配置根路径 - - `chat.conf.json` - 应用喜好配置 - - `chat.awesome.json` - 自定义 URL 列表，类似于浏览器书签。可以将任意 URL 作为主窗口或托盘窗口 (**Control Conter -> Awesome**) - - `chat.model.json` - ChatGPT 输入提示，通过斜杠命令来快速完成输入，主要包含三部分: - - `user_custom` - 需要手动录入 (**Control Conter -> Language Model -> User Custom**) - - `sync_prompts` - 从 [f/awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) 同步数据 (**Control Conter -> Language Model -> Sync Prompts**) - - `sync_custom` - 同步自定义的 json 或 csv 文件数据，支持本地和远程 (**Control Conter -> Language Model -> Sync Custom**) - - `chat.model.cmd.json` - 过滤（是否启用）和排序处理后的斜杠命令数据 - - `[cache_model]` - 缓存同步或录入的数据 - - `chatgpt_prompts.json` - 缓存 `sync_prompts` 数据 - - `user_custom.json` - 缓存 `user_custom` 数据 - - `ae6cf32a6f8541b499d6bfe549dbfca3.json` - 随机生成的文件名，缓存 `sync_custom` 数据 - - `4f695d3cfbf8491e9b1f3fab6d85715c.json` - 随机生成的文件名，缓存 `sync_custom` 数据 - - `bd1b96f15a1644f7bd647cc53073ff8f.json` - 随机生成的文件名，缓存 `sync_custom` 数据 - -### 客户端信息同步 - -目前同步自定文件仅支持 json 和 csv，且需要满足以下格式，否则会导致应用异常： - -`JSON 格式` - -```json -[ - { - "cmd": "a", - "act": "aa", - "prompt": "aaa aaa aaa" - }, - { - "cmd": "b", - "act": "bb", - "prompt": "bbb bbb bbb" - } -] -``` - -`CSV 格式` - -```csv -"cmd","act","prompt" -"a","aa","aaa aaa aaa" -"b","bb","bbb bbb bbb" -``` - -## 👀 预览 - -install control center -export dalle2 tray -auto update - -## ❓ 常见问题 - -### 不能打开 ChatGPT - -如果升级应用后无法打开，请尝试清除配置，它位于此目录 `~/.chatgpt/*`。 - -### 主窗口已经登录，但是系统托盘窗口显示未登录 - -可通过菜单项里的 `Restart ChatGPT` 重启应用来修复这个问题（`Menu -> Preferences -> Restart ChatGPT`）。 - -### 它是否安全？ - -它是安全的，仅仅只是对 [OpenAI ChatGPT](https://chat.openai.com) 网站的包装，注入了一些额外功能（均在本地，未发起网络请求），如果存疑，可以检查源代码。 - -### 开发者未验证? - -Mac 上无法安装，提示开发者未验证，具体可以查看下面给出的解决方案（它是开源的，很安全）。 - -- [Open a Mac app from an unidentified developer](https://support.apple.com/en-sg/guide/mac-help/mh40616/mac) - ---- - -### 我想自己构建它？ - -#### 预安装 - -- [Rust (必须)](https://www.rust-lang.org/) -- [Node.js (必须)](https://nodejs.org/) -- [VS Code (可选)](https://code.visualstudio.com/) - - [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) - - [tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) - -#### 开始 - -```bash -# step1: 克隆仓库 -git clone https://github.com/lencx/ChatGPT.git - -# step2: 进入目录 -cd ChatGPT - -# step3: 安装依赖 -yarn - -# step4: 开发启动 -yarn dev - -# step5: 构建应用 -# 构建后的安装包位置: src-tauri/target/release/bundle -yarn build -``` - -- [The distDir configuration is set to "../dist" but this path doesn't exist](https://github.com/lencx/ChatGPT/discussions/180) -- [Error A public key has been found, but no private key. Make sure to set TAURI_PRIVATE_KEY environment variable.](https://github.com/lencx/ChatGPT/discussions/182) - -## ❤️ 感谢 - -- 分享按钮的代码从 [@liady](https://github.com/liady) 的插件获得，并做了一些本地化修改 -- 感谢 [Awesome ChatGPT Prompts](https://github.com/f/awesome-chatgpt-prompts) 项目为这个应用自定义指令功能所带来的启发 - ---- - -[![Star History Chart](https://api.star-history.com/svg?repos=lencx/chatgpt&type=Timeline)](https://star-history.com/#lencx/chatgpt&Timeline) - -## 中国用户 - -国内用户如果遇到使用问题或者想交流 ChatGPT 技巧，可以关注公众号“浮之静”，发送 “chat” 进群参与讨论。公众号会更新[《Tauri 系列》](https://mp.weixin.qq.com/mp/appmsgalbum?__biz=MzIzNjE2NTI3NQ==&action=getalbum&album_id=2593843659863752704)文章，技术思考等等，如果对 tauri 开发应用感兴趣可以关注公众号后回复 “tauri” 进技术开发群（想私聊的也可以关注公众号，来添加微信）。开源不易，如果这个项目对你有帮助可以分享给更多人，或者微信扫码打赏。 - - - - - -## License - -AGPL-3.0 License diff --git a/README.md b/README.md index 4fe030d5c..b596c622d 100644 --- a/README.md +++ b/README.md @@ -1,132 +1,13 @@ -

- ChatGPT -

ChatGPT

-

ChatGPT Desktop Application (Mac, Windows and Linux)

-

+# About -[![English badge](https://img.shields.io/badge/%E8%8B%B1%E6%96%87-English-blue)](./README.md) -[![简体中文 badge](https://img.shields.io/badge/%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-Simplified%20Chinese-blue)](./README-ZH_CN.md)\ -![visitor](https://visitor-badge.glitch.me/badge?page_id=lencx.chatgpt) -[![ChatGPT downloads](https://img.shields.io/github/downloads/lencx/ChatGPT/total.svg?style=flat-square)](https://github.com/lencx/ChatGPT/releases) -[![chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://discord.gg/aPhCRf4zZr) -[![lencx](https://img.shields.io/badge/follow-lencx__-blue?style=flat&logo=Twitter)](https://twitter.com/lencx_) +This Git repository is used to build and release customized version of [lencx/ChatGPT](https://github.com/lencx/ChatGPT). - +Most critically following customizations are included at the moment: - +- Store markdown files with chat names instead of IDs and support subfolders by having **|** in chat titles. +- Windows exe is digitally signed +- Windows MSI is digitally signed +- Windows MSI uses user installation mode -Buy Me A Coffee - -**🛑 URGENT NOTICE: A hacker has been found to take advantage of the heat of `lencx/ChatGPT` to plant a Trojan horse after the fork project and rebuild the installer. If you have friends around you who are using this desktop application, please remind them not to download unknown links freely. Now the project will remove other installation ways and only provide this download link https://github.com/lencx/ChatGPT/releases** - -**🛑 紧急通知：目前发现有黑客利用 `lencx/ChatGPT` 的热度，在 fork 项目后植入木马，重新构建安装程序。如果你身边有朋友正在使用此桌面应用，请提醒 TA 们不要随意下载不明链接。现在项目将删除其他安装途径，仅提供此下载链接 https://github.com/lencx/ChatGPT/releases** - ---- - -**It is an unofficial project intended for personal learning and research purposes only. During the time that the ChatGPT desktop application was open-sourced, it received a lot of attention, and I would like to thank everyone for their support. However, as things have developed, there are two issues that seriously affect the project's next development plan:** - -- **Some people have used it for repackaging and selling for profit.** -- **The name and icon of ChatGPT may be involved in infringement issues.** - -**New repository: https://github.com/lencx/nofwl** - ---- - -## 📦 Install - -- [📝 Update Log](./UPDATE_LOG.md) -- [🕒 History versions...](https://github.com/lencx/ChatGPT/releases) - - - -### Windows - -- [ChatGPT_0.12.0_windows_x86_64.msi](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_windows_x86_64.msi): Direct download installer -- Use [winget](https://winstall.app/apps/lencx.ChatGPT): - - ```bash - # install the latest version - winget install --id=lencx.ChatGPT -e - - # install the specified version - winget install --id=lencx.ChatGPT -e --version 0.10.0 - ``` - -**Note: If the installation path and application name are the same, it will lead to conflict ([#142](https://github.com/lencx/ChatGPT/issues/142#issuecomment-0.12.0))** - -### Mac - -- [ChatGPT_0.12.0_macos_aarch64.dmg](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_macos_aarch64.dmg): Direct download installer -- [ChatGPT_0.12.0_macos_x86_64.dmg](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_macos_x86_64.dmg): Direct download installer -- Homebrew \ - Or you can install with _[Homebrew](https://brew.sh) ([Cask](https://docs.brew.sh/Cask-Cookbook)):_ - ```sh - brew tap lencx/chatgpt https://github.com/lencx/ChatGPT.git - brew install --cask chatgpt --no-quarantine - ``` - Also, if you keep a _[Brewfile](https://github.com/Homebrew/homebrew-bundle#usage)_, you can add something like this: - ```rb - repo = "lencx/chatgpt" - tap repo, "https://github.com/#{repo}.git" - cask "chatgpt", args: { "no-quarantine": true } - ``` - -**If you encounter the error message `"ChatGPT" is damaged and can't be opened. You should move it to the Trash`. while installing software on macOS, it may be due to security settings restrictions in macOS. To solve this problem, please try the following command in Terminal:** - -```bash -sudo xattr -r -d com.apple.quarantine /YOUR_PATH/ChatGPT.app -``` - -### Linux - -- [ChatGPT_0.12.0_linux_x86_64.deb](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_linux_x86_64.deb): Download `.deb` installer, advantage small size, disadvantage poor compatibility -- [ChatGPT_0.12.0_linux_x86_64.AppImage.tar.gz](https://github.com/lencx/ChatGPT/releases/download/v0.12.0/ChatGPT_0.12.0_linux_x86_64.AppImage.tar.gz): Works reliably, you can try it if `.deb` fails to run - - - -## ChatGPT Prompts! - -You can look at **[awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts)** to find interesting features to import into the app. You can also use `Sync Prompts` to sync all in one click, and if you don't want certain prompts to appear in your slash commands, you can disable them. - -![chatgpt cmd](./assets/chatgpt-cmd.png) - -## ✨ Features - -- Multi-platform: `macOS` `Linux` `Windows` -- Text-to-Speech -- Export ChatGPT history (PNG, PDF and Markdown) -- The main window and system tray support custom URLs to wrap any website into a desktop application -- Automatic application upgrade notification -- Common shortcut keys -- System tray hover window -- Powerful menu items -- Support for slash commands and their configuration (can be configured manually or synchronized from a file [#55](https://github.com/lencx/ChatGPT/issues/55)) -- Customize global shortcuts ([#108](https://github.com/lencx/ChatGPT/issues/108)) -- Pop-up Search ([#122](https://github.com/lencx/ChatGPT/issues/122) mouse selected content, no more than 400 characters): The application is built using Tauri, and due to its security restrictions, some of the action buttons will not work, so we recommend going to your browser. - -## ❤️ Sponsors - -### **ChatGPT-Powered Email Finding & Outreach at Scale** - -[FinalScout](https://finalscout.com/?utm_source=github&utm_medium=lencx&utm_campaign=chatgpt): Extract valid email addresses from LinkedIn & craft tailored emails based on LinkedIn profile with ChatGPT, guaranteeing up to 98% email deliverability. Scale your outreach efforts and connect with potential customers or clients like never before. [Begin automating your email finding and writing process](https://finalscout.com/?utm_source=github&utm_medium=lencx&utm_campaign=chatgpt) - -## Thanks - -- The core implementation of the share button code was copied from the [@liady](https://github.com/liady) extension with some modifications. -- Thanks to the [Awesome ChatGPT Prompts](https://github.com/f/awesome-chatgpt-prompts) repository for inspiring the custom command function for this application. - ---- - -[![Star History Chart](https://api.star-history.com/svg?repos=lencx/chatgpt&type=Timeline)](https://star-history.com/#lencx/chatgpt&Timeline) - -## 中国用户 - -国内用户如果遇到使用问题或者想交流 ChatGPT 技巧，可以关注公众号“浮之静”，发送 “chat” 进群参与讨论。公众号会更新[《Tauri 系列》](https://mp.weixin.qq.com/mp/appmsgalbum?__biz=MzIzNjE2NTI3NQ==&action=getalbum&album_id=2593843659863752704)文章，技术思考等等，如果对 tauri 开发应用感兴趣可以关注公众号后回复 “tauri” 进技术开发群（想私聊的也可以关注公众号，来添加微信）。开源不易，如果这个项目对你有帮助可以分享给更多人，或者微信扫码打赏。 - - - - - -## License - -AGPL-3.0 License +**NOTE!!** you potentially want set `auto_update` to `disable` in `C:\Users\\.chatgpt\chat.conf.json` +and enable **Watch -> Custom -> Releases** on this repository. Other why you will get notification each time you start application that it would like to switch back to original version.