English | 中文 | 日本語

This is react components pack for electerm sub projects

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

Besides mainstream Windows/macOS/Linux/Android, electerm also supports HarmonyOS, iOS, 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), as well as RISC-V (riscv64) and PowerPC 64-bit little-endian (ppc64le) Linux.

Homepage / Downloads · Theme · Docker · Online demo · Android · HarmonyOS · Apple App Store · Huawei AppGallery · Microsoft Store · Snap Store · deb repo · rpm repo

Sponsors

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

PackyCode — Access leading AI models through PackyCode with one API endpoint and one API key. Enjoy fast, reliable access with automatic failover and dedicated high-speed routes for Codex and Claude Code. Get started with $1 in free credits, a discount on your first top-up, and savings of up to 80% on eligible routes. Pay in RMB with no currency conversion markups or extra top-up fees.

Thanks to APIMart for sponsoring electerm! APIMart is a low-cost API platform for AI image & video generation — GPT-Image-2 from $0.006/image, 160+ images per dollar. One async API covers both image and video: submit a task, get an ID, fetch results via polling or callback. Batch tens of thousands of images without timeouts, switch models without changing code. Pay-as-you-go with no monthly fee — sign up here to get started.

Features

• Works as a terminal/file manager, ssh/sftp/ftp/telnet/serialport/RDP/VNC/Spice client
• Support Window 7+(X64/ARM64), HarmonyOS，Android, iOS, Mac OS 10.15+(x64/arm64), Linux(x64/arm64/riscv64/ppc64le/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-language support(electerm-locales, contributions/fixes welcome)
• Double click to directly edit (small) remote files.
• All kind of auth methods: publicKey, password, ssh agent, certificates, otp, netbird etc.
• Support Zmodem(rz, sz), and Trzsz(trz/tsz).
• Support ssh related features: tunnel, connection hopping.
• Customizable UI: themes, background image, transparent window(Mac, win).
• Global/session proxy.
• Quick commands/triggers to do predefined tasks and automattic operations
• Sync data including bookmarks to github/gitee secret gist/webdav/custom server/electerm cloud
• Quick input/mirror input to one or all terminals.
• AI assistant integration (supporting multiple LLM API formats — OpenAI Chat Completions, OpenAI Responses, and Anthropic Messages) to help with command suggestions, script writing, and explaining selected terminal content, create bookmarks/themes, and agent mode to directly do terminal operations
• 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

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

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 [email protected]: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 ./src/build/.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

[email protected]

License

MIT

Star History