README_cn.md

English

electerm

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

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

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

功能特性

• 支持ssh,telnet,serialport,RDP,本地和远程文件管理，sftp文件传输，以及作为本地终端使用
• 全局快捷键切换隐藏显示窗口(类似guake, 默认快捷键ctrl + 2)
• 多平台支持(linux, mac, win)
• 🇺🇸 🇨🇳 🇧🇷 🇷🇺 🇪🇸 🇫🇷 🇹🇷 🇭🇰 🇯🇵 🇸🇦 🇩🇪 🇰🇷 多国语言支持(electerm-locales, 欢迎提交代码)
• 双击直接编辑远程文件.
• 支持密码或者密匙登录.
• 支持Zmodem(rz, sz).
• 支持ssh隧道
• 支持Trzsz(trz/tsz), 类似rz/sz, 兼容tmux.
• 支持透明窗口(Mac, win).
• 支持设置终端背景图片.
• 支持代理服务器.
• 支持预设快捷命令
• 支持主题
• 支持同步书签等数据到github/gitee私人gist
• 支持快速输入命令到一个或者多个终端
• 支持命令行使用: 请参阅wiki
• 深度链接支持: 请参阅wiki

下载

• 主页
• sourceforge
• github releases

安装

• 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 :

# winget https://github.com/microsoft/winget-cli
winget install electerm

# scoop https://github.com/lukesampson/scoop
scoop bucket add dorado https://github.com/chawyehsu/dorado
scoop install dorado/electerm

• 从npm安装

npm i -g electerm

# after installation, it will immediately open for windows and linux,
# for macOS, it will open the drag to install panel

升级

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

主题配色

• https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/electerm
• https://github.com/Hope-IT-Works/electerm-theme-termius

已知问题

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

微信赞赏码

开发

# tested in ubuntu16.04+/mac os 10.13+ only
# needs nodejs/npm, suggest using nvm to install nodejs/npm
# https://github.com/creationix/nvm
# with nodejs 18.x

git clone git@github.com:electerm/electerm.git
cd electerm
npm i

# start webpack 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

测试

npm run prepare-build
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

测试构建

# Tested only in ubuntu 20.04+ x64
# Install yarn first(to do yarn autoclean)
# See https://yarnpkg.com/en/docs/install

# Build linux only with -l
npm i
npm run prepare-build
./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

使用技巧

• Set autorun when login to os

变更历史

Visit Releases.

许可证

MIT