tunlite

Tunlite

SSH 隧道,你和 Agent 用着都顺手 —— 自己敲 -L/-R/-D 也行,用大白话交给 AI Agent 也行;tunlite 替你建好、连上、断了自动重连。

English · 简体中文

挂 SSH 隧道有多烦,用过的都懂:老手要配 autossh、写 systemd 单元、记一堆 -L/-R/-D,断了还得手动重连;新手连免密、参数都不知道从哪下手。tunlite 把这些 全收进一个命令——自己敲,或用大白话交给 AI Agent,它替你建好、连上、断了自动重连。 纯 Node.js、零依赖,封装你本就信任的 ssh。

完整文档 → tunlite.dev

• 面向 Agent —— 每个命令都讲 --json、退出码稳定,还随包发一份 Agent skill:AI Agent 能端到端地建好、拉起、排障隧道。
• 零第三方依赖 —— 纯 Node.js 标准库;机器上只需 Node ≥ 18 和它封装的系统 ssh。
• 自动重连 —— 指数退避 + 抖动、keepalive、端口健康探测。
• 开机自启 —— launchd(macOS)/ systemd 用户服务(Linux)/ 计划任务(Windows,beta)。
• 免密打通 —— 已能免密则直连;只在需要时帮你装公钥。
• 三种转发 —— 本地 -L、远程 -R、动态 SOCKS -D。

给 Agent 用

AI Agent 是一等用户。用大白话跟它说一句,它就通过和你一样的 --json 接口驱动 tunlite —— 按退出码分支,而不是解析自然语言:

你    ▸ "把 app01 上的 Postgres 转发到我电脑。"
Agent ▸ tunlite add pg --to deploy@app01 -L 5432:localhost:5432 --json   → {"ok":true,…}
Agent ▸ tunlite enable pg --json                                         → exit 4 · needs-auth
Agent ▸ tunlite setup-key deploy@app01                                   → 公钥已安装
Agent ▸ tunlite enable pg --json                                         → {"state":"connected"} · exit 0
Agent ▸ "搞定 —— localhost:5432 已通到 app01 的 Postgres,守护进程会保活它。"

随包附带的 skill/ssh-tunnel(由 tunlite install skill 安装) 告诉 Agent 具体怎么做:--json、按退出码分支、处理 needs-auth。

tunlite monitor 提供一个实时的 top 式面板 —— 一眼看清每条隧道的状态,守护进程会在你 眼前把掉线的那条自动重连回来:

为什么用 tunlite?

如果你常年挂着几条 SSH 隧道 —— 一条回连到家里机器的反向隧道、一条经堡垒机的 SOCKS 代理、 一条到预发数据库的端口转发 —— 你大概给每条都配了 autossh 加一个 systemd/launchd 单元,还得记住哪个 -L/-R/-D 对应哪条。tunlite 把这些折进一个声明式 CLI,跑在你本就 信任的 ssh 之上:命名隧道由守护进程保活、由系统开机拉起 —— 不引入新服务、不开账号、 不造新协议。而且每个命令都是 --json + 稳定退出码,Agent 操作的就是你操作的同一套接口。

	tunlite	autossh	裸 ssh -L/-R/-D	sshuttle	frp · bore · chisel	ngrok
对 Agent 友好(--json / 稳定退出码)						部分
封装系统 ssh(密钥 / 跳板 / ssh_config)				部分	自有协议	自有服务
命名、声明式隧道					配置
自动重连(退避 / keepalive / 健康)		基础
开机自启(launchd/systemd/计划任务)		自己搞	自己搞	自己搞	自己搞
本地 + 远程 + 动态 SOCKS				透明代理	不一	不一
零依赖 · 无需自建服务端 · 自托管		需 autossh		需 python	需服务端	托管/收费

安装

前提:Node ≥ 18 和系统 ssh,都在 PATH 上。

# 推荐 —— 拉取 + 锚定(无需全局 npm)
npx tunlite install

# 或 curl 一行式(只要 curl/wget + tar + node)
curl -fsSL https://raw.githubusercontent.com/yuanyuanzijin/tunlite/master/bootstrap.sh | sh

# Windows(PowerShell)—— beta
irm https://raw.githubusercontent.com/yuanyuanzijin/tunlite/master/bootstrap.ps1 | iex

tunlite install 会把运行时复制到固定目录,并写一个钉死 node 绝对路径的启动器 (这样 nvm/fnm 切版本也不会让它失效),然后逐项询问是否注册开机自启、安装 Agent skill、 启用 shell 补全。加 -y 可一口气全装、不再询问(适合脚本 / CI);不加 -y 又没有终端时 只做"落地"。想单独装某一件,用 tunlite install service / install skill / install completion。tun 这个短名空闲时也会顺带写一个。Windows(自启 / 启动器 / PATH)为 beta —— macOS/Linux 是经 CI 测试的主力平台。

快速开始

# 转发用原生 ssh 标志(可重复 —— 一条隧道可带多个):
tunlite add web   --to me@host -L 8080:localhost:80   # 在 localhost:8080 访问服务器的 :80
tunlite add rev   --to me@host -R 9000:localhost:3000 # 把本地 3000 暴露为服务器:9000
tunlite add socks --to me@host -D 1080                # SOCKS5 代理(本地 1080)

