ContextQMD
Back to Electerm

electerm

README_cn.md

3.8.158.3 KB
Original Source
<h1 align="center" style="padding-top: 60px;padding-bottom: 40px;"> <a href="https://electerm.github.io/electerm"> 
</a>
</h1>

electerm

开源终端/ssh/telnet/serialport/RDP/VNC/Spice/sftp/ftp客户端(linux, mac, win)。

有经验的开发者也可以尝试运行于浏览器(支持移动设备)的web app版本: electerm-web 或者 docker image for electerm-web

在线演示: https://electerm-demo.html5beta.com

<div align="center"> </div>

功能特性

  • 支持ssh,telnet,serialport,RDP,VNC,Spice,本地和远程文件管理，sftp/ftp文件传输，以及作为本地终端使用
  • 支持Window 7+(X64/ARM64), Mac OS 10.15+(x64/arm64), Linux(x64/arm64), 以及Linux with glibc 2.17+ like UOS/Kylin/Ubuntu 18.04 etc
  • 全局快捷键切换隐藏显示窗口(类似guake, 默认快捷键ctrl + 2)
  • 多平台支持(linux, mac, win)
  • 🇺🇸 🇨🇳 🇧🇷 🇷🇺 🇪🇸 🇫🇷 🇹🇷 🇭🇰 🇯🇵 🇸🇦 🇩🇪 🇰🇷 🇮🇩 🇵🇱 多国语言支持(electerm-locales, 欢迎提交代码)
  • 双击直接编辑远程文件.
  • 支持密码或者密匙登录.
  • 支持Zmodem(rz, sz).
  • 支持ssh隧道
  • 支持Trzsz(trz/tsz), 类似rz/sz, 兼容tmux.
  • 支持透明窗口(Mac, win).
  • 支持设置终端背景图片.
  • 支持代理服务器.
  • 支持预设快捷命令
  • 支持主题
  • 支持同步书签等数据到github/gitee私人gist, webdav/custom server/electerm cloud
  • 支持快速输入命令到一个或者多个终端
  • AI助手集成（支持DeepSeek、OpenAI等AI API），协助命令建议、脚本编写、以及解释所选终端内容
  • MCP (Model Context Protocol) 组件，用于AI助手和外部工具集成 - 详见 MCP Widget Usage Guide
  • 支持命令行使用: 请参阅wiki
  • 深度链接支持: 使用 telnet://192.168.2.31:34554 或 ssh://user@host:22 等URL打开连接 - 详见 深度链接支持 wiki

下载

安装

  • 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, 命令行安装工具 winget，以及scoop :
powershell
# winget https://github.com/microsoft/winget-cli
winget install electerm.electerm

# scoop https://github.com/lukesampson/scoop
scoop bucket add dorado https://github.com/chawyehsu/dorado
scoop install dorado/electerm
  • 从Debian软件源安装 (适用于Debian/Ubuntu系统) 使用 apt 命令

查看 https://electerm-repos.html5beta.com/deb

  • 从npm安装
bash
npm i -g electerm

升级

  • 自动升级: 点击新版本的升级按钮.
  • 下载: 重新下载最新版安装.
  • Npm: 如果是从npm安装 再次运行npm i -g electerm 即可.
  • 如果从Linux发行版软件商店或者Snap安装，可能有自动升级机制.

已知问题

https://github.com/electerm/electerm/wiki/Know-issues

疑难解答

https://github.com/electerm/electerm/wiki/Troubleshoot

讨论区

Discussion board

支持

欢迎提交问题/建议, 展开讨论, 修复或者创建语言文件或者贡献代码。

赞助项目

github sponsor

https://github.com/sponsors/electerm

kofi

https://ko-fi.com/zhaoxudong

微信赞赏码

开发

bash
# May only works in Linux
# needs nodejs/npm, suggest using fnm to install nodejs/npm
# with nodejs 24.x

git clone [email protected]:electerm/electerm.git
cd electerm
npm config set legacy-peer-deps true
npm i

# start vite dev server, requires port 5570
npm start

# in a separate terminal session run app
npm run app

# code format check
npm run lint

# code format fix
npm run fix

测试

bash
npm run b
npm run prepare-test
cp .sample.env .env

# edit .env, fill your test host/username/password, may only works in mac OS
npm run test

测试构建

bash
# May only works in Linux
# Install yarn first(to do yarn autoclean)
# See https://yarnpkg.com/en/docs/install

# Build linux only with -l
npm i
npm run b
./node_modules/.bin/electron-builder --linux tar.gz
# or replace tar.gz to rpm/deb/AppImage
# check dist/ folder

# build for linux arm/
./node_modules/.bin/electron-builder --linux --arm64

使用视频

变更历史

Visit Releases.

联系作者

[email protected]

许可证

MIT

收藏历史