EdgeTerm TutorialEdgeTerm 使用教程

A hands-on guide to every feature — from your first connection to ZMODEM file transfers. 逐个功能的实操指南 —— 从第一次连接到 ZMODEM 文件传输。

Shortcuts are written with (macOS); Windows and Linux use Ctrl+Shift or Alt instead — see Keyboard Shortcuts for the full table. 本文快捷键以 macOS 的 表示;Windows / Linux 下对应 Ctrl+ShiftAlt 组合,完整对照见快捷键一览

🚀Getting Started快速上手

Download the installer for your platform from GitHub Releases: GitHub Releases 下载对应平台的安装包:

  • Windowsrun the NSIS .exe installer (x64).运行 NSIS .exe 安装程序(x64)。
  • macOSopen the .dmg and drag EdgeTerm into Applications (Apple Silicon).打开 .dmg,把 EdgeTerm 拖入「应用程序」(Apple Silicon)。
  • Linuxinstall the .deb, or chmod +x the .AppImage and run it directly (x64 / ARM64).安装 .deb,或给 .AppImage 加执行权限(chmod +x)后直接运行(x64 / ARM64)。
Note注意 Releases are not yet notarized on macOS or Authenticode-signed on Windows, so the OS may warn on first launch. On macOS, right-click the app and choose Open; on Windows, click More info → Run anyway. Automatic updates are still cryptographically signed and verified. 当前版本尚未做 macOS 公证 / Windows 代码签名,首次启动系统可能弹出安全提示。macOS 下右键应用选择「打开」;Windows 下点击「更多信息 → 仍要运行」。应用内自动更新仍然经过签名校验,安全性不受影响。

🗺️Main Window主窗口布局

The window is organized around the terminal, with three dockable panels: 窗口以终端为中心,外围有三个可显示 / 隐藏的面板:

Area区域What it does作用Toggle开关
Session (left)(左侧)Saved connection profiles, double-click to connect已保存的连接配置,双击连接⌘⌥←
Filer (right)(右侧)File browser — local files, or SFTP for SSH sessions文件浏览器 —— 本地文件;SSH 会话下自动切换为 SFTP⌘⌥→
Sender (bottom)(底部)Send commands or hex bytes to one or all sessions向当前或全部会话发送命令 / 十六进制数据⌘⌥↓
  • Tabs — each open session is a tab. Switch with ⌘[ / ⌘] or jump directly with ⌘1⌘9.标签页 —— 每个打开的会话是一个标签。用 ⌘[ / ⌘] 切换,或用 ⌘1⌘9 直接跳转。
  • Address bar — shows the active session as ssh › host:port.地址栏 —— 以 ssh › host:port 形式显示当前会话。
  • Status bar — terminal size (columns × rows), cursor position (Ln/Ch), and the session protocol.状态栏 —— 终端尺寸(列 × 行)、光标位置(Ln/Ch)和会话协议。

🔗Creating Sessions创建会话

Press ⌘N or use Session → New Session… to open the new-session dialog. Pick a Protocol at the top, give the session a Name and an optional Color (shown on the tab and in the Session panel), fill in the connection details, then either: ⌘N 或点击菜单 Session → New Session… 打开新建会话对话框。先在顶部选择 Protocol(协议),再填写 Name(名称)和可选的 Color(颜色,会显示在标签页和 Session 面板中),然后填写连接信息,最后:

  • Connect — saves the profile and opens the session immediately;Connect —— 保存配置并立刻连接;
  • Save — saves it to the Session panel for later.Save —— 仅保存到 Session 面板,稍后使用。

Local Shell本地 Shell

A real pseudoterminal on your machine with synchronized window resizing. Optional fields: Shell (defaults to $SHELL, or %COMSPEC% on Windows) and Directory (the starting directory, defaults to your home). The Shell field is a full command line, so arguments work: wsl.exe -d Ubuntu, pwsh -NoLogo or /bin/zsh -l; quote a path that contains spaces. 本机上真正的伪终端,窗口尺寸自动同步。可选字段:Shell(默认使用 $SHELL,Windows 下为 %COMSPEC%)和 Directory(起始目录,默认为用户主目录)。Shell 字段是完整的命令行,可以带参数:wsl.exe -d Ubuntupwsh -NoLogo/bin/zsh -l;路径含空格时请加引号。

