Rye 项目技术文档

1. 安装指南

Rye 可以通过 Ruby Gems 进行安装。在终端运行以下命令：

gem install rye

为了确保安装的代码没有被篡改，建议验证签名。首先，添加我的公钥作为可信证书（只需执行一次）：

curl -O https://raw.github.com/delano/rye/master/gem-public_cert.pem
gem cert --add gem-public_cert.pem

然后，使用高安全级别安装 gem：

gem install rye -P HighSecurity

如果不添加公钥，将会看到错误信息 "Couldn't verify data signature"。如果遇到任何问题，请联系我以获得帮助。

2. 项目的使用说明

Rye 是一个 Ruby 抽象层，用于通过 SSH 执行 shell 命令。默认情况下，Rye 运行在“安全模式”下，只允许执行默认的白名单命令，并积极转义所有命令参数。

示例 1：在远程机器上执行命令

创建一个 Rye::Box 对象，然后调用方法来执行命令。

rbox = Rye::Box.new('hostname')
rbox.pwd                               # 返回 "/home/rye"
rbox.uname :a                          # 返回 "Darwin rye-stage 9.7.0 ..."

示例 2：路径和环境变量

可以改变目录和设置环境变量。

rbox.cd '/tmp'
rbox.pwd                               # 返回 '/tmp'
rbox.setenv('TIPPLE', "Forty Creek")
rbox.getenv 'TIPPLE'                   # 返回 "Forty Creek"

示例 3：添加和移除命令

可以添加和移除白名单中的命令。

Rye::Cmd.add_command :anything, '/usr/bin/uptime'
rbox = Rye::Box.new
rbox.anything
Rye::Cmd.remove_command :anything
rbox.anything                          # 抛出 Rye::CommandNotFound 异常

示例 4：禁用安全模式

可以通过以下任一方式禁用安全模式。

rbox = Rye::Box.new 'HOST', :safe => false
  OR
rbox.disable_safe_mode

禁用安全模式后，可以运行任何命令，并使用任何有效参数。

示例 5：访问多台机器

使用 Rye::Set 对象可以在多台机器上执行命令。

rbox = Rye::Box.new 'HOST1'
rset = Rye::Set.new
rset.add_boxes rbox, 'HOST2'
rset.hostname                          # 返回 [["HOST1"], ["HOST2"]]

示例 6：文件传输

rbox = Rye::Box.new "localhost"
rbox.file_upload "README.rdoc", "/tmp"
applejack = StringIO.new "Some in-memory content"
rbox.file_upload applejack, "/tmp/applejack.txt"
rbox.cat "/tmp/applejack.txt"   # 返回 "Some in-memory content"

示例 7：本地进程

对于本地进程，可以直接使用 Rye.shell 而不通过 Rye::Box。

Rye.shell :uptime    # 返回 "11:02  up 16:01, 3 users"

示例 8：跳过防火墙

当需要通过防火墙访问其他主机时：

rhop = Rye::Hop.new('firewall.lan')
rbox = Rye::Box.new('filibuster', :via => rhop)
rbox.uptime     # 返回 "20:53  up 1 day,  1:52, 4 users"

示例 9：禁用密码提示

如果希望在认证失败时抛出异常而不是出现密码提示，可以设置 :password_prompt 选项为 false。

rbox = Rye::Box.new("foo.com", :user => "dan", :password => "inkorrect", :password_prompt => false)
rbox.uptime # 抛出 Net::SSH::AuthenticationFailed 异常

3. 项目API使用文档

Rye 提供了丰富的 API 用于执行远程命令、文件传输等。以下是一些常用 API 的简要说明：

• Rye::Box.new(host[, options]): 创建一个新的 Box 对象。
• box.method_name: 在远程机器上执行命令。
• box.file_upload(source, destination): 将文件从本地上传到远程。
• box.file_download(source, destination): 将文件从远程下载到本地。

更多 API 详细信息，请参考项目官方文档。

4. 项目安装方式

除了通过 Ruby Gems 安装外，还可以通过以下方式安装 Rye：

• 下载最新版本的 tar.gz 文件：rye-latest.tar.gz
• 下载最新版本的 zip 文件：rye-latest.zip

解压下载的文件，然后按照 Gem 安装方式执行安装。