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

Pure Ruby implementation of the SCP protocol
https://github.com/net-ssh/net-scp

Keywords from Contributors

rubygems activejob activerecord mvc ruby-gem chef excon nokogiri deployment rubocop

Last synced: about 7 hours ago
JSON representation

Repository metadata

Pure Ruby implementation of the SCP protocol

Host: GitHub
URL: https://github.com/net-ssh/net-scp
Owner: net-ssh
License: mit
Created: 2009-07-21T21:31:56.000Z (over 16 years ago)
Default Branch: master
Last Pushed: 2025-01-22T21:02:17.000Z (11 months ago)
Last Synced: 2025-11-27T12:55:58.487Z (15 days ago)
Language: Ruby
Homepage: http://github.com/delano/net-scp
Size: 1.39 MB
Stars: 155
Watchers: 7
Forks: 66
Open Issues: 18
Releases: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE.txt
- Security: SECURITY.md

Net::SCP

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-scp
Issues: https://github.com/net-ssh/net-scp/issues
Codes: https://github.com/net-ssh/net-scp
Email: net-ssh@solutious.com

As of v1.0.5, all gem releases are signed. See INSTALL.

DESCRIPTION:

Net::SCP is a pure-Ruby implementation of the SCP protocol. This operates over
SSH (and requires the Net::SSH library), and allows files and directory trees
to be copied to and from a remote server.

FEATURES/PROBLEMS:

Transfer files or entire directory trees to or from a remote host via SCP
Can preserve file attributes across transfers
Can download files in-memory, or direct-to-disk
Support for SCP URI's, and OpenURI

SYNOPSIS:

In a nutshell:

require 'net/scp'

# upload a file to a remote server
Net::SCP.upload!("remote.host.com", "username",
  "/local/path", "/remote/path",
  :ssh => { :password => "password" })

# upload recursively
Net::SCP.upload!("remote.host", "username", "/path/to/local", "/path/to/remote",
   :ssh => { :password => "foo" }, :recursive => true)

# download a file from a remote server
Net::SCP.download!("remote.host.com", "username",
  "/remote/path", "/local/path",
  :ssh => { :password => "password" })

# download a file to an in-memory buffer
data = Net::SCP::download!("remote.host.com", "username", "/remote/path")

# use a persistent connection to transfer files
Net::SCP.start("remote.host.com", "username", :password => "password") do |scp|
  # upload a file to a remote server
  scp.upload! "/local/path", "/remote/path"

  # upload from an in-memory buffer
  scp.upload! StringIO.new("some data to upload"), "/remote/path"

  # run multiple downloads in parallel
  d1 = scp.download("/remote/path", "/local/path")
  d2 = scp.download("/remote/path2", "/local/path2")
  [d1, d2].each { |d| d.wait }
end

# You can also use open-uri to grab data via scp:
require 'uri/open-scp'
data = open("scp://user@host/path/to/file.txt").read

For more information, see Net::SCP.

REQUIREMENTS:

Net::SSH 2

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

Echoe (for Rakefile use)
Mocha (for tests)

INSTALL:

