https://github.com/electerm/.github
Electerm public readme
https://github.com/electerm/.github
Last synced: 3 months ago
JSON representation
Electerm public readme
- Host: GitHub
- URL: https://github.com/electerm/.github
- Owner: electerm
- License: mit
- Created: 2023-08-23T00:57:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-17T03:16:08.000Z (10 months ago)
- Last Synced: 2025-06-17T04:24:40.903Z (10 months ago)
- Size: 22.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[δΈζ](README_cn.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)
Open-sourced terminal/ssh/telnet/serialport/sftp client(linux, mac, win).
## Features
- Works as a terminal/file manager or ssh/telnet/serialport/sftp client
- 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
- Quick input to one or all terminals.
- Command line usage: check [wiki](https://github.com/electerm/electerm/wiki/Command-line-usage)
## Download
- [sourceforge](https://sourceforge.net/projects/electerm.mirror/files/)
- [github releases](https://github.com/electerm/electerm/releases)
## 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` 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:
```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
```
- Install from 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
```
## 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.
## Themes
- https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/electerm
- https://github.com/Hope-IT-Works/electerm-theme-termius
## 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
[Discussion board](https://github.com/electerm/electerm/discussions)
## 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.
## Sponsor this project
open collective
[](https://opencollective.com/electerm)
wechat donate
[](https://github.com/electerm)
## Dev
```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
```
## Test
```bash
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
```
## Test build
```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 prepare-build
npm run release -l
# check dist/ folder
```
## Use
- [Set autorun when login to os](https://github.com/electerm/electerm/wiki/Autorun-electerm-when-login-to-os)
## Change log
Visit [Releases](https://github.com/electerm/electerm/releases).
## License
MIT