百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
N

net-sftp

> 编程语言
开源

纯 Ruby 实现的 SFTP (协议 1-6) 客户端。

304 stars0 点赞3 次浏览
访问官网GitHub

工具介绍

纯 Ruby 实现的 SFTP (协议 1-6) 客户端。

= Net::SFTP

Please note: this project is in maintenance mode. It is not under active development but pull requests are very much welcome. Just be sure to include tests! -- delano

  • Docs: http://net-ssh.github.io/net-sftp
  • Issues: https://github.com/net-ssh/net-sftp/issues
  • Codes: https://github.com/net-ssh/net-sftp
  • Email: [email protected]

As of v2.1.0, all gem releases are signed. See INSTALL.

== DESCRIPTION:

Net::SFTP is a pure-Ruby implementation of the SFTP protocol (specifically, versions 1 through 6 of the SFTP protocol). Note that this is the "Secure File Transfer Protocol", typically run over an SSH connection, and has nothing to do with the FTP protocol.

== FEATURES/PROBLEMS:

  • Transfer files or even entire directory trees to or from a remote host via SFTP
  • Completely supports all six protocol versions
  • Asynchronous and synchronous operation
  • Read and write files using an IO-like interface

== SYNOPSIS:

In a nutshell:

require 'net/sftp'

Net::SFTP.start('host', 'username', :password => 'password') do |sftp| # upload a file or directory to the remote host sftp.upload!("/path/to/local", "/path/to/remote")

# download a file or directory from the remote host
sftp.download!("/path/to/remote", "/path/to/local")

# grab data off the remote host directly to a buffer
data = sftp.download!("/path/to/remote")

# open and write to a pseudo-IO for a remote file
sftp.file.open("/path/to/remote", "w") do |f|
  f.puts "Hello, world!\n"
end

# open and read from a pseudo-IO for a remote file
sftp.file.open("/path/to/remote", "r") do |f|
  puts f.gets
end

# create a directory
sftp.mkdir! "/path/to/directory"

# list the entries in a directory
sftp.dir.foreach("/path/to/directory") do |entry|
  puts entry.longname
end

end

For the full documentation, start with Net::SFTP::Session. Also see Net::SFTP::Operations::Upload, Net::SFTP::Operations::Download, Net::SFTP::Operations::FileFactory, Net::SFTP::Operations::File, and Net::SFTP::Operations::Dir.

== REQUIREMENTS:

  • Net::SSH 2

If you wish to run the tests, you'll need:

  • Echoe (if you want to use the Rakefile)
  • Mocha

== INSTALL:

  • gem install net-sftp (might need sudo privileges)

However, in order to be sure the code you're installing hasn't been tampered with, it's recommended that you verify the signature[http://docs.rubygems.org/read/chapter/21]. To do this, you need to add my public key as a trusted certificate (you only need to do this once):

# Add the public key as a trusted certificate
# (You only need to do this once)
$ curl -O https://raw.githubusercontent.com/net-ssh/net-sftp/master/net-sftp-public_cert.pem
$ gem cert --add net-sftp-public_cert.pem

Then, when install the gem, do so with high security:

$ gem install net-sftp -P HighSecurity

If you don't add the public key, you'll see an error like "Couldn't verify data signature". If you're still having trouble let me know and I'll give you a hand.

Or, if you prefer to do it the hard way (sans Rubygems):

  • tar xzf net-ssh-*.tgz
  • cd net-ssh-*
  • ruby setup.rb config
  • ruby setup.rb install (might need sudo privileges)

== LICENSE:

(The MIT License)

Copyright (c) 2008 Jamis Buck

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Issues· 91 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Ruby

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言