gem install net-scp (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. 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-ssh/master/net-ssh-public_cert.pem
$ gem cert --add net-ssh-public_cert.pem

Then- when installing the gem - do so with high security:

$ gem install net-scp -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, you can do it the hard way (without Rubygems):

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

Security contact information

See SECURITY.md

LICENSE:

(The MIT License)

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: 3
Watch event: 4
Member event: 1
Issue comment event: 5
Push event: 13
Pull request review event: 3
Pull request review comment event: 2
Pull request event: 12
Fork event: 2
Create event: 5

Last Year

Issues event: 2
Watch event: 2
Member event: 1
Issue comment event: 5
Push event: 13
Pull request review event: 3
Pull request review comment event: 2
Pull request event: 11
Fork event: 1
Create event: 5

Committers metadata

Last synced: 7 days ago

Total Commits: 141
Total Committers: 30
Avg Commits per committer: 4.7
Development Distribution Score (DDS): 0.716

Commits in past year: 9
Committers in past year: 2
Avg Commits per committer in past year: 4.5
Development Distribution Score (DDS) in past year: 0.444

Name	Email	Commits
Jamis Buck	j**s@3**m	40
delano	d**m@g**m	31
Miklós Fazekas	m**s@s**m	21
mishina	t**8@g**m	7
NetSHH Robot	r**t@n**o	4
Kim Hedegaard Madsen	k**m@d**m	4
guns	s**g@m**m	3
Robert Cheramy	r**y@n**e	3
Tim Smith	t**h@c**o	3
Ben Dean	b**n@o**m	2
Robert Chéramy	r**t@c**t	2
Taylor B	4****e	2
Vít Ondruch	v**h@r**m	2
m-nakamura145	m**5@g**m	1
hana-da	h****a	1
Alex Vinyar	a**x@g**m	1
John Keiser	j**r@o**m	1
Miron Cuperman	c**o@n**t	1
chqr	c**r@k**m	1
Sean Dilda	s**n@d**u	1
Ryan Tokarek	r**k@f**m	1
Paul Hoffer	p**r@g**m	1
Nick Hammond	n**k@n**m	1
Michael J. Giarlo	m**o@s**u	1
Marc Huffnagle	m**c@e**m	1
Josh Wilson	j**s@s**u	1
Corey Hemminger	h**r@h**m	1
Arthur Schreiber	s**r@g**m	1
Antonio Terceiro	t**o@d**g	1
Alexey Chebotar	a**d@g**m	1

Committer domains:

Issue and Pull Request metadata

Last synced: about 1 month ago

Total issues: 35
Total pull requests: 54
Average time to close issues: over 1 year
Average time to close pull requests: 11 months
Total issue authors: 34
Total pull request authors: 40
Average comments per issue: 1.63
Average comments per pull request: 1.39
Merged pull request: 35
Bot issues: 0
Bot pull requests: 0

Past year issues: 1
Past year pull requests: 10
Past year average time to close issues: N/A
Past year average time to close pull requests: 1 day
Past year issue authors: 1
Past year pull request authors: 4
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.2
Past year merged pull request: 6
Past year bot issues: 0
Past year bot pull requests: 0

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

Top Issue Authors

4zv4l (2)
sandstrom (1)
grosser (1)
arthurzenika (1)
chqr (1)
tomassliz (1)
drieseng (1)
ThomasSevestre (1)
guhanwe (1)
ANTARESXXI (1)
railsfactory-manohar (1)
RulerOf (1)
saumy4all (1)
tas50 (1)
rajsahae (1)

Top Pull Request Authors

mfazekas (7)
tas50 (3)
kimhmadsen (2)
voxik (2)
Flameeyes (2)
tibob (2)
rtokarek-fastly (2)
robertcheramy (2)
npezza93 (1)
vinyar (1)
seandilda (1)
b-dean (1)
m-nakamura145 (1)
tayjaybabee (1)
cb-nvs (1)

Top Issue Labels

Top Pull Request Labels

Package metadata

Total packages: 3
Total downloads:
- rubygems: 417,640,560 total
Total docker downloads: 1,204,379,704
Total dependent packages: 333 (may contain duplicates)
Total dependent repositories: 63,504 (may contain duplicates)
Total versions: 54
Total maintainers: 3

gem.coop: net-scp

A pure Ruby implementation of the SCP client protocol

Homepage: https://github.com/net-ssh/net-scp
Documentation: http://www.rubydoc.info/gems/net-scp/
Licenses: MIT
Latest release: 4.1.0 (published 11 months ago)
Last Synced: 2025-12-08T15:01:36.239Z (4 days ago)
Versions: 19
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 208,799,441 Total
Docker Downloads: 602,189,852
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.066%
- Downloads: 0.115%
- Docker downloads count: 0.149%
Maintainers (3)
- delano
- mfazekas
- minam

rubygems.org: net-scp

A pure Ruby implementation of the SCP client protocol

Homepage: https://github.com/net-ssh/net-scp
Documentation: http://www.rubydoc.info/gems/net-scp/
Licenses: MIT
Latest release: 4.1.0 (published 11 months ago)
Last Synced: 2025-12-09T00:31:20.918Z (3 days ago)
Versions: 19
Dependent Packages: 333
Dependent Repositories: 63,504
Downloads: 208,841,119 Total
Docker Downloads: 602,189,852
Rankings:
- Downloads: 0.108%
- Dependent packages count: 0.132%
- Dependent repos count: 0.142%
- Docker downloads count: 0.183%
- Average: 1.423%
- Forks count: 3.423%
- Stargazers count: 4.551%
Maintainers (3)
- delano
- mfazekas
- minam

proxy.golang.org: github.com/net-ssh/net-scp

Homepage:
Documentation: https://pkg.go.dev/github.com/net-ssh/net-scp#section-documentation
Licenses: mit
Latest release: v4.1.0+incompatible (published 11 months ago)
Last Synced: 2025-12-07T18:02:50.917Z (4 days ago)
Versions: 16
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Forks count: 3.258%
- Stargazers count: 4.038%
- Average: 6.918%
- Dependent packages count: 9.576%
- Dependent repos count: 10.802%

Dependencies

Gemfile rubygems

codecov >= 0 development
simplecov >= 0 development
bundler ~> 1.11
rake ~> 12.0

net-scp.gemspec rubygems

mocha >= 0 development
test-unit >= 0 development
mocha >= 0
net-ssh >= 2.6.5, < 8.0.0
test-unit >= 0

Score: 29.761467184195276

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Ruby