SSH

Fill in Host, Port (default 22) and Username, then choose one of three Authentication methods: 填写 HostPort(默认 22)和 Username,然后从三种 Authentication(认证方式)中选择:

  • Password — enter the account password;Password —— 输入账户密码;
  • Public key — point Private key to your key file (e.g. ~/.ssh/id_ed25519) and enter the Passphrase if the key has one;Public key —— 在 Private key 中填写私钥路径(如 ~/.ssh/id_ed25519),如私钥有口令则填写 Passphrase
  • SSH agent — use the keys already loaded in your local ssh-agent, no secrets stored.SSH agent —— 直接使用本机 ssh-agent 中已加载的密钥,不保存任何秘密。
Security安全 Passwords and passphrases are stored in credentials.json inside the app's config directory, readable only by your system user. They are never sent to the frontend or written into sessions.json, and saved sessions reconnect after a restart without triggering the macOS Keychain password dialog. The file is sealed (ChaCha20-Poly1305) with a key derived from the machine id and your account name, so it opens automatically here and is useless when copied elsewhere; it protects the file at rest, not against programs running under your own account. 密码和私钥口令保存在应用配置目录下的 credentials.json 中,仅当前系统用户可读;不会返回给前端,也不会写入 sessions.json。重启后已保存会话可直接重连,不会触发 macOS 钥匙串的电脑密码授权框。该文件以机器 ID 和当前用户名派生的密钥加密(ChaCha20-Poly1305),本机自动打开、拷到别处无法解密;它保护的是静态文件,不防同一账户下运行的程序。

FTP

Fill in Host, Port (default 21) and Username — use anonymous for anonymous FTP, in which case the password is optional. FTP sessions open the dedicated dual-pane FTP workspace instead of a terminal. 填写 HostPort(默认 21)和 Username —— 匿名 FTP 请使用 anonymous,此时密码可留空。FTP 会话打开的是专用的双栏 FTP 工作区,而不是终端。

Warning警告 Standard FTP encrypts neither credentials nor file contents. Use it only on trusted networks; prefer SSH/SFTP whenever transport security matters. 标准 FTP 不加密凭据和文件内容,只应在可信网络中使用;需要传输安全时请改用 SSH / SFTP。

Serial串口

Select a Port from the drop-down (use the refresh button to rescan after plugging in a device), then configure Baud rate (e.g. 115200 — common rates are suggested, or type any value), Data bits, Stop bits, Parity and Flow control to match your device. Port 下拉框中选择串口(插入设备后可点刷新按钮重新扫描),然后按设备要求配置 Baud rate(波特率,如 115200,提供常用值也可手动输入)、Data bits(数据位)、Stop bits(停止位)、Parity(校验位)和 Flow control(流控)。

📇Session PanelSession 面板

The Session panel on the left (⌘⌥←) lists all saved profiles, grouped by type — Local, SSH, FTP and Serial — in collapsible groups. A built-in Local Shell entry is always available. 左侧的 Session 面板(⌘⌥←)按类型分组列出所有已保存的配置 —— Local、SSH、FTP、Serial,分组可折叠展开。内置的本地 Shell 项始终可用。

  • Connect — double-click a profile to open it in a new tab.连接 —— 双击配置即可在新标签中打开。
  • Filter — type in the filter box at the top to search profiles by name.过滤 —— 在顶部的 Filter 输入框中按名称搜索。
  • Edit / Delete — hover a profile row to reveal its edit and delete buttons. Editing reopens the session dialog with the saved values.编辑 / 删除 —— 鼠标悬停在条目上会出现编辑和删除按钮。编辑会带着已保存的配置重新打开会话对话框。
  • New — the panel's + button opens the new-session dialog, same as ⌘N.新建 —— 面板上的 + 按钮与 ⌘N 相同,打开新建会话对话框。

⌨️Using the Terminal终端使用

Timestamp & line-number gutter时间戳与行号侧栏

