mirror of
https://github.com/electerm/electerm.git
synced 2026-04-25 05:25:50 +03:00
Page:
quick connect
Pages
AI model config guide
Auto data Sync
Autorun electerm when login to os
Command line usage
Connecting to Servers with Special Character Encoding
Connection Hopping Behavior Change in electerm since v1.50.65
Contributors
Create bookmark by AI
Create personal access token
Create secret gist
Custom CSS examples
Custom sync server
Deep link support
Default Profile
Develop in windows
Home
How Electerm Gets the Current Working Directory (pwd) in Terminal When "SFTP Follow Terminal Path" Is Enabled
How to use ssh tunnel
In windows can not access port 30975 issue
Know issues
MCP Widget Usage Guide
Migrate from Version 2 to Version 3
RDP File Transfer
RDP Limitation
SSH Certificate Authentication Guide for electerm
Sponsor electerm
Terminal keywords highlight regular expression exmaples
Troubleshoot
Upgrading from 1.x to 2.x: Data Loss Issue and Recovery
VNC‐session‐known‐issues
Warning about sftp follow ssh path function
WebDAV sync
Workspace Feature
batch operation
gitee data sync warning
privacy notice
proxy format
quick command templates
quick connect
ssh agent
No results
3
quick connect
ZHAO Xudong edited this page 2026-03-11 18:33:33 +08:00
Table of Contents
- Quick Connect
- Quick Links / 快速链接
- English
- Supported Protocols
- Connection String Formats
- Using Options Parameter
- Full Options Reference
- SSH Options
- SSH Tunnel Options (sshTunnels items)
- Connection Hopping Options (connectionHoppings items)
- Telnet Options
- Serial Options
- VNC Options
- RDP Options
- FTP Options
- Web Options
- Spice Options
- Local Options
- Using Query Parameters (for Web Type)
- Shortcut Format
- 中文
Quick Connect
Quick connect allows you to quickly connect to remote servers without saving bookmarks.
Quick Links / 快速链接
English
Supported Protocols
- SSH (
ssh) - Telnet (
telnet) - VNC (
vnc) - RDP (
rdp) - Spice (
spice) - Serial (
serial) - FTP (
ftp) - Web (
http/https)
Connection String Formats
Basic Format
protocol://[username:password@]host[:port]?anyQueryParam=anyValue&anyOtherQueryParam=anyOtherValue&opts={"key":"value"}
Examples
SSH:
ssh://user@192.168.1.100:22
ssh://user:password@192.168.1.100:22?title=MyServer&opts={"title":"MyServer","username":"user","password":"password"}
ssh://192.168.1.100
ssh://user@192.168.1.100
Telnet:
telnet://192.168.1.1:23
telnet://user:password@192.168.1.1:23
VNC:
vnc://user@192.168.1.100:5900
vnc://192.168.1.100:5900
RDP:
rdp://admin@192.168.1.100:3389
rdp://192.168.1.100:3389
Spice:
spice://192.168.1.100:5900
spice://password:192.168.1.100:5900
Serial:
serial://COM1
serial://COM1?baudRate=115200
serial:///dev/ttyUSB0?baudRate=9600
FTP:
ftp://user@ftp.example.com:21
ftp://user:password@ftp.example.com:21
Web (HTTP/HTTPS):
http://192.168.1.100:8080
https://192.168.1.100:8443
https://example.com
Using Options Parameter
You can add additional options using the opts query parameter:
ssh://user@host:22?opts='{"title": "My Server", "any-other-item": "value"}'
Full Options Reference
Below are all the options supported by each connection type. Use them in the opts JSON parameter.
SSH Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "ssh" | Connection type |
host |
string | required | Hostname or IP address |
port |
number | 22 | SSH port |
username |
string | required | SSH username |
password |
string | - | Password for authentication |
privateKey |
string | - | Private key content or path for key-based auth |
passphrase |
string | - | Passphrase for private key/certificate |
certificate |
string | - | Certificate content |
authType |
string | - | Auth type (password|privateKey|profiles) |
profile |
string | - | Profile id to reuse saved auth |
title |
string | - | Bookmark title |
description |
string | - | Bookmark description |
startDirectoryRemote |
string | - | Remote starting directory |
startDirectoryLocal |
string | - | Local starting directory |
enableSsh |
boolean | true | Enable ssh |
enableSftp |
boolean | true | Enable sftp |
sshTunnels |
array | - | SSH tunnel definitions |
connectionHoppings |
array | - | Connection hopping definitions |
useSshAgent |
boolean | true | Use SSH agent |
sshAgent |
string | - | SSH agent path |
serverHostKey |
array | - | Server host key algorithms |
cipher |
array | - | Cipher list |
runScripts |
array | - | Run scripts after connected ({delay,script}) |
quickCommands |
array | - | Quick commands ({name,command}) |
proxy |
string | - | Proxy address (socks5://...) |
x11 |
boolean | false | Enable x11 forwarding |
term |
string | xterm-256color | Terminal type |
displayRaw |
boolean | false | Display raw output |
encode |
string | utf8 | Charset |
envLang |
string | en_US.UTF-8 | ENV LANG |
setEnv |
string | - | Environment variables (KEY1=VALUE1 KEY2=VALUE2) |
color |
string | - | Tag color (#000000) |
SSH Tunnel Options (sshTunnels items)
| Option | Type | Description |
|---|---|---|
sshTunnel |
string | forwardRemoteToLocal|forwardLocalToRemote|dynamicForward |
sshTunnelLocalHost |
string | Local host |
sshTunnelLocalPort |
number | Local port |
sshTunnelRemoteHost |
string | Remote host |
sshTunnelRemotePort |
number | Remote port |
name |
string | Optional tunnel name |
Connection Hopping Options (connectionHoppings items)
| Option | Type | Description |
|---|---|---|
host |
string | Hostname |
port |
number | Port |
username |
string | Username |
password |
string | Password |
privateKey |
string | Private key |
passphrase |
string | Passphrase |
certificate |
string | Certificate |
authType |
string | Auth type |
profile |
string | Profile id |
Telnet Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "telnet" | Connection type |
host |
string | required | Hostname or IP address |
port |
number | 23 | Telnet port |
username |
string | - | Username |
password |
string | - | Password |
title |
string | - | Bookmark title |
description |
string | - | Bookmark description |
loginPrompt |
string | - | Login prompt regex |
passwordPrompt |
string | - | Password prompt regex |
runScripts |
array | - | Run scripts after connected |
startDirectoryRemote |
string | - | Remote starting directory |
startDirectoryLocal |
string | - | Local starting directory |
profile |
string | - | Profile id |
proxy |
string | - | Proxy address (socks5://...) |
Serial Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "serial" | Connection type |
path |
string | required | Serial port path (e.g., /dev/ttyUSB0, COM1) |
baudRate |
number | 9600 | Baud rate |
dataBits |
number | 8 | Data bits |
stopBits |
number | 1 | Stop bits |
parity |
string | "none" | Parity (none|even|odd|mark|space) |
title |
string | - | Bookmark title |
rtscts |
boolean | false | Enable RTS/CTS flow control |
xon |
boolean | false | Enable XON flow control |
xoff |
boolean | false | Enable XOFF flow control |
xany |
boolean | false | Enable XANY flow control |
runScripts |
array | - | Run scripts after connected |
description |
string | - | Bookmark description |
VNC Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "vnc" | Connection type |
host |
string | required | Hostname or IP address |
port |
number | 5900 | VNC port |
username |
string | - | VNC username |
password |
string | - | VNC password |
viewOnly |
boolean | false | View only mode |
clipViewport |
boolean | false | Clip viewport to window |
scaleViewport |
boolean | true | Scale viewport to window |
qualityLevel |
number | 3 | VNC quality level (0-9, lower is faster) |
compressionLevel |
number | 1 | VNC compression level (0-9, lower is faster) |
shared |
boolean | true | Shared session |
proxy |
string | - | Proxy address (socks5://...) |
title |
string | - | Bookmark title |
description |
string | - | Bookmark description |
profile |
string | - | Profile id |
RDP Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "rdp" | Connection type |
host |
string | required | Hostname or IP address |
port |
number | 3389 | RDP port |
username |
string | - | Username |
password |
string | - | Password |
title |
string | - | Bookmark title |
description |
string | - | Bookmark description |
profile |
string | - | Profile id |
proxy |
string | - | Proxy address (socks5://...) |
domain |
string | - | Login domain |
FTP Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "ftp" | Connection type |
host |
string | required | Hostname or IP address |
port |
number | 21 | FTP port |
user |
string | - | Username |
secure |
boolean | false | Use secure FTP (FTPS) |
password |
string | - | Password |
encode |
string | utf-8 | Charset for file names |
title |
string | - | Bookmark title |
profile |
string | - | Profile id |
description |
string | - | Bookmark description |
Web Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "web" | Connection type |
url |
string | required | Website URL |
title |
string | - | Bookmark title |
description |
string | - | Bookmark description |
useragent |
string | - | Custom user agent |
Spice Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "spice" | Connection type |
host |
string | required | Hostname or IP address |
port |
number | 5900 | Spice port |
password |
string | - | Spice password |
title |
string | - | Bookmark title |
viewOnly |
boolean | false | View only mode |
scaleViewport |
boolean | true | Scale viewport to window |
description |
string | - | Bookmark description |
profile |
string | - | Profile id |
proxy |
string | - | Proxy address (socks5://...) |
Local Options
| Option | Type | Default | Description |
|---|---|---|---|
type |
string | "local" | Connection type |
title |
string | - | Bookmark title |
description |
string | - | Bookmark description |
startDirectoryLocal |
string | - | Local starting directory |
runScripts |
array | - | Run scripts after connected |
Using Query Parameters (for Web Type)
You can add URL query parameters directly to the URL:
http://example.com?key=value&foo=bar
https://example.com?title=MyPage&type=web
Shortcut Format
You can also use shortcut formats without the protocol prefix:
# SSH (default)
user@host
user@host:22
192.168.1.100
192.168.1.100:22
# Hostname with colon (e.g., local hostnames)
localhost:23344
my-server:2222
# User with hostname and port
user@localhost:23344
user@my-server:2222
中文
支持的协议
- SSH (
ssh) - Telnet (
telnet) - VNC (
vnc) - RDP (
rdp) - Spice (
spice) - 串口 (
serial) - FTP (
ftp) - Web (
http/https)
连接字符串格式
基本格式
protocol://[username:password@]host[:port]
示例
SSH:
ssh://user@192.168.1.100:22
ssh://user:password@192.168.1.100:22
ssh://192.168.1.100
ssh://user@192.168.1.100
Telnet:
telnet://192.168.1.1:23
telnet://user:password@192.168.1.1:23
VNC:
vnc://user@192.168.1.100:5900
vnc://192.168.1.100:5900
RDP:
rdp://admin@192.168.1.100:3389
rdp://192.168.1.100:3389
Spice:
spice://192.168.1.100:5900
串口:
serial://COM1
serial://COM1?baudRate=115200
serial:///dev/ttyUSB0?baudRate=9600
FTP:
ftp://user@ftp.example.com:21
ftp://user:password@ftp.example.com:21
Web (HTTP/HTTPS):
http://192.168.1.100:8080
https://192.168.1.100:8443
https://example.com
使用选项参数
可以使用 opts 查询参数添加额外选项:
ssh://user@host:22?opts='{"title": "My Server", "any-other-item": "value"}'
完整选项参考
以下是每种连接类型支持的所有选项。可在 opts JSON 参数中使用。
SSH 选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "ssh" | 连接类型 |
host |
string | 必填 | 主机名或IP地址 |
port |
number | 22 | SSH端口 |
username |
string | 必填 | SSH用户名 |
password |
string | - | 认证密码 |
privateKey |
string | - | 私钥内容或路径 |
passphrase |
string | - | 私钥/证书密码短语 |
certificate |
string | - | 证书内容 |
authType |
string | - | 认证类型 (password|privateKey|profiles) |
profile |
string | - | 配置ID以复用保存的认证 |
title |
string | - | 书签标题 |
description |
string | - | 书签描述 |
startDirectoryRemote |
string | - | 远程起始目录 |
startDirectoryLocal |
string | - | 本地起始目录 |
enableSsh |
boolean | true | 启用ssh |
enableSftp |
boolean | true | 启用sftp |
sshTunnels |
array | - | SSH隧道定义 |
connectionHoppings |
array | - | 连接跳转发定义 |
useSshAgent |
boolean | true | 使用SSH代理 |
sshAgent |
string | - | SSH代理路径 |
serverHostKey |
array | - | 服务器主机密钥算法 |
cipher |
array | - | 加密算法列表 |
runScripts |
array | - | 连接后运行的脚本 ({delay,script}) |
quickCommands |
array | - | 快速命令 ({name,command}) |
proxy |
string | - | 代理地址 (socks5://...) |
x11 |
boolean | false | 启用x11转发 |
term |
string | xterm-256color | 终端类型 |
displayRaw |
boolean | false | 显示原始输出 |
encode |
string | utf8 | 字符集 |
envLang |
string | en_US.UTF-8 | 环境语言 |
setEnv |
string | - | 环境变量 (KEY1=VALUE1 KEY2=VALUE2) |
color |
string | - | 标签颜色 (#000000) |
SSH隧道选项 (sshTunnels 项)
| 选项 | 类型 | 描述 |
|---|---|---|
sshTunnel |
string | forwardRemoteToLocal|forwardLocalToRemote|dynamicForward |
sshTunnelLocalHost |
string | 本地主机 |
sshTunnelLocalPort |
number | 本地端口 |
sshTunnelRemoteHost |
string | 远程主机 |
sshTunnelRemotePort |
number | 远程端口 |
name |
string | 可选的隧道名称 |
连接跳转选项 (connectionHoppings 项)
| 选项 | 类型 | 描述 |
|---|---|---|
host |
string | 主机名 |
port |
number | 端口 |
username |
string | 用户名 |
password |
string | 密码 |
privateKey |
string | 私钥 |
passphrase |
string | 密码短语 |
certificate |
string | 证书 |
authType |
string | 认证类型 |
profile |
string | 配置ID |
Telnet 选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "telnet" | 连接类型 |
host |
string | 必填 | 主机名或IP地址 |
port |
number | 23 | Telnet端口 |
username |
string | - | 用户名 |
password |
string | - | 密码 |
title |
string | - | 书签标题 |
description |
string | - | 书签描述 |
loginPrompt |
string | - | 登录提示正则表达式 |
passwordPrompt |
string | - | 密码提示正则表达式 |
runScripts |
array | - | 连接后运行的脚本 |
startDirectoryRemote |
string | - | 远程起始目录 |
startDirectoryLocal |
string | - | 本地起始目录 |
profile |
string | - | 配置ID |
proxy |
string | - | 代理地址 (socks5://...) |
串口选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "serial" | 连接类型 |
path |
string | 必填 | 串口路径 (如 /dev/ttyUSB0, COM1) |
baudRate |
number | 9600 | 波特率 |
dataBits |
number | 8 | 数据位 |
stopBits |
number | 1 | 停止位 |
parity |
string | "none" | 校验 (none|even|odd|mark|space) |
title |
string | - | 书签标题 |
rtscts |
boolean | false | 启用RTS/CTS流控制 |
xon |
boolean | false | 启用XON流控制 |
xoff |
boolean | false | 启用XOFF流控制 |
xany |
boolean | false | 启用XANY流控制 |
runScripts |
array | - | 连接后运行的脚本 |
description |
string | - | 书签描述 |
VNC 选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "vnc" | 连接类型 |
host |
string | 必填 | 主机名或IP地址 |
port |
number | 5900 | VNC端口 |
username |
string | - | VNC用户名 |
password |
string | - | VNC密码 |
viewOnly |
boolean | false | 只读模式 |
clipViewport |
boolean | false | 裁剪视口到窗口 |
scaleViewport |
boolean | true | 缩放视口到窗口 |
qualityLevel |
number | 3 | VNC质量级别 (0-9, 越低越快) |
compressionLevel |
number | 1 | VNC压缩级别 (0-9, 越低越快) |
shared |
boolean | true | 共享会话 |
proxy |
string | - | 代理地址 (socks5://...) |
title |
string | - | 书签标题 |
description |
string | - | 书签描述 |
profile |
string | - | 配置ID |
RDP 选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "rdp" | 连接类型 |
host |
string | 必填 | 主机名或IP地址 |
port |
number | 3389 | RDP端口 |
username |
string | - | 用户名 |
password |
string | - | 密码 |
title |
string | - | 书签标题 |
description |
string | - | 书签描述 |
profile |
string | - | 配置ID |
proxy |
string | - | 代理地址 (socks5://...) |
domain |
string | - | 登录域 |
FTP 选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "ftp" | 连接类型 |
host |
string | 必填 | 主机名或IP地址 |
port |
number | 21 | FTP端口 |
user |
string | - | 用户名 |
secure |
boolean | false | 使用安全FTP (FTPS) |
password |
string | - | 密码 |
encode |
string | utf-8 | 文件名字符集 |
title |
string | - | 书签标题 |
profile |
string | - | 配置ID |
description |
string | - | 书签描述 |
Web 选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "web" | 连接类型 |
url |
string | 必填 | 网站URL |
title |
string | - | 书签标题 |
description |
string | - | 书签描述 |
useragent |
string | - | 自定义用户代理 |
Spice 选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "spice" | 连接类型 |
host |
string | 必填 | 主机名或IP地址 |
port |
number | 5900 | Spice端口 |
password |
string | - | Spice密码 |
title |
string | - | 书签标题 |
viewOnly |
boolean | false | 只读模式 |
scaleViewport |
boolean | true | 缩放视口到窗口 |
description |
string | - | 书签描述 |
profile |
string | - | 配置ID |
proxy |
string | - | 代理地址 (socks5://...) |
本地终端选项
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
type |
string | "local" | 连接类型 |
title |
string | - | 书签标题 |
description |
string | - | 书签描述 |
startDirectoryLocal |
string | - | 本地起始目录 |
runScripts |
array | - | 连接后运行的脚本 |
使用查询参数 (Web类型)
可以直接在URL中添加查询参数:
http://example.com?key=value&foo=bar
https://example.com?title=MyPage&type=web
快捷格式
也可以使用不带协议前缀的快捷格式:
# SSH (默认)
user@host
user@host:22
192.168.1.100
192.168.1.100:22