Module: SSHKit

### Home Classes Methods

### In Files

- lib/sshkit.rb
- lib/sshkit/backends/abstract.rb
- lib/sshkit/backends/connection_pool.rb
- lib/sshkit/backends/local.rb
- lib/sshkit/backends/netssh.rb
- lib/sshkit/backends/printer.rb
- lib/sshkit/backends/skipper.rb
- lib/sshkit/command_map.rb
- lib/sshkit/configuration.rb
- lib/sshkit/coordinator.rb
- lib/sshkit/dsl.rb
- lib/sshkit/exception.rb
- lib/sshkit/formatters/abstract.rb
- lib/sshkit/formatters/black_hole.rb
- lib/sshkit/formatters/dot.rb
- lib/sshkit/formatters/pretty.rb
- lib/sshkit/formatters/simple_text.rb
- lib/sshkit/host.rb
- lib/sshkit/log_message.rb
- lib/sshkit/logger.rb
- lib/sshkit/runners/abstract.rb
- lib/sshkit/runners/group.rb
- lib/sshkit/runners/null.rb
- lib/sshkit/runners/parallel.rb
- lib/sshkit/runners/sequential.rb
- lib/sshkit/utils/capture_output_methods.rb
- lib/sshkit/version.rb

### Namespace

- MODULE SSHKit::Backend
- MODULE SSHKit::DSL
- MODULE SSHKit::Formatter
- MODULE SSHKit::Runner
- MODULE SSHKit::Utils
- CLASS SSHKit::CommandMap
- CLASS SSHKit::Configuration
- CLASS SSHKit::Coordinator
- CLASS SSHKit::Host
- CLASS SSHKit::HostWithPortParser
- CLASS SSHKit::HostWithUsernameAndPortParser
- CLASS SSHKit::HostWithUsernameParser
- CLASS SSHKit::IPv6HostWithPortParser
- CLASS SSHKit::LogMessage
- CLASS SSHKit::Logger
- CLASS SSHKit::SimpleHostParser

### Methods

- ::capture_output
- ::configure
- ::reset_configuration!

### Class/Module Index

Quicksearch

- SSHKit
- SSHKit::Backend
- SSHKit::Backend::Abstract
- SSHKit::Backend::ConnectionPool
- SSHKit::Backend::Local
- SSHKit::Backend::Netssh
- SSHKit::Backend::Netssh::Configuration
- SSHKit::Backend::Printer
- SSHKit::Backend::Skipper
- SSHKit::CommandMap
- SSHKit::CommandMap::CommandHash
- SSHKit::CommandMap::PrefixProvider
- SSHKit::Configuration
- SSHKit::Coordinator
- SSHKit::DSL
- SSHKit::Formatter
- SSHKit::Formatter::Abstract
- SSHKit::Formatter::BlackHole
- SSHKit::Formatter::Dot
- SSHKit::Formatter::Pretty
- SSHKit::Formatter::SimpleText
- SSHKit::Host
- SSHKit::HostWithPortParser
- SSHKit::HostWithUsernameAndPortParser
- SSHKit::HostWithUsernameParser
- SSHKit::IPv6HostWithPortParser
- SSHKit::LogMessage
- SSHKit::Logger
- SSHKit::Logger::SSHKit
- SSHKit::Logger::SSHKit::Logger
- SSHKit::Logger::SSHKit::Logger::Net
- SSHKit::Logger::SSHKit::Logger::Net::SSH
- SSHKit::Logger::SSHKit::Logger::Net::SSH::LogLevelShim
- SSHKit::Runner
- SSHKit::Runner::Abstract
- SSHKit::Runner::ExecuteError
- SSHKit::Runner::Group
- SSHKit::Runner::Null
- SSHKit::Runner::Parallel
- SSHKit::Runner::Sequential
- SSHKit::SimpleHostParser
- SSHKit::Utils
- SSHKit::Utils::CaptureOutputMethods
- Net
- Net::SSH
- Net::SSH::Config
- Array
- Color
- Hash
- Object

No matching classes.

# SSHKit

### Constants

StandardError
UnparsableHostStringError
VERSION

### Attributes

config[RW]

### Public Class Methods

capture_output(io, &block) click to toggle source

    # File lib/sshkit.rb, line 9
    def capture_output(io, &block)
      original_io = config.output
      config.output = io
      config.output.extend(SSHKit::Utils::CaptureOutputMethods)
      yield
    ensure
      config.output = original_io
    end

configure() click to toggle source

    # File lib/sshkit.rb, line 18
    def configure
      @@config ||= Configuration.new
      yield config
    end

reset_configuration!() click to toggle source

    # File lib/sshkit.rb, line 27
    def reset_configuration!
      @@config = nil
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.