Every output line carries a [HH:MM:SS.SSS] timestamp and a cumulative line number, with the cursor line highlighted — invaluable when reading logs or reporting when something happened. Switch modes under Session → Timestamp & Line: 每行输出都带有 [HH:MM:SS.SSS] 时间戳和累计行号,光标行高亮 —— 查日志、复盘「什么时候发生了什么」时非常有用。在 Session → Timestamp & Line 下切换四种模式:

  • Timestamp + Line Numberboth columns (default);时间戳和行号都显示(默认);
  • Line Number Onlyline numbers only;只显示行号;
  • Timestamp Onlytimestamps only;只显示时间戳;
  • No Guttera clean, classic terminal.隐藏侧栏,回到传统终端外观。

Colors & semantic highlighting色彩与语义高亮

The terminal renders ANSI 16-color, 256-color and 24-bit true color. On top of that, output with no ANSI styling gets semantic highlighting automatically: prompts, options, operators and rainbow brackets, ls -l permission bits, table headers, log levels and Kubernetes/Docker states, network addresses, file paths, Git diffs, HTTP requests, JSON/YAML and more are colorized in a warm palette, with subtle line bands behind errors, warnings, diffs and headers and underlined links, so plain logs stay readable. 终端支持 ANSI 16 色、256 色和 24 位真彩渲染。对没有 ANSI 样式的输出还会自动补充暖色语义高亮:提示符、选项、运算符与彩虹括号、ls -l 权限位、表头行、日志级别与 Kubernetes/Docker 状态、网络地址、文件路径、Git diff、HTTP、JSON/YAML 等都会着色,错误、警告、diff 和表头行还有淡色底带,链接带下划线,纯文本日志也一目了然。

Search, copy, paste, clear查找、复制、粘贴、清屏

  • ⌘F opens search over the scrollback buffer; ⌘G jumps to the next match (also under the Search menu).⌘F 在回滚缓冲区中查找;⌘G 跳到下一个匹配(也可用 Search 菜单)。
  • ⌘C copies the selection, ⌘V pastes — both work inside the terminal (see the Edit menu).⌘C 复制选中内容,⌘V 粘贴 —— 终端内直接可用(对应 Edit 菜单)。
  • ⌘K (Edit → Clear Buffer) clears the screen and scrollback.⌘KEdit → Clear Buffer)清空屏幕和回滚缓冲区。

🗂️Filer & SFTPFiler 与 SFTP

The Filer on the right (⌘⌥→) is a file browser that follows the active session: for SSH sessions it automatically switches to SFTP over the same connection (no separate login); for other sessions it browses the local filesystem. 右侧的 Filer(⌘⌥→)是跟随当前会话的文件浏览器:SSH 会话下自动切换为 SFTP(复用同一条连接,无需再次登录);其他会话下浏览本地文件系统。

Toolbar actions:工具栏操作:

  • New folder — create a directory in the current path;New folder —— 在当前路径新建目录;
  • Upload files / Upload folder — pick local files or whole folders to upload to the current remote directory (SSH sessions); folders are recreated recursively;Upload files / Upload folder —— 选择本地文件或整个文件夹上传到当前远程目录(SSH 会话),文件夹会递归重建;
  • Download — download the selected remote file to a local location, or a remote folder (with everything inside it) into a local directory you choose;Download —— 把选中的远程文件下载到本地,或把远程文件夹(含全部内容)下载到你选择的本地目录中;
  • Delete, Refresh, Parent folder — manage and navigate the listing;DeleteRefreshParent folder —— 删除、刷新、返回上级目录;
  • Drag & drop — drop files or folders from your system file manager onto the Filer to upload them; a progress indicator tracks each transfer.拖拽上传 —— 直接把文件或文件夹从系统文件管理器拖进 Filer 即可上传,每个传输都有进度显示。

Double-click a folder to enter it, or a file to open it in your default application; right-click an entry to open it with another application, download it, copy its path or delete it. A remote file opens as a local copy, and every save is sent back to the server. 双击目录进入,双击文件用默认应用打开;右击条目可选择其他应用打开、下载、复制路径或删除。远程文件以本地副本打开,每次保存都会回传服务器。

📁FTP WorkspaceFTP 工作区

