<img src="https://badgers.space/github/release/electerm/electerm?corner_radius=m" alt="GitHub version" class="ra0-md-img" loading="lazy" />
<img src="https://github.com/electerm/electerm/actions/workflows/mac-test-1.yml/badge.svg" alt="Build Status" class="ra0-md-img" loading="lazy" />
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license" class="ra0-md-img" loading="lazy" />
<img src="https://img.shields.io/badge/Snap-Store-green" alt="Get it from the Snap Store" class="ra0-md-img" loading="lazy" />
<img src="https://img.shields.io/badge/Microsoft-Store-blue" alt="Get it from the Microsoft Store" class="ra0-md-img" loading="lazy" />
<img src="https://img.shields.io/github/sponsors/electerm?label=Sponsors" alt="GitHub Sponsors" class="ra0-md-img" loading="lazy" />
<img src="https://atomgit.com/electerm/electerm/star/badge.svg" alt="star" class="ra0-md-img" loading="lazy" />

<img src="https://img.shields.io/badge/English-EN-blue" alt="English" class="ra0-md-img" loading="lazy" /> <img src="https://img.shields.io/badge/中文-Chinese-blue" alt="中文" class="ra0-md-img" loading="lazy" />

Open-sourced terminal/ssh/sftp/telnet/serialport/RDP/VNC/Spice/ftp client(Linux, Mac, Windows, Android, HarmonyOS).

Besides mainstream Windows/macOS/Linux/Android, electerm also supports HarmonyOS, and older systems — Ubuntu 18, Windows 7, macOS 10+, and special Chinese Linux distributions such as UOS, Kylin, and LoongArch (both old-world and new-world).

• electerm.org: Homepage, downloads, videos, etc
• electerm-web: Web app version running in browser(including mobile device)
• electerm-web-docker: Docker image for electerm-web
• electerm online: Public free online electerm app
• electerm demo: Online demo of electerm
• electerm AI: Free AI for electerm users
• electerm theme: Create/share theme site with live preview and AI creation
• electerm Android: electerm for Android
• electerm Harmony: electerm for HarmonyOS (available on Huawei AppGallery)
• electerm deb repo: Debian repo of electerm
• electerm rpm repo: RPM repo of electerm

Atlas Cloud

Atlas Cloud provides OpenAI-compatible AI APIs and model access for AI-powered workflows in electerm.

<img src="https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%202.svg" alt="DigitalOcean Referral Badge" class="ra0-md-img" loading="lazy" />

<img src="https://github.com/electerm/electerm-resource/blob/master/static/images/vercel-oss-2005.png?raw=true" alt="Vercel OSS Program" class="ra0-md-img" loading="lazy" />

Features

• Works as a terminal/file manager or ssh/sftp/ftp/telnet/serialport/RDP/VNC/Spice client
• Support Window 7+(X64/ARM64), HarmonyOS，Android, Mac OS 10.15+(x64/arm64), Linux(x64/arm64/Loong64 new world & old world), even old Linux with glibc 2.17+ like UOS/Kylin/Ubuntu 18.04 etc
• 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 ssh tunnel.
• 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/webdav/custom server/electerm cloud
• Quick input to one or all terminals.
• AI assistant integration (supporting DeepSeek, OpenAI, and any other AI APIs) to help with command suggestions, script writing, and explaining selected terminal content, create bookmarks/themes
• MCP (Model Context Protocol) widget for AI assistants and external tools integration - see MCP Widget Usage Guide
• Deep link support: Open connections with URLs like telnet://192.168.2.31:34554 or ssh://user@host:22 - see Deep link support wiki
• Command line usage: check wiki

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 or .appImage release.
• For Windows users, you can install it from windows store, command-line installer winget and scoop is also recommended:

# winget https://github.com/microsoft/winget-cli
winget install electerm.electerm

# scoop https://github.com/lukesampson/scoop
scoop bucket add dorado https://github.com/chawyehsu/dorado
scoop install dorado/electerm

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

Check https://repos.electerm.org/deb

• Install from npm

npm i -g electerm

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.

Known issues

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

Troubleshoot

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

Discussion

<img src="https://img.shields.io/badge/Discord-Join-blue?logo=discord" alt="Discord" class="ra0-md-img" loading="lazy" />

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

github sponsor

https://github.com/sponsors/electerm

kofi

https://ko-fi.com/zhaoxudong

wechat donate

<img src="https://electerm.org/electerm-wechat-donate.png" alt="wechat donate" class="ra0-md-img" loading="lazy" />

TRON TRN20

[]

Address: TXk3pQNmQu1vihH76RaEFnK9wg13x4LLCZ

Dev

# May only works in Linux
# needs nodejs/npm, suggest using nvm to install nodejs/npm
# with nodejs 24.x

git clone git@github.com:electerm/electerm.git
cd electerm
npm config set legacy-peer-deps true
npm i

# start vite 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 b
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

# May only works in Linux
# Install yarn first(to do yarn autoclean)
# See https://yarnpkg.com/en/docs/install

# Build linux only with -l
npm i
npm run b
npm 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

Video guide

• https://electerm.org/videos

Change log

Visit Releases.

Contact author

zxdong@gmail.com

License

MIT

Star History