Repository files navigation

Open-sourced terminal/ssh/telnet/serialport/RDP/VNC/sftp/ftp client(linux, mac, win).

For experienced developers, you may try the web app version running in browser(including mobile device):electerm-web ordocker image for electerm-web

Online demo:https://electerm-demo.html5beta.com

• Works as a terminal/file manager or ssh/sftp/ftp/telnet/serialport/RDP/VNC client
• Global hotkey to toggle window visibility (similar to guake, default isctrl + 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 ssh tunnel.
• SupportTrzsz(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.
• AI assistant integration (supportingDeepSeek, OpenAI, and other AI APIs) to help with command suggestions, script writing, and explaining selected terminal content
• MCP (Model Context Protocol) widget for AI assistants and external tools integration - seeMCP Widget Usage Guide
• Deep link support: Open connections with URLs liketelnet://192.168.2.31:34554 orssh://user@host:22 - seeDeep link support wiki
• Command line usage: checkwiki

• Homepage
• sourceforge
• github releases

• 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, therpm,deb, orsnap release may not work, you can try thetar.gz or.appImage release.
• For Windows users, you can install it fromwindows store, command-line installerwinget andscoop is also recommended:

# winget https://github.com/microsoft/winget-cliwinget install electerm.electerm# scoop https://github.com/lukesampson/scoopscoop bucket add dorado https://github.com/chawyehsu/doradoscoop install dorado/electerm

• Install from Debian repository (for Debian/Ubuntu-based systems) withapt command

Checkhttps://electerm-repos.html5beta.com/deb

• 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

• 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 runnpm i -g electerm again.
• If use Snap or some other distribution system, these systems may provide upgrades.

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

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

Discussion board

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.

github sponsor

https://github.com/sponsors/electerm

kofi

https://ko-fi.com/zhaoxudong

wechat donate

# May only works in Linux# needs nodejs/npm, suggest using nvm to install nodejs/npm# with nodejs 22.xgit clone git@github.com:electerm/electerm.gitcd electermnpm configset legacy-peer-depstruenpm i# start vite dev server, requires port 5570npm start# in a separate terminal session run appnpm run app# code format checknpm run lint# code format fixnpm run fix

npm run bnpm run prepare-testcp .sample.env .env# edit .env, fill your test host/username/password, may only works in mac OSnpm runtest

# May only works in Linux# Install yarn first(to do yarn autoclean)# See https://yarnpkg.com/en/docs/install# Build linux only with -lnpm inpm run bnpm run pb./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

• https://electerm.html5beta.com/videos

VisitReleases.

MIT