https://github.com/net-ssh/net-sftp

Pure Ruby implementation of an SFTP (protocols 1-6) client.
https://github.com/net-ssh/net-sftp

Keywords from Contributors

activerecord mvc activejob ruby-gem crash-reporting rspec rubygems sinatra error-monitoring xslt

Last synced: about 15 hours ago
JSON representation

Repository metadata

Pure Ruby implementation of an SFTP (protocols 1-6) client.

• Host: GitHub
• URL: https://github.com/net-ssh/net-sftp
• Owner: net-ssh
• License: mit
• Created: 2009-11-17T22:56:41.000Z (about 16 years ago)
• Default Branch: master
• Last Pushed: 2024-08-14T13:56:31.000Z (over 1 year ago)
• Last Synced: 2025-11-12T18:43:52.551Z (2 months ago)
• Language: Ruby
• Homepage: http://net-ssh.github.io/
• Size: 696 KB
• Stars: 290
• Watchers: 7
• Forks: 130
• Open Issues: 72
• Releases: 0
• Metadata Files:
  • Readme: README.rdoc
  • Changelog: CHANGES.txt
  • License: LICENSE.txt

README.rdoc

          = 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: net-ssh@solutious.com

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.

        

---

Owner metadata

• Name: net-ssh
• Login: net-ssh
• Email:
• Kind: organization
• Description:
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/75385?v=4
• Repositories: 8
• Last ynced at: 2024-03-25T19:51:32.738Z
• Profile URL: https://github.com/net-ssh

---

GitHub Events

Total

• Issues event: 2
• Watch event: 6
• Issue comment event: 5
• Pull request event: 1
• Fork event: 4

Last Year

• Issues event: 2
• Watch event: 3
• Issue comment event: 4
• Pull request event: 1
• Fork event: 3

---

Committers metadata

Last synced: 4 days ago

Name	Email	Commits
Jamis Buck	j****s@3****m	133
delano	d****m@g****m	20
Miklos Fazekas	m****s@s****m	16
jstuckey	j****y@g****m	7
Thibaut Barrère	t****e@g****m	5
Vít Ondruch	v****h@r****m	4
Kenichi Kamiya	k****1@g****m	3
misdoro	m****a@d****g	3
Pablo Merino	p****o@M****l	2
Gaurav Gupta	gg@e****m	2
Josh McGinnis	j****a@m****o	2
Martin Carpenter	m****r@f****r	2
Yuji Hanamura	y****r@g****m	2
thedarkone	t****2@g****m	1
David Czarnecki	d****i@a****m	1
Klaus Badelt	k****b@k****m	1
Scott Tadman	g****t@t****a	1
Scott Tadman	t****n@g****l	1
Sven Schwyn	s****n@b****m	1
Tyler Hunt	t****r@t****m	1
Stuart Hinson	s****n@g****m	1
Steven Peckins	s****s@i****u	1
SpringsTea	s****0@g****m	1
Sergey Toy	t****r	1
Nicolas Leger	n****r	1
Matjaz Kavcic	m****z@k****u	1
Klaus Badelt	k****s@f****m	1
John Barnette	j****e@g****m	1
James Lam	j****s@2****a	1
Dharam Gollapudi	d****i@g****m	1
and 5 more...

Committer domains:

• swipely.com: 1
• 2020seedlabs.ca: 1
• filmhub.com: 1
• kavcic.eu: 1
• illinois.edu: 1
• tylerhunt.com: 1
• bitcetera.com: 1
• tadman.ca: 1
• kinonation.com: 1
• agoragames.com: 1
• free.fr: 1
• mcginnis.io: 1
• eligible.com: 1
• doronin.org: 1
• redhat.com: 1
• szemafor.com: 1
• 37signals.com: 1

---

Issue and Pull Request metadata

Last synced: about 1 month ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/net-ssh/net-sftp

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • rubygems: 302,541,337 total
• Total docker downloads: 794,595,796
• Total dependent packages: 227 (may contain duplicates)
• Total dependent repositories: 19,312 (may contain duplicates)
• Total versions: 57
• Total maintainers: 3

---

Dependencies

Score: 30.26298060398324