shpool
shpool
是一项服务,它通过允许创建由shpool
拥有的命名shell会话来实现会话持久性,从而避免连接断开时会话丢失。shpool
可以被视为tmux
或GNU screen
的轻量级替代方案。虽然tmux
和screen
接管整个终端并提供窗口分割和平铺功能,但shpool
只提供持久会话。这种方法最大的优势是shpool
不会破坏原生的回滚或复制粘贴功能。
安装
从crates.io安装
使用systemd运行守护进程
运行
cargo install shpool
curl -fLo "${XDG_CONFIG_HOME:-$HOME/.config}/systemd/user/shpool.service" --create-dirs https://raw.githubusercontent.com/shell-pool/shpool/master/systemd/shpool.service
sed -i "s|/usr|$HOME/.cargo|" "${XDG_CONFIG_HOME:-$HOME/.config}/systemd/user/shpool.service"
curl -fLo "${XDG_CONFIG_HOME:-$HOME/.config}/systemd/user/shpool.socket" --create-dirs https://raw.githubusercontent.com/shell-pool/shpool/master/systemd/shpool.socket
systemctl --user enable shpool
systemctl --user start shpool
loginctl enable-linger
不使用systemd
要在不设置systemd的情况下安装,运行
cargo install shpool
如果你不使用systemd,你可以将systemd/shpool.service
文件移植到你自己的初始化系统并使用它,或者你可以使用自动守护进程模式,让shpool在发现没有守护进程时自动分叉一个守护进程。自动守护进程模式默认启用,所以你不需要做任何特殊操作就可以使用它,不过你可以通过nodaemonize
配置选项和-d/-D
命令行开关来控制它的行为。
使用方法
通常,shpool
用于在通过ssh连接到远程主机时提供持久会话。为此,必须在远程主机上安装shpool
。客户端不需要额外的软件。安装和设置完成后,典型的使用模式是ssh进入你安装了shpool的主机,然后通过运行shpool attach main
创建一个新的命名会话。这里的main
是会话的名称。你需要为每个用来连接远程主机的终端创建一个单独的命名会话。如果你的连接断开或卡住,你可以重新ssh进入远程主机,并通过再次运行shpool attach main
重新连接到同一个命名会话。
如果你的终端卡住并且你强制关闭窗口,当你尝试重新连接时,可能会发现shpool
仍然认为有终端连接到你的会话。这很可能是因为ssh代理在徒劳地希望能再次获得一些流量而保持连接打开。你可以直接运行shpool detach main
来强制会话断开连接,然后允许你重新连接。
本README涵盖了基本用法,但你也可以查看wiki获取更多提示和技巧。
故障排除
故障排除wiki页面包含了一些已知陷阱的信息。
配置
你可以通过编辑~/.config/shpool/config.toml
文件来自定义shpool
的一些行为。有关配置选项的深入讨论,请参见CONFIG.md。
Shell配置
bash
如果你使用bash,你可能想确保设置了huponexit
选项,以确保在你离开shell时子进程退出。如果没有这个设置,你在shell会话过程中产生的后台进程将继续存在于shpool
守护进程的进程树中并占用内存。要设置这个选项,请在你的~/.bashrc
中添加
shopt -s huponexit
子命令
shpool daemon
daemon
子命令使shpool
以守护进程模式运行。在这种模式下,shpool
监听传入连接并打开子shell,在表中保留它们的所有权。通常,用户不会直接调用这个子命令,而是从systemd单元文件中调用。
shpool attach
attach
子命令连接到shpool daemon
实例,传入一个名称。如果名称是新的,将创建一个新的shell,如果已经存在,只要没有其他终端当前连接到该会话,就会连接到现有会话。--ttl
标志可用于限制会话的持续时间。
shpool list
列出所有当前的shell会话。
shpool detach
从一个或多个会话中断开连接而不停止它们。如果在shpool
会话内运行且没有指定会话名称参数,将断开当前会话。
shpool kill
终止一个命名的shell会话。
(可选)自动连接到shpool
显式命名的会话
自己指定会话名称可以让你为每个会话分配逻辑角色,如文本编辑。
ssh配置
如果你通常在特定机器上连接到少量具有相同工作的会话,客户端机器上的自定义ssh配置块可能是最合适的。
为此,你可以在客户端机器的~/.ssh/config
中添加一个名为edit
的配置块,如下所示:
Host = edit
Hostname remote.host.example.com
RemoteCommand shpool attach -f edit
RequestTTY yes
你需要为每个会话名称添加一个这样的配置块。然后你可以通过ssh edit
来调用它。
shell函数
如果你希望在指定目标会话名称和机器时有更多灵活性,你可以创建一个自定义shell函数,让你在调用时指定这两者。在你的.bashrc
中添加:
function shpool-ssh () {
if [ $# -ne 2 ] ; then
echo "usage: shpool-ssh <remote-machine> <session-name>" >&2
return 1
fi
ssh -t "-oRemoteCommand=shpool attach -f $2" "$1"
}
然后像这样调用它:shpool-ssh remote.host.example.com main
。
基于本地tty
你可以设置系统,根据本地终端模拟器的tty号自动生成shpool
会话名称,而不是在连接时指定显式名称。为此,你可以在本地机器的~/.ssh/config
中添加一个自定义ssh配置块,如:
Host = by-tty
User remoteuser
Hostname remote.host.example.com
RemoteCommand shpool attach -f "ssh-$(basename $(tty))"
RequestTTY yes
然后通过ssh by-tty
调用它。你也可以将使用$(basename $(tty))
获取本地终端唯一ID的原则应用到自定义shell函数方法中。
基于本地tty的方法的优点是你不需要指定会话名称,但如果你必须关闭本地窗口并打开新终端,可能会遇到问题,这种情况在连接冻结而不是断开时可能会出现。
与其他工具的比较
tmux
和GNU screen
tmux
可能是最著名的会话持久化工具,GNU screen
也有类似的功能集,因此与 shpool
相比,可以认为它们属于同一类别。
shpool
与 tmux
的主要区别在于,tmux
是一个终端多路复用器,必然提供会话持久化功能,而 shpool
只专注于会话持久化。与 tmux
相比,shpool
的理念是管理不同终端是显示器或窗口管理器的工作,而不是会话持久化工具的职责。每个操作系统都有自己切换应用程序的习惯,没有理由在切换终端时改变这些习惯。特别是对于使用平铺窗口管理器(如 i3
、sway
或 xmonad
)的用户来说,tmux 的多路复用功能是多余的。
tmux
在远程渲染终端内容,只将当前视图绘制到屏幕上,而 shpool
直接将所有 shell 输出发送回用户的本地终端。这意味着所有渲染都由单一的终端状态机处理,而不是先通过 tmux
的内部内存终端,然后再由本地终端格式化和重新渲染。这对性能有影响,更重要的是,使用 shpool
的终端会感觉完全原生。回滚和复制粘贴的功能与原生终端完全一致,而使用 tmux
时这些功能可能会有所不同。
mosh
mosh
是另一个专注于提供持久远程 shell 会话的工具。它与这里讨论的其他工具不同,它有自己的网络协议,基于常规 ssh 引导。像 tmux
一样,它在远程渲染屏幕内容,只发送当前视图。它的独特之处在于尝试预测性地猜测在网络延迟情况下向用户显示的正确输出。
shpool
与 mosh
的不同之处在于它与网络无关,像其他大多数工具一样仅限于单台机器。就像 tmux
一样,mosh
会影响回滚和复制粘贴的工作方式,而 shpool
则保持了完全原生的感觉。
dtach
、abduco
和 diss
这些工具与 shpool
最为相似。与 shpool
一样,它们避免了多路复用,只是将原始字节发送回来供本地终端渲染。虽然可以说 shpool
旨在成为 tmux
的简化版,但这些工具遵循相同的理念,更加专注于简单性和专一性。
shpool
旨在为那些只想要会话持久化而不想过多关心它的人提供简单愉快的体验,所以它有一些更"舒适"的功能,这些功能可能不太适合这些工具对简单性的关注。
这些功能中最明显的是 shpool
和这些程序处理重新连接的方式不同。虽然在正常操作下,shpool
不进行任何渲染和 shell 输出的子集处理,但它通过 shpool_vt100
crate 持续维护终端状态的内存渲染。在重新连接时,shpool
将使用这个内存渲染重绘屏幕,因此你可以轻松看到连接断开时的位置。这甚至允许你看到连接断开后生成的输出。
另一个这样的功能是自动提示符前缀。shpool
会检测你是否使用已知的 shell(目前支持 bash
、zsh
或 fish
),并自动在提示符中注入一个前缀,让你知道当前所在的 shpool
会话名称。这增加了一些有用的上下文,防止你丢失终端跟踪,并提供了当前终端状态的提示。
shpool
也缺少一些这些程序具有的功能。特别是,dtach
和 abduco
似乎支持共享会话,而 shpool
只允许单个客户端同时连接到特定会话。可能还有更多功能,因为我对这些工具的了解不如 shpool
深入。
开发
有关如何开发 shpool 的信息,请参阅 HACKING.md。