Opening an FTP session shows a dedicated dual-pane file manager instead of a terminal: the FTP server on the left, your local machine on the right. 打开 FTP 会话后显示的是专用的双栏文件管理器,而不是终端:左侧为 FTP 服务器右侧为本机

  • Two-way transfers — copy files or whole folders in either direction; transfers stream, so large files don't need to fit in memory. Folders are recreated recursively, and an existing folder with the same name is merged into (files with the same names are replaced).双向传输 —— 两个方向都可以复制文件或整个文件夹,全部为流式传输,大文件不占内存;文件夹会递归重建,目标已存在同名文件夹时会合并(同名文件被替换)。
  • File management — create directories, rename, and delete (delete is non-recursive: empty a directory before deleting it).文件管理 —— 支持新建目录、重命名和删除(删除为非递归:目录需先清空再删除)。
  • Encoding — server file names in UTF-8 or GBK are detected and decoded automatically.编码 —— 自动识别并解码服务器上 UTF-8 / GBK 编码的文件名。
  • Passive mode — browsing uses passive mode, which works through most firewalls and NAT.被动模式 —— 浏览使用被动模式,能穿过大多数防火墙和 NAT。

📤SenderSender 发送器

The Sender at the bottom (⌘⌥↓) sends a command or raw bytes to one or many sessions at once — handy for serial devices and for driving several servers in parallel. 底部的 Sender(⌘⌥↓)可以把命令或原始字节一次发送到一个或多个会话 —— 调串口设备、同时操作多台服务器时非常方便。

  1. Choose the format: Text, or Hex for raw bytes written as hex pairs (e.g. DE AD BE EF);选择格式:Text 文本,或 Hex 十六进制字节(如 DE AD BE EF);
  2. Pick the line Ending appended after the payload: None, LF (\n) or CRLF (\r\n) — serial devices often require CRLF;选择 Ending(发送后附加的行尾):NoneLF (\n)CRLF (\r\n) —— 串口设备通常需要 CRLF;
  3. Pick the Targets: Current Session or All Sessions;选择 Targets(目标):Current Session 当前会话,或 All Sessions 全部会话;
  4. Type the command and press (or Enter) to send; clears the input.输入命令后点 (或回车)发送; 清空输入。

Saved commands常用命令库

Frequently used commands can be saved with an optional tag name and re-sent with one click. Each saved command remembers its own format and line ending, and the list pages when it grows long. Right-click a tag for Edit (loads it into the inputs — change it and press Update, or Cancel / Esc to keep it as it was), Line ending, Scope and Delete. Sessions that are busy with a ZMODEM transfer are skipped automatically and reported in the status bar. 常用命令可以起一个标签名保存下来,之后一键重发。每条保存的命令都记住自己的格式和行尾设置,数量多时自动分页。右击标签可以 Edit(载入输入框修改后点 Update,或 Cancel / Esc 放弃修改)、切换 Line ending 行尾、调整 Scope 作用域,以及 Delete 删除。正在进行 ZMODEM 传输的会话会被自动跳过,并在状态栏提示。

Every saved command has a scope that decides where it is listed: Everywhere, one session kind (SSH Sessions, Serial Sessions, Shell Sessions), a Session panel group (including everything nested in it), or one saved session. The Sender shows the commands that apply to the active tab in one alphabetical list (hover a tag to see its scope), so serial hex frames never clutter an SSH session and a group's commands appear on every server in it. Pressing Save (or Update) asks where to list the command — the choices run from broad to narrow, with Everywhere preselected at first and your last choice afterwards — and the right-click Scope submenu moves an existing one. Deleting a session removes everything that belongs to it — its credentials and the commands saved for that session alone — and deleting a group removes everything in it: subgroups, their sessions and the commands scoped to any of them (the confirmation says how many). 每条保存的命令都有一个作用域,决定它在哪里显示:Everywhere(全部)、某类会话(SSH SessionsSerial SessionsShell Sessions)、Session 面板的某个分组(含其中嵌套的所有内容),或某个已保存的会话。Sender 只显示对当前标签页适用的命令,统一按名称排序(悬停标签可见其作用域),串口的 hex 帧不会混进 SSH 会话,分组的命令则在组内每台服务器上都可用。点 Save(或 Update)时会询问把命令放到哪一层 —— 选项按范围从大到小排列,初次预选 Everywhere,之后预选上次的选择;右击菜单的 Scope 子菜单可以移动已有命令。删除会话会移除属于它的一切 —— 凭据以及只保存给这个会话的命令;删除分组则移除其中的一切 —— 子分组、其中的会话,以及作用域为这些分组或会话的命令(确认框会显示数量)。

