electerm / electerm

📻Terminal/ssh/sftp client(linux, mac, win)

Home Page:https://electerm.html5beta.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

中文

electerm Tweet

GitHub version GitHub Actions license JavaScript Style Guide Get it from the Snap Store Get it from the Microsoft Store open collective badge

Terminal/ssh/sftp client(linux, mac, win) based on electron/ssh2/node-pty/xterm/antd/useProxy and other libs.

Features

  • Works as a terminal/file manager or ssh/sftp client(similar to xshell)
  • Global hotkey to toggle window visibility (similar to guake, default is ctrl + 2)
  • Multi platform(linux, mac, win)
  • 🇺🇸 🇨🇳 🇧🇷 🇷🇺 🇪🇸 🇫🇷 🇹🇷 🇭🇰 🇯🇵 🇸🇦 🇩🇪 🇰🇷 Multi-language support(electerm-locales, contributions/fixes welcome)
  • Double click to directly edit (small) remote files.
  • Auth with publicKey + password.
  • Support Zmodem(rz, sz).
  • Support 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
  • Support serial Port(version > 1.21.8)
  • Quick input to one or all terminals.
  • Command line usage: check wiki

Download/install

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

Known issues

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

Troubleshoot

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

Discussion

Discussion board

Support

Would love to hear from you, please tell me what you think, submit an issue, Start a new discussion, create/fix language files or create pull requests, all welcome.

Sponsor this project

open collective

open collective badge

wechat donate

wechat donate

Dev

# 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

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

Test build

# 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

Use

Change log

Visit Releases.

License

MIT

About

📻Terminal/ssh/sftp client(linux, mac, win)

https://electerm.html5beta.com

License:MIT License


Languages

Language:JavaScript 95.7%Language:Stylus 3.7%Language:Less 0.3%Language:Pug 0.2%Language:Shell 0.1%