tunlite status             # 对齐表格:NAME STATE HOST TYPE ROUTE PID UP RESTARTS
tunlite logs web -f        # 跟随日志
tunlite doctor             # 体检:为什么连不上

从 0.9.x 升级? 0.10.0 更拥抱原生 ssh,少数命令换了写法 —— 而你已有的隧道配置照常运行、纹丝不动。

• 转发现在直接说 ssh 自己的标志 —— add web --to me@host -L 8080:localhost:80 -D 1080 (可重复;用 set <名字> 就地编辑)。早先的 add local/remote/dynamic 写法由此让位。
• 开关一条隧道现在是 enable / disable(此前 up/down),每个都点明作用对象 —— 名字、--tag <标签> 或 all。打错或用了退役的词,会温和地指向正确的那个(tunlite up → "did you mean enable?")。

跑 tunlite update(或 npx tunlite@latest install),再用 tunlite --version 确认。

目标还没免密时,在终端跑 tunlite enable <名字> 会让你输一次密码并自动装公钥。也可显式来: tunlite check user@server(退出 0 = 已免密)/ tunlite setup-key user@server。

开机自启(可选):tunlite install service 把守护进程注册成登录自启(崩溃也会拉起)。 它当场也会把一切启动起来,所以想让隧道持久常驻时,它替代 enable —— 两者不用都做。

升级

tunlite update              # 升到最新(默认重启守护进程,隧道闪断约 1 秒)
tunlite update v0.9.0       # 装/回退到指定标签
tunlite update --check      # 只比对当前与最新,不做改动

update 升级到最新的 release tag:从 GitHub 拉那个 tag 的 tar 包就地重新锚定 (不走 npm、不走 git)—— npx 装第一份,update 把它保持在一个真实已发布的版本。 它只自更新锚定安装:在 git 检出里提示你用 git pull,在 npm i -g 安装里提示你用 npm i -g tunlite@latest(让那条渠道的版本元数据保持权威)。

命令一览

add <name> -L/-R/-D …      定义隧道              set / rm / rename     改 / 删 / 重命名
list [--tag T]             列出隧道              run --to … -L/-R/-D …   无守护进程的前台隧道
enable / disable / restart 控制(名字|--tag|全部)
status / logs / monitor    查看(表格 · 跟随 · 实时面板)
doctor                     为什么隧道连不上
check / setup-key          探测 / 安装免密访问
webhook …                  掉线告警到 webhook(generic · 企业微信)
export / import            备份 / 合并隧道
install [service|skill|completion] / uninstall    锚定运行时 · 自启 · Agent skill · Tab 补全
update                     从 GitHub 自更新

完整参数跑 tunlite help 或给任意命令加 --help;跳板机(--jump)、标签(--tag)、 webhook 的 channel/事件、shell 补全等细节见 文档站。

**转发模型:**转发直接用原生 ssh 标志,且可重复 —— 一条隧道可带多个:

• -L [bind:]PORT:HOST:HOSTPORT —— 本地转发:在本地访问远端服务。
• -R [bind:]PORT:HOST:HOSTPORT —— 远程转发:把本地服务暴露到服务器。
• -D [bind:]PORT —— 动态:本地 SOCKS5 代理。

可选的 bind: 前缀是监听地址 —— 默认只监听本机回环;用 0.0.0.0 把监听暴露到局域网。 IPv6 地址要用方括号([::1])。SSH 端口写在目标上(--to user@host:2222,默认 22)。 改一条隧道的转发用 set <name>:只要带上任意 -L/-R/-D 就会替换整组转发 (set 是唯一的转发编辑入口)。

退出码(任意命令可加 --json):0 成功 · 2 用法 · 3 没找到 · 4 缺密钥 · 5 连不上守护进程 · 1 其它。

工作原理

三个角色,各司一职:

角色	是什么	干什么
CLI(tunlite …)	你敲的命令	改 config.json、跟守护进程通信、跑一次性 ssh,做完即退。
守护进程(tunlite daemon run)	常驻后台进程	真正保持隧道连接、掉线重连、提供 status/logs。
服务(install service)	一条 launchd/systemd/计划任务条目	保活守护进程 —— 开机拉起、崩溃重启。

config.json 是唯一事实来源。系统服务保活守护进程,守护进程保活每条隧道。日常你只需 add → enable → status/logs,想要开机自启再 install service 一次。

无守护进程:run

容器、systemd 入口这类不方便跑后台守护进程的场景,用 run 在前台监管一条隧道 (自动重连、keepalive),一直挂着直到你停止它 —— 不起守护进程,也不写进 config.json:

tunlite run --to me@host -L 8080:localhost:80
tunlite run --to me@host -R 9000:localhost:3000 --name rev --json --exit-on-failure

--name 为该临时隧道设置标签(默认使用目标主机名)。--json 在 stdout 输出 NDJSON 状态行(每次状态变化 一行 JSON)。--exit-on-failure 失败即以非零码退出而非重试 —— needs-auth → 4、 blocked/failed → 1 —— 方便上层 supervisor 重启。

版本与许可

语义化版本(vMAJOR.MINOR.PATCH);更新记录见 CHANGELOG.md。 MIT。