ZMODEM TransfersZMODEM 传输

Local shell, SSH and serial terminals detect ZMODEM automatically — transfer files right inside the terminal, no extra setup: 本地 Shell、SSH 和串口终端会自动检测 ZMODEM —— 直接在终端里传文件,无需任何额外配置:

  • Send to the remote — run rz on the remote side; EdgeTerm pops up a file picker where you can select one or more local files to send.发送到远端 —— 在远端执行 rz,EdgeTerm 会弹出文件选择框,可选择一个或多个本地文件发送。
  • Receive from the remote — run sz <file> on the remote side; EdgeTerm asks where to save each incoming file.从远端接收 —— 在远端执行 sz <文件>,EdgeTerm 会为每个接收的文件询问保存位置。
  • Cancel — use Session → Cancel ZMODEM Transfer to stop an active transfer.取消 —— 通过 Session → Cancel ZMODEM Transfer 中止正在进行的传输。
Tip提示 The remote side needs a compatible rz/sz implementation — install lrzsz (e.g. apt install lrzsz). Transfers are binary-safe and processed in fixed 1 MiB chunks. Resume is not supported yet: restart an interrupted transfer from the beginning. 对端需要安装兼容的 rz/sz 实现 —— 例如 lrzszapt install lrzsz)。传输为二进制安全,按固定 1 MiB 分块处理。暂不支持断点续传,中断后需从头重传。

🖥️Display Settings显示设置

Open View → Display Settings… to adjust: 打开 View → Display Settings… 可调整:

  • Panel font size — the UI panels (Filer, Session, Sender);Panel font size —— 界面面板(Filer、Session、Sender)的字号;
  • Buffer font size — the terminal text itself;Buffer font size —— 终端文本字号;
  • Scrollback — how many lines the terminal keeps in history.Scrollback —— 终端保留的历史行数。

These settings persist across restarts. The View menu also toggles the three panels, and Help → Restore Default Settings… resets everything to defaults. 这些设置会持久保存。View 菜单还可以显示 / 隐藏三个面板;Help → Restore Default Settings… 可一键恢复默认设置。

💾Export & Import数据导出与导入

Session → Export Data… saves everything you have set up into one .edgeterm file (plain JSON inside): saved sessions with their groups, the Sender's saved commands, and the display settings (panels, gutter mode, theme, font sizes, scrollback, command suggestions, mouse copy / paste). Use it as a backup or to move to another computer. Session → Export Data… 把你配置好的一切保存为一个 .edgeterm 文件(内容为 JSON):保存的会话及其分组、Sender 的常用命令,以及显示设置(面板显示、侧栏模式、主题、字号、回滚行数、命令建议、鼠标复制 / 粘贴)。可用于备份或迁移到另一台电脑。

Session → Import Data… accepts only .edgeterm files, checks that the contents really are an EdgeTerm export of a known version, shows what the file contains, and merges it after you confirm: entries with the same id replace the local ones, everything else is added, and nothing already on this machine is deleted. Settings in the file are applied immediately. Session → Import Data… 只接受 .edgeterm 文件,并校验内容确实是已知版本的 EdgeTerm 导出,先显示其中的内容,确认后再合并:同 id 的条目覆盖本地,其余追加,本机已有的数据一律不会被删除。文件中的设置会立即生效。

Passwords and private-key passphrases are never written to a data file, and any found in one are ignored on import — imported SSH / FTP sessions ask for their credentials again. Host names, user names and key paths are included, so treat the file as you would any configuration backup. 密码和私钥口令永远不会写入数据文件,文件里即使有也会在导入时被忽略 —— 导入的 SSH / FTP 会话连接时需要重新输入凭据。文件包含主机名、用户名和私钥路径,请像对待其他配置备份一样妥善保管。

🔄Updates自动更新

