174 lines
5.9 KiB
Markdown
174 lines
5.9 KiB
Markdown
<h1 align="center">
|
|
<a href="https://electerm.github.io/electerm">
|
|
<img src="https://github.com/electerm/electerm-resource/raw/master/static/images/electerm.png", alt="" />
|
|
</a>
|
|
</h1>
|
|
|
|
[English](README.md)
|
|
|
|
# electerm [](https://twitter.com/intent/tweet?text=Open%20sourced%20terminal%2Fssh%2Fsftp%20client(linux%2C%20mac%2C%20win)&url=https%3A%2F%2Fgithub.com%2Felecterm%2Felecterm&hashtags=electerm,ssh,terminal,sftp)
|
|
|
|
[](https://github.com/electerm/electerm/releases)
|
|
[](https://github.com/electerm/electerm/actions)
|
|
[](https://github.com/electerm/electerm/blob/master/LICENSE)
|
|
[](https://standardjs.com)
|
|
[](https://snapcraft.io/electerm)
|
|
[](https://www.microsoft.com/store/apps/9NCN7272GTFF)
|
|
[](https://opencollective.com/electerm)
|
|
|
|
开源终端/ssh/telnet/serialport/sftp客户端(linux, mac, win)。
|
|
|
|
<div align="center">
|
|
<img src="https://github.com/electerm/electerm-resource/raw/master/static/images/electerm.gif", alt="" />
|
|
</div>
|
|
|
|
## 功能特性
|
|
|
|
- 支持ssh,telnet,serialport,本地和远程文件管理，sftp文件传输，以及作为本地终端使用
|
|
- 全局快捷键切换隐藏显示窗口(类似guake, 默认快捷键`ctrl + 2`)
|
|
- 多平台支持(linux, mac, win)
|
|
- 🇺🇸 🇨🇳 🇧🇷 🇷🇺 🇪🇸 🇫🇷 🇹🇷 🇭🇰 🇯🇵 🇸🇦 🇩🇪 🇰🇷 多国语言支持([electerm-locales](https://github.com/electerm/electerm-locales), 欢迎提交代码)
|
|
- 双击直接编辑远程文件.
|
|
- 支持密码或者密匙登录.
|
|
- 支持Zmodem(rz, sz).
|
|
- 支持[Trzsz](https://github.com/trzsz/trzsz)(trz/tsz), 类似rz/sz, 兼容tmux.
|
|
- 支持透明窗口(Mac, win).
|
|
- 支持设置终端背景图片.
|
|
- 支持代理服务器.
|
|
- 支持预设快捷命令
|
|
- 支持主题
|
|
- 支持同步书签等数据到github/gitee私人gist
|
|
- 支持快速输入命令到一个或者多个终端
|
|
- 支持命令行使用: 请参阅[wiki](https://github.com/electerm/electerm/wiki/Command-line-usage)
|
|
|
|
## 下载
|
|
|
|
- [sourceforge](https://sourceforge.net/projects/electerm.mirror/files/)
|
|
- [github releases](https://github.com/electerm/electerm/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](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
|
|
winget install electerm
|
|
|
|
# scoop https://github.com/lukesampson/scoop
|
|
scoop bucket add dorado https://github.com/chawyehsu/dorado
|
|
scoop install dorado/electerm
|
|
```
|
|
|
|
- 从npm安装
|
|
|
|
```bash
|
|
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/Know-issues)
|
|
|
|
## 疑难解答
|
|
|
|
[https://github.com/electerm/electerm/wiki/Troubleshoot](https://github.com/electerm/electerm/wiki/Troubleshoot)
|
|
|
|
## 讨论区
|
|
|
|
[Discussion board](https://github.com/electerm/electerm/discussions)
|
|
|
|
## 支持
|
|
|
|
欢迎[提交问题/建议](https://github.com/electerm/electerm/issues), [展开讨论](https://github.com/electerm/electerm/discussions/new), [修复或者创建语言文件](https://github.com/electerm/electerm-locales)或者贡献代码。
|
|
|
|
## 赞助项目
|
|
|
|
open collective
|
|
|
|
[](https://opencollective.com/electerm)
|
|
|
|
微信赞赏码
|
|
|
|
[](https://github.com/electerm)
|
|
|
|
## 开发
|
|
|
|
```bash
|
|
# 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 16+
|
|
|
|
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
|
|
```
|
|
|
|
## 测试
|
|
|
|
```bash
|
|
npm run pre-test
|
|
cp .sample.env .env
|
|
|
|
# edit .env, fill your test host/username/password, may only works in mac OS
|
|
npm run test
|
|
```
|
|
|
|
## 测试构建
|
|
|
|
```bash
|
|
# Tested only in ubuntu 16.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 pre-test
|
|
npm run release -l
|
|
# check dist/ folder
|
|
```
|
|
|
|
## 使用技巧
|
|
|
|
- [Set autorun when login to os](https://github.com/electerm/electerm/wiki/Autorun-electerm-when-login-to-os)
|
|
|
|
## 变更历史
|
|
|
|
Visit [Releases](https://github.com/electerm/electerm/releases).
|
|
|
|
## 许可证
|
|
|
|
MIT
|