# electerm > Open-source terminal / SSH / SFTP / FTP / Telnet / serialport / RDP / VNC / Spice client, supporting Linux, macOS, Windows, Android, HarmonyOS, and iOS. ## About electerm electerm is an open-source terminal / SSH / SFTP / FTP / Telnet / serialport / RDP / VNC / Spice client, supporting Linux, macOS, Windows, Android, HarmonyOS, and iOS. Besides the mainstream Windows / macOS / Linux / Android platforms, electerm also supports HarmonyOS, iOS, and older systems such as Ubuntu 18, Windows 7, macOS 10+, as well as domestic Linux distributions like UOS, Kylin, and LoongArch (both old-world and new-world), as well as RISC-V (riscv64) and PowerPC 64-bit little-endian (ppc64le) Linux. Source code of the official electerm website: [https://electerm.org](https://electerm.org). This repository builds and maintains the electerm homepage, providing product introductions, download entry points for each platform, the theme marketplace, usage videos, and more, with multilingual support. ## Key Features - Works as a terminal / file manager or an SSH / SFTP / FTP / Telnet / serialport / RDP / VNC / Spice client - Supports Windows 7+ (X64/ARM64), HarmonyOS, Android, iOS, macOS 10.15+ (X64/arm64), Linux (X64/arm64/armv7/LoongArch64/RISC-V/ppc64le), and even older systems with glibc 2.17+ - Global hotkey to toggle window visibility (similar to guake, default `ctrl + 2`) - Multi-platform support (Linux / macOS / Windows / Android / HarmonyOS / iOS) - Multi-language support (Chinese, English, Japanese, Korean, Russian, Spanish, French, and more, see [electerm-locales](https://github.com/electerm/electerm-locales), contributions/fixes welcome) - Double-click to directly edit small remote files - Public key + password authentication - Zmodem (rz, sz) and Trzsz (trz/tsz) support, similar to rz/sz, and compatible with tmux, see [Trzsz](https://github.com/trzsz/trzsz) - SSH tunnel and global / session proxy support - Terminal background image and transparent window - Quick commands, UI / terminal themes - Sync bookmarks / themes / quick commands to GitHub / Gitee secret gist, WebDAV, a custom server, or electerm cloud - Integrated AI assistant for command suggestions, script writing, explaining selected content, and creating bookmarks / themes - MCP (Model Context Protocol) widget for AI assistant and external tool integration - see [MCP Widget Usage Guide](https://github.com/electerm/electerm/wiki/MCP-Widget-Usage-Guide) - Deep link support, e.g. `ssh://user@host:22`, `telnet://192.168.2.31:34554` - see [Deep link support wiki](https://github.com/electerm/electerm/wiki/Deep-link-support) - Command-line usage - see [wiki](https://github.com/electerm/electerm/wiki/Command-line-usage) ## Sub-projects and Related Links - Homepage / Downloads: [https://electerm.org](https://electerm.org) - Theme live editor, live preview & sharing: [https://theme.electerm.org](https://theme.electerm.org) - Online demo: [https://demo.electerm.org](https://demo.electerm.org) - electerm online (free cloud app): [https://cloud.electerm.org](https://cloud.electerm.org) - electerm AI: [https://ai.electerm.org](https://ai.electerm.org) - electerm-web (browser version, including mobile): [https://github.com/electerm/electerm-web](https://github.com/electerm/electerm-web) - electerm-android: [https://github.com/electerm/electerm-android](https://github.com/electerm/electerm-android) - electerm-harmony (HarmonyOS): [https://github.com/electerm/electerm-harmony](https://github.com/electerm/electerm-harmony) - electerm-ios (iOS): [https://github.com/electerm/electerm-ios](https://github.com/electerm/electerm-ios) - Docker deployment: [https://github.com/electerm/electerm-web-docker](https://github.com/electerm/electerm-web-docker) - Locales: [https://github.com/electerm/electerm-locales](https://github.com/electerm/electerm-locales) - App stores - Apple App Store: [https://apps.apple.com/cn/app/electerm/id6792971552](https://apps.apple.com/cn/app/electerm/id6792971552) - Huawei AppGallery: [https://appgallery.huawei.com/app/detail?id=org.electerm.electerm](https://appgallery.huawei.com/app/detail?id=org.electerm.electerm) - Microsoft Store: [https://www.microsoft.com/store/apps/9NCN7272GTFF](https://www.microsoft.com/store/apps/9NCN7272GTFF) - Snap Store: [https://snapcraft.io/electerm](https://snapcraft.io/electerm) - Package repositories - deb repo: [https://repos.electerm.org/deb](https://repos.electerm.org/deb) - rpm repo: [https://repos.electerm.org/rpm](https://repos.electerm.org/rpm) ## Main Pages - [Home Page](https://electerm.org/) - Main landing page with download links - [About](https://electerm.org/about/) - About electerm - [Video Guides](https://electerm.org/videos/) - Tutorial videos and demos - [Debian Repository](https://repos.electerm.org/deb) - APT repository setup for Debian/Ubuntu - [RPM Repository](https://repos.electerm.org/rpm) - RPM repository setup for RHEL/CentOS/Fedora - [Sponsor](https://electerm.org/sponsor-electerm/) - Support electerm development ## Download Links - [Windows Downloads](https://electerm.org/#windows) - Installer and portable versions - [macOS Downloads](https://electerm.org/#mac) - DMG for Intel and Apple Silicon - [Linux Downloads](https://electerm.org/#linux) - DEB, RPM, AppImage, Snap packages ## Documentation - [GitHub Repository](https://github.com/electerm/electerm) - Source code and issue tracker - [Wiki](https://github.com/electerm/electerm/wiki) - Documentation and guides - [Known Issues](https://github.com/electerm/electerm/wiki/Know-issues) - Current limitations - [Troubleshooting](https://github.com/electerm/electerm/wiki/Troubleshoot) - Common solutions - [Discussions](https://github.com/electerm/electerm/discussions) - Community forum ## Install - macOS: `brew install --cask electerm` - Linux (snap): `sudo snap install electerm --classic` - Windows: Microsoft Store, winget (`winget install electerm.electerm`), or scoop - npm: `npm i -g electerm` - For installers of each platform and detailed steps, see the official site [https://electerm.org](https://electerm.org) ### macOS ``` brew install --cask electerm ``` ### Windows Via winget: ``` winget install electerm.electerm ``` Or via Scoop: ``` scoop bucket add dorado https://github.com/chawyehsu/dorado scoop install dorado/electerm ``` Or via Microsoft Store: https://www.microsoft.com/store/apps/9NCN7272GTFF ### Linux Via Snap: ``` sudo snap install electerm --classic ``` From Debian repository (Debian/Ubuntu-based systems): https://repos.electerm.org/deb From RPM repository (RHEL/CentOS/Fedora-based systems): https://repos.electerm.org/rpm From npm: ``` npm i -g electerm ``` ## Store Links - [Microsoft Store](https://www.microsoft.com/store/apps/9NCN7272GTFF) - Microsoft Store listing - [Snap Store](https://snapcraft.io/electerm) - Snap package - [Apple App Store](https://apps.apple.com/cn/app/electerm/id6792971552) - iOS app - [Huawei AppGallery](https://appgallery.huawei.com/app/detail?id=org.electerm.electerm) - HarmonyOS / Android app ## Support the Project - [GitHub Sponsors](https://github.com/sponsors/electerm) - [Ko-fi](https://ko-fi.com/zhaoxudong) - WeChat donation (scan QR code: https://electerm.org/electerm-wechat-donate.png) - TRON (TRN20) donation (scan QR code: https://cdn.jsdelivr.net/gh/electerm/electerm-resource@master/static/images/trn20.png, Address: TXk3pQNmQu1vihH76RaEFnK9wg13x4LLCZ) ## Development electerm is built with Node.js and Electron. Requirements: Node.js 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 ``` ## License electerm is released under the [MIT License](https://github.com/electerm/electerm/blob/master/LICENSE). ## Contact - [Report Issues](https://github.com/electerm/electerm/issues) - [Feature Requests](https://github.com/electerm/electerm/discussions) - [Email](mailto:zxdong@gmail.com)