EdgeTerm checks the latest GitHub Release on startup. When a newer version exists, it can download, verify, install and restart — all in-app. You can also check manually via Help → Check for Updates…. EdgeTerm 启动时自动检查 GitHub 最新 Release。发现新版本后可在应用内完成下载、校验、安装并重启。也可以随时通过 Help → Check for Updates… 手动检查。

Update bundles are signed with a Tauri updater key and verification cannot be disabled. Supported: Windows x64, macOS Apple Silicon, Linux x64 / ARM64; Linux AppImage and DEB installs update in their original package format. 更新包使用 Tauri updater 密钥签名,签名校验不可关闭。支持 Windows x64、macOS Apple Silicon、Linux x64 / ARM64;Linux AppImage 和 DEB 安装会按原包格式更新。

Keyboard Shortcuts快捷键一览

macOSWindows / LinuxAction动作
⌘NAlt+NOpen the new-session dialog打开新建会话对话框
⌘WCtrl+Shift+WClose the current session关闭当前会话
⌘F / ⌘GCtrl+Shift+F / Ctrl+Shift+GSearch the buffer / find next缓冲区查找 / 下一个匹配
⌘KAlt+KClear the screen and scrollback清屏并清空回滚缓冲区
⌘[ / ⌘]Alt+[ / Alt+]Previous / next open session上一个 / 下一个已打开会话
⌘1⌘9Alt+1Alt+9Jump to tab N跳转到第 N 个标签
⌘⌥← / ⌘⌥→ / ⌘⌥↓Ctrl+Alt+← / Ctrl+Alt+→ / Ctrl+Alt+↓Toggle Session / Filer / Sender显示或隐藏 Session / Filer / Sender
⌘C / ⌘VCtrl+Shift+C / Ctrl+Shift+VCopy / paste inside the terminal终端内复制 / 粘贴
⌘ACtrl+Shift+ASelect the whole terminal buffer全选终端缓冲区

A right click in the terminal opens a context menu — Copy, Paste, Select All, Clear Buffer and Reveal Working Directory in Filer — with the word under the pointer selected first. Middle-click pastes. On Windows and Linux, Edit → Right Click switches the right button to Copy or Paste, the console convention: it copies the selection if there is one and pastes otherwise, without opening a menu. macOS always opens the menu. Programs that take over the mouse, such as vim or tmux, receive the clicks instead; on Windows / Linux hold Shift to bypass them. 在终端里点击右键会弹出上下文菜单——Copy / Paste / Select All / Clear Buffer / Reveal Working Directory in Filer,并先选中指针所在的单词。中键粘贴。Windows 和 Linux 下可在 Edit → Right Click 把右键改成 Copy or Paste,也就是控制台惯例:有选区时复制,没有选区时粘贴,不再弹出菜单。macOS 始终弹菜单。vim、tmux 等接管了鼠标的程序会收到这些点击;Windows / Linux 下按住 Shift 可绕过它们。

On Windows and Linux plain Ctrl+letter is passed through to the shell (Ctrl+C interrupts, Ctrl+W kills a word) and Alt+letter is readline's Meta layer (Alt+F / Alt+B jump by word), which is why the editing shortcuts use Ctrl+Shift there. Windows / Linux 下 Ctrl+字母 会原样发送给 Shell(Ctrl+C 中断、Ctrl+W 删词),Alt+字母 则是 readline 的 Meta 键位(Alt+F / Alt+B 按词跳转),因此编辑类快捷键改用 Ctrl+Shift

Limitations & FAQ限制与常见问题

  • Not yet implemented — port forwarding / tunneling, session recording and playback, split panes with multiple tabs.尚未实现 —— 端口转发 / 隧道、会话录制回放、多标签分屏。
  • ZMODEM resume — not supported; restart interrupted transfers from the beginning.ZMODEM 断点续传 —— 暂不支持,中断后需从头重传。
  • FTP delete is non-recursive — empty a directory before deleting it.FTP 删除为非递归 —— 删除目录前需先清空其内容。
  • OS warning on first install — expected while releases are not notarized / Authenticode-signed; see Getting Started.首次安装的系统警告 —— 由于版本暂未做公证 / 代码签名,属预期现象;见快速上手

Found a bug or want a feature? Open an issue on GitHub. 发现问题或想要新功能?欢迎到 GitHub 提 issue。