rmate 项目技术文档

1. 安装指南

快速安装

您可以通过以下命令快速安装 rmate：

sudo wget -O /usr/local/bin/rmate https://raw.githubusercontent.com/aurora/rmate/master/rmate
sudo chmod a+x /usr/local/bin/rmate

或者使用 bpkg 进行安装：

bpkg install aurora/rmate

确保您的系统中已安装 bash 且编译了 /dev/tcp 支持。

2. 项目使用说明

配置编辑器

TextMate 2

在 TextMate 2 的首选项中，启用 "Allow rmate connections" 设置，位于 "Terminal" 设置中。根据需要调整 "Access for" 设置：

本地客户端

建议仅允许本地客户端访问。在这种情况下，您需要打开到您想要编辑文件的系统的 SSH 连接，并指定一个远程隧道：

ssh -R 52698:localhost:52698 [e-mail]

或者在本地 ~/.ssh/config 文件中添加以下行：

Host example.com
    RemoteForward 52698 127.0.0.1:52698

登录到远程系统后，现在可以执行：

rmate test.txt

远程客户端

在某些机器上，如果无法进行端口转发（例如，由于缺少 ssh 守护进程），可以允许 "远程客户端" 访问。只需通过 ssh 或 telnet 连接到远程机器并执行：

rmate -H textmate-host test.txt

Sublime Text

要使用 rmate 与 Sublime Text 配合使用，您需要安装一个插件，例如 rsub 或 RemoteSubl。

您可以通过 Package Control 安装插件，安装 Package Control，然后按 Cmd + Shift + P（Mac）或 Ctrl + Shift + P（Linux/Windows），选择 Package Control: Install Package，最后选择 rsub 或 RemoteSubl。

也可以手动安装插件。

• Linux

git clone https://github.com/henrikpersson/rsub ~/.config/sublime-text-3/Packages/rsub
git clone https://github.com/randy3k/RemoteSubl ~/.config/sublime-text-3/Packages/RemoteSubl

• Windows

git clone https://github.com/henrikpersson/rsub %APPDATA%/Sublime Text 3/Packages/rsub
git clone https://github.com/randy3k/RemoteSubl %APPDATA%/Sublime Text 3/Packages/RemoteSubl

• OS X

git clone https://github.com/henrikpersson/rsub ~/Library/Application Support/Sublime Text 3/Packages/rsub
git clone https://github.com/randy3k/RemoteSubl ~/Library/Application Support/Sublime Text 3/Packages/RemoteSubl

然后按照本文档中 "本地客户端" 部分所述进行操作。

VS Code

要使用 rmate 与 VS Code 配合使用，您需要安装一个扩展，例如 Remote VSCode。

// 远程 VSCode 配置

// 使用的连接端口号。
"remote.port": 52698

// 启动时启动服务器。
"remote.onstartup": true

// 监听地址。
"remote.host": "127.0.0.1"

// 如果设置为 true，将不再显示端口已被使用的错误。
"remote.dontShowPortAlreadyInUseError": false

然后按照本文档中 "本地客户端" 部分所述进行操作。

3. 项目API使用文档

以下是 rmate 的使用方法：

编辑指定的文件：

$ ./rmate [arguments] [--] file-path

从 stdin 读取文本：

$ echo "hello TextMate" | ./rmate [arguments] -

参数

• -H, --host HOST：连接到指定的主机。使用 'auto' 从 SSH 检测主机。
• -p, --port PORT：使用指定的端口号。
• -w, --[no-]wait：等待 TextMate 关闭文件。
• -l, --line LINE：加载文件后，将光标放在指定的行号上。
• +N：如果 N 是一个数字（例如：+5），则为 --line 的别名。
• -m, --name NAME：在 TextMate 中显示的名称。
• -t, --type TYPE：将文件视为指定类型。
• -n, --new：在新的窗口中打开（Sublime Text）。
• -f, --force：即使文件不可写也打开。
• -v, --verbose：详细的日志消息。
• -h, --help：显示使用信息。
• --version：显示版本并退出。

4. 项目安装方式

请参考 "安装指南" 部分的说明进行安装。