https://github.com/eagletmt/libssh-ruby

Ruby binding for libssh
https://github.com/eagletmt/libssh-ruby

Last synced: about 2 months ago
JSON representation

Ruby binding for libssh

• Host: GitHub
• URL: https://github.com/eagletmt/libssh-ruby
• Owner: eagletmt
• License: mit
• Created: 2016-01-17T12:13:15.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-05-23T03:13:55.000Z (over 1 year ago)
• Last Synced: 2024-11-01T01:41:47.765Z (about 2 months ago)
• Language: C
• Homepage:
• Size: 95.7 KB
• Stars: 14
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# LibSSH

[![Gem Version](https://badge.fury.io/rb/libssh.svg)](https://badge.fury.io/rb/libssh)

[![Build Status](https://travis-ci.org/eagletmt/libssh-ruby.svg?branch=master)](https://travis-ci.org/eagletmt/libssh-ruby)

Ruby binding for [libssh](https://www.libssh.org/) .

## Stability

Under development

## Requirement

- libssh >= 0.6.0

    - ed25519 keys support is available from [libssh 0.7.0](https://www.libssh.org/2015/05/11/libssh-0-7-0/).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'libssh'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install libssh

## Usage

See [example](example) directory.

### With SSHKit

See [example/sshkit.rb](example/sshkit.rb) .

### With Capistrano

sshkit must be v1.9.0 or later due to [SSHKit::Backend::ConnectionPool API change](https://github.com/capistrano/sshkit/releases/tag/v1.9.0.rc1).

```ruby

require 'sshkit/backends/libssh'

set :sshkit_backend, SSHKit::Backend::Libssh

```

## Documentation

http://www.rubydoc.info/github/eagletmt/libssh-ruby

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/eagletmt/libssh-ruby.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).