docs: make Chinese README the default

2026-07-13 10:44:17 +00:00
parent b5a00a949e
commit 8faf265a0f
1 changed files with 68 additions and 62 deletions
@@ -1,3 +1,9 @@
+<!-- WEHUB_ZH_README -->
+> [!NOTE]
+> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。  
+> [English](./README.en.md) · [原始项目](https://github.com/electerm/electerm) · [上游 README](https://github.com/electerm/electerm/blob/HEAD/README.md)  
+> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
+
 <h1 align="center" style="padding-top: 60px;padding-bottom: 40px;">
    <a href="https://electerm.org">
        <img src="https://github.com/electerm/electerm-resource/raw/master/static/images/electerm.png", alt="" />
@@ -14,14 +20,15 @@

 [![English](https://img.shields.io/badge/English-EN-blue)](README.md) [![中文](https://img.shields.io/badge/中文-Chinese-blue)](README_cn.md)

-Open-sourced terminal/ssh/sftp/telnet/serialport/RDP/VNC/Spice/ftp client(linux, mac, win).

- [electerm.org](https://electerm.org): Homepage, downloads, videos, etc
- [electerm-web](https://github.com/electerm/electerm-web): Web app version running in browser(including mobile device)
- [electerm-web-docker](https://github.com/electerm/electerm-web-docker): Docker image for electerm-web
- [electerm online](https://cloud.electerm.org): Public free online electerm app
- [electerm demo](https://demo.electerm.org): Online demo of electerm
- [electerm AI](https://ai.electerm.org): Free AI for electerm users
+开源终端/ssh/telnet/serialport/RDP/VNC/Spice/sftp/ftp客户端(linux, mac, win)。
+
+- [electerm.org](https://electerm.org): 主页，下载，视频等
+- [electerm-web](https://github.com/electerm/electerm-web): 运行于浏览器(支持移动设备)的web app版本
+- [electerm-web-docker](https://github.com/electerm/electerm-web-docker): electerm-web的docker镜像
+- [electerm online](https://cloud.electerm.org): 公共免费在线electerm应用
+- [electerm demo](https://demo.electerm.org): 在线演示
+- [electerm AI](https://ai.electerm.org): 免费为 electerm 用户提供 AI
 - [electerm deb repo](https://repos.electerm.org/deb): Debian repo of electerm
 - [electerm rpm repo](https://repos.electerm.org/rpm): RPM repo of electerm

@@ -33,7 +40,7 @@ Open-sourced terminal/ssh/sftp/telnet/serialport/RDP/VNC/Spice/ftp client(linux,
  </a>
 </div>

-[Atlas Cloud](https://www.atlascloud.ai/?utm_source=github&utm_medium=link&utm_campaign=electerm) provides OpenAI-compatible AI APIs and model access for AI-powered workflows in electerm.
+[Atlas Cloud](https://www.atlascloud.ai/?utm_source=github&utm_medium=link&utm_campaign=electerm) 提供与 OpenAI 兼容的 AI API 和模型访问，用于在 electerm 中实现 AI 驱动的工作流程。

 [![DigitalOcean Referral Badge](https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%202.svg)](https://www.digitalocean.com/?refcode=c10bcb28b846&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)

@@ -43,37 +50,38 @@ Open-sourced terminal/ssh/sftp/telnet/serialport/RDP/VNC/Spice/ftp client(linux,
  <img src="https://github.com/electerm/electerm-resource/raw/master/static/images/electerm.gif", alt="" />
 </div>

-## Features
+## 功能特性

- Works as a terminal/file manager or ssh/sftp/ftp/telnet/serialport/RDP/VNC/Spice client
- Support Window 7+(X64/ARM64), Mac OS 10.15+(x64/arm64), Linux(x64/arm64/Loong64), even old Linux with glibc 2.17+ like UOS/Kylin/Ubuntu 18.04 etc
- Global hotkey to toggle window visibility (similar to guake, default is `ctrl + 2`)
- Multi platform(linux, mac, win)
- 🇺🇸 🇨🇳 🇧🇷 🇷🇺 🇪🇸 🇫🇷 🇹🇷 🇭🇰 🇯🇵 🇸🇦 🇩🇪 🇰🇷 🇮🇩 🇵🇱 Multi-language support([electerm-locales](https://github.com/electerm/electerm-locales), contributions/fixes welcome)
- Double click to directly edit (small) remote files.
- Auth with publicKey + password.
- Support Zmodem(rz, sz).
- Support ssh tunnel.
- Support [Trzsz](https://github.com/trzsz/trzsz)(trz/tsz), similar to rz/sz, and compatible with tmux.
- Transparent window(Mac, win).
- Terminal background image.
- Global/session proxy.
- Quick commands
- UI/terminal theme
- Sync bookmarks/themes/quick commands to github/gitee secret gist/webdav/custom server/electerm cloud
- Quick input to one or all terminals.
- AI assistant integration (supporting [DeepSeek](https://www.deepseek.com), OpenAI, and any other AI APIs) to help with command suggestions, script writing, and explaining selected terminal content, create bookmarks
- MCP (Model Context Protocol) widget for AI assistants and external tools integration - see [MCP Widget Usage Guide](https://github.com/electerm/electerm/wiki/MCP-Widget-Usage-Guide)
- Deep link support: Open connections with URLs like `telnet://192.168.2.31:34554` or `ssh://user@host:22` - see [Deep link support wiki](https://github.com/electerm/electerm/wiki/Deep-link-support)
- Command line usage: check [wiki](https://github.com/electerm/electerm/wiki/Command-line-usage)
+- 支持ssh,telnet,serialport,RDP,VNC,Spice,本地和远程文件管理，sftp/ftp文件传输，以及作为本地终端使用
+- 支持Window 7+(X64/ARM64), Mac OS 10.15+(x64/arm64), Linux(x64/arm64/Loong64), 以及Linux with glibc 2.17+ like UOS/Kylin/Ubuntu 18.04 etc
+- 全局快捷键切换隐藏显示窗口(类似guake, 默认快捷键`ctrl + 2`)
+- 多平台支持(linux, mac, win)
+- 🇺🇸 🇨🇳 🇧🇷 🇷🇺 🇪🇸 🇫🇷 🇹🇷 🇭🇰 🇯🇵 🇸🇦 🇩🇪 🇰🇷 🇮🇩 🇵🇱 多国语言支持([electerm-locales](https://github.com/electerm/electerm-locales), 欢迎提交代码)
+- 双击直接编辑远程文件.
+- 支持密码或者密匙登录.
+- 支持Zmodem(rz, sz).
+- 支持ssh隧道
+- 支持[Trzsz](https://github.com/trzsz/trzsz)(trz/tsz), 类似rz/sz, 兼容tmux.
+- 支持透明窗口(Mac, win).
+- 支持设置终端背景图片.
+- 支持代理服务器.
+- 支持预设快捷命令
+- 支持主题
+- 支持同步书签等数据到github/gitee私人gist, webdav/custom server/electerm cloud
+- 支持快速输入命令到一个或者多个终端
+- AI助手集成（支持[DeepSeek](https://www.deepseek.com)、OpenAI等AI API），协助命令建议、脚本编写、以及解释所选终端内容, 创建书签
+- MCP (Model Context Protocol) 组件，用于AI助手和外部工具集成 - 详见 [MCP Widget Usage Guide](https://github.com/electerm/electerm/wiki/MCP-Widget-Usage-Guide)
+- 支持命令行使用: 请参阅[wiki](https://github.com/electerm/electerm/wiki/Command-line-usage)
+- 深度链接支持: 使用 `telnet://192.168.2.31:34554` 或 `ssh://user@host:22` 等URL打开连接 - 详见 [深度链接支持 wiki](https://github.com/electerm/electerm/wiki/Deep-link-support)

-## Install

- For Mac user: `brew install --cask electerm`
- With snap: `sudo snap install electerm --classic`
- For some Linux distribution, you can find it from OS default App store(Ubuntu, Deepin, Mint...).
- For some linux OS, the `rpm`, `deb`, or `snap` release may not work, you can try the `tar.gz` or `.appImage` release.
- For Windows users, you can install it from [windows store](https://www.microsoft.com/store/apps/9NCN7272GTFF), command-line installer [winget](https://github.com/microsoft/winget-cli) and [scoop](https://github.com/lukesampson/scoop) is also recommended:
+## 安装
+
+- Mac OS用户: `brew install --cask electerm`
+- Snap: `sudo snap install electerm --classic`
+- 一些Linux发行版的内置软件商店(Ubuntu, Deepin, Mint...).
+- 不支持`rpm`, `deb`, or `snap` 的Linux发行版可以尝试 `tar.gz`版本.
+- Windows用户可以从[windows store](https://www.microsoft.com/store/apps/9NCN7272GTFF), 命令行安装工具 [winget](https://github.com/microsoft/winget-cli)，以及[scoop](https://github.com/lukesampson/scoop) :

 ```powershell
 # winget https://github.com/microsoft/winget-cli
@@ -84,33 +92,32 @@ scoop bucket add dorado https://github.com/chawyehsu/dorado
 scoop install dorado/electerm
 ```

- Install from Debian repository (for Debian/Ubuntu-based systems) with `apt` command
+- 从Debian软件源安装 (适用于Debian/Ubuntu系统) 使用 `apt` 命令

-Check [https://repos.electerm.org/deb](https://repos.electerm.org/deb)
+查看 [https://repos.electerm.org/deb](https://repos.electerm.org/deb)

- Install from npm
+- 从npm安装

 ```bash
 npm i -g electerm
-
 ```

-## Upgrade
+## 升级

- Auto upgrade: When a new version is released, you will get an upgrade notification after you start electerm again. You can then click the upgrade button to upgrade.
- Download: Just download the latest edition, reinstall.
- Npm: If you install from npm, just run `npm i -g electerm` again.
- If use Snap or some other distribution system, these systems may provide upgrades.
+- 自动升级: 点击新版本的升级按钮.
+- 下载: 重新下载最新版安装.
+- Npm: 如果是从npm安装 再次运行`npm i -g electerm` 即可.
+- 如果从Linux发行版软件商店或者Snap安装，可能有自动升级机制.

-## Known issues
+## 已知问题

 [https://github.com/electerm/electerm/wiki/Know-issues](https://github.com/electerm/electerm/wiki/Know-issues)

-## Troubleshoot
+## 疑难解答

 [https://github.com/electerm/electerm/wiki/Troubleshoot](https://github.com/electerm/electerm/wiki/Troubleshoot)

-## Discussion
+## 讨论区

 [![Discord](https://img.shields.io/badge/Discord-Join-blue?logo=discord)](https://discord.gg/855W7g8EVd)

@@ -118,11 +125,11 @@ npm i -g electerm

 ![electerm-wechat-group-qr.jpg](https://electerm.org/electerm-wechat-group-qr.jpg)

-## Support
+## 支持

-Would love to hear from you, please tell me what you think, [submit an issue](https://github.com/electerm/electerm/issues), [Start a new discussion](https://github.com/electerm/electerm/discussions/new), [create/fix language files](https://github.com/electerm/electerm-locales) or create pull requests, all welcome.
+欢迎[提交问题/建议](https://github.com/electerm/electerm/issues), [展开讨论](https://github.com/electerm/electerm/discussions/new), [修复或者创建语言文件](https://github.com/electerm/electerm-locales)或者贡献代码。

-## Sponsor this project
+## 赞助项目

 github sponsor

@@ -132,7 +139,7 @@ kofi

 [https://ko-fi.com/zhaoxudong](https://ko-fi.com/zhaoxudong)

-wechat donate
+微信赞赏码

 [![wechat donate](https://electerm.org/electerm-wechat-donate.png)](https://github.com/electerm)

@@ -140,9 +147,9 @@ TRON TRN20

 [![TRN20 donate](https://github.com/electerm/electerm-resource/blob/master/static/images/trn20.png?raw=true)]

-Address: TXk3pQNmQu1vihH76RaEFnK9wg13x4LLCZ
+地址: TXk3pQNmQu1vihH76RaEFnK9wg13x4LLCZ

-## Dev
+## 开发

 ```bash
 # May only works in Linux
@@ -167,7 +174,7 @@ npm run lint
 npm run fix
 ```

-## Test
+## 测试

 ```bash
 npm run b
@@ -178,7 +185,7 @@ cp .sample.env .env
 npm run test
 ```

-## Test build
+## 测试构建

 ```bash
 # May only works in Linux
@@ -197,24 +204,23 @@ npm run pb
 ./node_modules/.bin/electron-builder --linux --arm64
 ```

-## Video guide
+## 使用视频

 - [https://electerm.org/videos](https://electerm.org/videos)

-## Change log
+## 变更历史

 Visit [Releases](https://github.com/electerm/electerm/releases).

-## Contact author
+## 联系作者

 [zxdong@gmail.com](mailto:zxdong@gmail.com)

-
-## License
+## 许可证

 MIT

-## Star History
+## 收藏历史

 <p>
 <a href="https://www.star-history.com/electerm/electerm"><img src="https://api.star-history.com/badge?repo=electerm/electerm" alt="Star History Rank" /></a>