diff --git a/README.md b/README.md index b7d15aa..7518002 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,102 @@
-🇨🇳 简体中文 +简体中文
# Termora -**Termora** is a terminal emulator and SSH client for Windows, macOS and Linux. +**Termora** is a cross-platform terminal emulator and SSH client, available on **Windows, macOS, and Linux**.
- termora + Readme
-**Termora** is developed using [Kotlin/JVM](https://kotlinlang.org) and partially implements the [XTerm](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html) protocol (with ongoing improvements). Its ultimate vision is to achieve full platform support (including Android, iOS, and iPadOS) through [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html). - -## Features - -- SSH and local terminal support -- Serial port protocol support -- [SFTP](./docs/sftp.png?raw=1) & [Command](./docs/sftp-command.png?raw=1) file transfer support -- Compatible with Windows, macOS, and Linux -- Zmodem protocol support -- SSH port forwarding & Jump hosts -- Support for X11 and SSH-Agent -- Terminal log -- Configuration synchronization via [Gist](https://gist.github.com) & [WebDAV](https://developer.mozilla.org/docs/Glossary/WebDAV) -- Macro support (record and replay scripts) -- Keyword highlighting -- Key management -- Broadcast commands to multiple sessions -- [Find Everywhere](./docs/findeverywhere.png?raw=1) quick navigation -- Data encryption -- Support [plugins](https://www.termora.app/plugins) -- ... - -## Download - -- [Latest release](https://github.com/TermoraDev/termora/releases/latest) -- [Homebrew](https://formulae.brew.sh/cask/termora): `brew install --cask termora` -- [WinGet](https://github.com/microsoft/winget-pkgs/tree/master/manifests/t/TermoraDev/Termora): `winget install termora` - -## Development - -It is recommended to use the [JetBrainsRuntime](https://github.com/JetBrains/JetBrainsRuntime) version of the JDK and run the program via `./gradlew :run` to run the program. - -The program can be run via `./gradlew dist` to automatically build the local version. On macOS: `dmg`, on Windows: `zip`, on Linux: `tar.gz`. +Termora is developed using [**Kotlin/JVM**](https://kotlinlang.org/) and partially implements the [**XTerm control sequence protocol**](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html). Its long-term goal is to achieve **full platform support** (including Android, iOS, and iPadOS) via [**Kotlin Multiplatform**](https://kotlinlang.org/docs/multiplatform.html). -## LICENSE + +## ✨ Features + +- 🧬 Cross-platform support +- 🔐 Built-in key manager +- 🖼️ X11 forwarding +- 🧑‍💻 SSH-Agent integration +- 💻 System information display +- 📁 GUI-based SFTP file management +- 📊 Nvidia GPU usage monitoring +- ⚡ Quick command shortcuts + + +## 🚀 File Transfer + +- Direct transfers between server A ↔ B +- Recursive folder support +- Up to **6 concurrent transfer tasks** + +
+ Transfer +
+ + + +## 📝 File Editing + +- Auto-upload after editing and saving +- Rename files and folders +- Quick deletion of large folders (`rm -rf` supported) +- Visual permission editing +- Create new files and folders + +
+ Transfer Edit +
+ +## 💻 Hosts + +- Tree-like hierarchical structure, similar to folders +- Assign tags to individual hosts +- Import hosts from other tools +- Open with the transfer tool + +
+ Transfer Edit +
+ +## 🧩 Plugins + +- 🌍 Geo: Display geolocation of hosts +- 🔄 Sync: Sync settings to Gist or WebDAV +- 🗂️ WebDAV: Connect to WebDAV storage +- 📝 Editor: Built-in SFTP file editor +- 📡 SMB: Connect to [SMB](https://en.wikipedia.org/wiki/Server_Message_Block) +- ☁️ S3: Connect to S3 object storage +- ☁️ Huawei OBS: Connect to Huawei Cloud OBS +- ☁️ Tencent COS: Connect to Tencent Cloud COS +- ☁️ Alibaba OSS: Connect to Alibaba Cloud OSS +- 👉 [View all plugins...](https://www.termora.app/plugins) + + + + +## 📦 Download + +- 🧾 [Latest Release](https://github.com/TermoraDev/termora/releases/latest) +- 🍺 **Homebrew**: `brew install --cask termora` +- 🔨 **WinGet**: `winget install termora` + + + +## 🛠️ Development + +We recommend using the [JetBrainsRuntime](https://github.com/JetBrains/JetBrainsRuntime) JDK for development. + +- Run locally: `./gradlew :run` +- Build for current OS: `./gradlew :dist` + + + +## 📄 License This software is distributed under a dual-license model. You may choose one of the following options: -- AGPL-3.0: Use, distribute, and modify the software under the terms of the [AGPL-3.0](https://opensource.org/license/agpl-v3). -- Proprietary License: For closed-source or proprietary use, please contact the author to obtain a commercial license. +- **AGPL-3.0**: Use, distribute, and modify the software under the terms of the [AGPL-3.0](https://opensource.org/license/agpl-v3). +- **Proprietary License**: For closed-source or proprietary use, please contact the author to obtain a commercial license. diff --git a/README.zh_CN.md b/README.zh_CN.md index 3a7b637..c6cdd39 100644 --- a/README.zh_CN.md +++ b/README.zh_CN.md @@ -1,48 +1,100 @@ # Termora -**Termora** 是一个终端模拟器和 SSH 客户端，支持 Windows，macOS 和 Linux。 +**Termora** 是一款跨平台终端模拟器和 SSH 客户端，支持 **Windows、macOS、Linux**。
- termora + Readme
-**Termora** 采用 [Kotlin/JVM](https://kotlinlang.org/) 开发并实现了 [XTerm](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html) 协议（尚未完全实现），它的最终目标是通过 [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) 实现全平台（含 Android、iOS、iPadOS 等）。 +Termora 使用 [**Kotlin/JVM**](https://kotlinlang.org/) 开发，支持（正在实现中） [**XTerm 控制序列协议**](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html)。未来目标是借助 [**Kotlin Multiplatform**](https://kotlinlang.org/docs/multiplatform.html) 实现 **全平台支持**，包括 Android、iOS、iPadOS 等。 -## 功能特性 -- 支持 SSH 和本地终端 -- 支持串口协议 -- 支持 [SFTP](./docs/sftp-zh_CN.png?raw=1) & [命令行](./docs/sftp-command.png?raw=1) 文件传输 -- 支持 Windows、macOS、Linux 平台 -- 支持 Zmodem 协议 -- 支持 SSH 端口转发和跳板机 -- 支持 X11 和 SSH-Agent -- 终端日志记录 -- 支持配置同步到 [Gist](https://gist.github.com) & [WebDAV](https://developer.mozilla.org/docs/Glossary/WebDAV) -- 支持宏（录制脚本并回放） -- 支持关键词高亮 -- 支持密钥管理器 -- 支持将命令发送到多个会话 -- 支持 [Find Everywhere](./docs/findeverywhere-zh_CN.png?raw=1) 快速跳转 -- 支持数据加密 -- 支持[插件](https://www.termora.app/plugins) -- ... -## 下载 +## ✨ 功能特性 -- [Latest release](https://github.com/TermoraDev/termora/releases/latest) -- [Homebrew](https://formulae.brew.sh/cask/termora): `brew install --cask termora` -- [WinGet](https://github.com/microsoft/winget-pkgs/tree/master/manifests/t/TermoraDev/Termora): `winget install termora` +- 🧬 跨平台运行 +- 🔐 内建密钥管理器 +- 🖼️ 支持 X11 转发 +- 🧑‍💻 SSH-Agent 集成 +- 💻 系统信息展示 +- 📁 图形化 SFTP 文件管理 +- 📊 Nvidia 显卡使用率查看 +- ⚡ 快捷指令支持 -## 开发 -建议使用 [JetBrainsRuntime](https://github.com/JetBrains/JetBrainsRuntime) 的 JDK 版本，通过 `./gradlew :run` 即可运行程序。 +## 🚀 文件传输 -通过 `./gradlew dist` 可以自动构建适用于本机的版本。在 macOS 上是：`dmg`，在 Windows 上是：`zip`，在 Linux 上是：`tar.gz`。 +- 支持 A ↔ B 服务器间直接传输 +- 文件夹递归复制支持 +- 最多可同时运行 **6 个传输任务** -## 协议 +
+ Transfer +
-本软件采用双重许可模式，您可以选择以下任意一种许可方式： -- AGPL-3.0：根据 [AGPL-3.0](https://opensource.org/license/agpl-v3) 的条款，您可以自由使用、分发和修改本软件。 -- 专有许可：如果希望在闭源或专有环境中使用，请联系作者获取许可。 +## 📝 文件编辑功能 + +- 保存后自动上传修改内容 +- 文件 / 文件夹 重命名 +- 快速删除大文件夹：`rm -rf` 支持 +- 可视化更改权限 +- 支持新建文件 / 文件夹 + +
+ Transfer Edit +
+ + + +## 💻 主机 + +- 类似文件夹树形结构 +- 给主机添加标签 +- 从其它软件导入 +- 使用传输工具打开 + +
+ Transfer Edit +
+ + +## 🧩 插件 + +- 🌍 Geo：显示主机位置信息 +- 🔄 Sync：将配置同步至 Gist 或 WebDAV +- 🗂️ WebDAV：连接 WebDAV 对象存储 +- 📝 Editor：内置 SFTP 文件编辑器 +- 📡 SMB: 连接 [SMB](https://baike.baidu.com/item/smb/4750512) 文件共享协议 +- ☁️ S3：连接 S3 对象存储 +- ☁️ Huawei OBS：连接华为云对象存储 +- ☁️ Tencent COS：连接腾讯云 COS +- ☁️ Alibaba OSS：连接阿里云 OSS +- 👉 [查看所有插件...](https://www.termora.cn/plugins) + + + + +## 📦 下载 + +- 🧾 [Latest release](https://github.com/TermoraDev/termora/releases/latest) +- 🍺 **Homebrew**：`brew install --cask termora` +- 🪟 **WinGet**：`winget install termora` + + + +## 🛠️ 开发指南 + +建议使用 [JetBrainsRuntime](https://github.com/JetBrains/JetBrainsRuntime) JDK 运行环境。 + +- 本地运行：`./gradlew :run` +- 构建当前系统安装包：`./gradlew :dist` + + + +## 📄 授权协议 + +Termora 采用双重许可方式，您可以选择： + +- **AGPL-3.0**：自由使用、修改、分发（遵循 [AGPL 条款](https://opensource.org/license/agpl-v3)） +- **专有许可**：如需闭源或商业用途，请联系作者获取授权 diff --git a/docs/findeverywhere-zh_CN.png b/docs/findeverywhere-zh_CN.png deleted file mode 100644 index 90237e0..0000000 Binary files a/docs/findeverywhere-zh_CN.png and /dev/null differ diff --git a/docs/findeverywhere.png b/docs/findeverywhere.png deleted file mode 100644 index fc9856d..0000000 Binary files a/docs/findeverywhere.png and /dev/null differ diff --git a/docs/host-zh_CN.png b/docs/host-zh_CN.png new file mode 100644 index 0000000..f7a68d9 Binary files /dev/null and b/docs/host-zh_CN.png differ diff --git a/docs/host.png b/docs/host.png new file mode 100644 index 0000000..75c7e3d Binary files /dev/null and b/docs/host.png differ diff --git a/docs/plugins-zh_CN.png b/docs/plugins-zh_CN.png new file mode 100644 index 0000000..a55d1df Binary files /dev/null and b/docs/plugins-zh_CN.png differ diff --git a/docs/plugins.png b/docs/plugins.png new file mode 100644 index 0000000..f08fe6c Binary files /dev/null and b/docs/plugins.png differ diff --git a/docs/readme-zh_CN.png b/docs/readme-zh_CN.png index 0971a14..443a4a4 100644 Binary files a/docs/readme-zh_CN.png and b/docs/readme-zh_CN.png differ diff --git a/docs/readme.png b/docs/readme.png index 3b8558e..a919c69 100644 Binary files a/docs/readme.png and b/docs/readme.png differ diff --git a/docs/sftp-command.png b/docs/sftp-command.png deleted file mode 100644 index 55ea688..0000000 Binary files a/docs/sftp-command.png and /dev/null differ diff --git a/docs/sftp-zh_CN.png b/docs/sftp-zh_CN.png deleted file mode 100644 index 2a1ded3..0000000 Binary files a/docs/sftp-zh_CN.png and /dev/null differ diff --git a/docs/sftp-zh_TW.png b/docs/sftp-zh_TW.png deleted file mode 100644 index 3f7df62..0000000 Binary files a/docs/sftp-zh_TW.png and /dev/null differ diff --git a/docs/sftp.png b/docs/sftp.png deleted file mode 100644 index b06fd65..0000000 Binary files a/docs/sftp.png and /dev/null differ diff --git a/docs/tags-zh_CN.png b/docs/tags-zh_CN.png new file mode 100644 index 0000000..03a2cb5 Binary files /dev/null and b/docs/tags-zh_CN.png differ diff --git a/docs/tags.png b/docs/tags.png new file mode 100644 index 0000000..f43188f Binary files /dev/null and b/docs/tags.png differ diff --git a/docs/transfer-edit-zh_CN.png b/docs/transfer-edit-zh_CN.png new file mode 100644 index 0000000..f4947cf Binary files /dev/null and b/docs/transfer-edit-zh_CN.png differ diff --git a/docs/transfer-edit.png b/docs/transfer-edit.png new file mode 100644 index 0000000..19fd068 Binary files /dev/null and b/docs/transfer-edit.png differ diff --git a/docs/transfer-zh_CN.png b/docs/transfer-zh_CN.png new file mode 100644 index 0000000..0f98368 Binary files /dev/null and b/docs/transfer-zh_CN.png differ diff --git a/docs/transfer.png b/docs/transfer.png new file mode 100644 index 0000000..f8439d8 Binary files /dev/null and b/docs/transfer.png differ