Skip to content

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

License

Notifications You must be signed in to change notification settings

wenbingzhang/electerm

 
 

Repository files navigation

electerm

GitHub version Build Status Build status Dependency Status Dev Dependency Status license

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

Download

npm i -g electerm

# after install it will open at once for windows and linux,
# for mac, will open the drag to install panel

Upgrade

  • When new version released, you will get upgrade notification after you start electerm again.
  • If you downloaded it, then just download the latest edition, reinstall.
  • If you install from npm, just run npm i -g electerm again.

Features

  • Work as a terminal/file manager or ssh/sftp client(similar to xshell)
  • Global hotkey to toggle window visibility (simliar to guake, default is ctrl + 2)
  • Support multi platform(linux, mac, win)
  • Support multi-language(electerm-locales, contribute welcome)
  • Double click to directly edit remote file(small ones).
  • Support auth with publickey + password

Support

Without users's feebacks/suggestions, this project would not get this far, would love hear from you, please tell what you think, submit an issue or send me an email.

Dev

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

git clone [email protected]:electerm/electerm.git
cd electerm
npm i

# start webpack dev server
npm start

# in a separate terminal session run app
npm run app

Test

npm run pre-test
cp .sample.env .env
# then edit .env, fill your test host/username/password
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
# visit dist/

Use

Changelog

Visit Releases

License

MIT

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 95.0%
  • CSS 4.5%
  • Other 0.5%