<commit_before># kitchen-ssh

ssh driver for test-kitchen for any running server with an ip address

server must be created and destroyed natively (e.g. via cloud or virtualization console).
specify driver parameters
*  hostname
*  port
*  username
*  password
*  sudo
*  ssh_key
*  forward_agent

There is also a second driver called ssh_gzip that will also gzip file before transfer which can provide 
a big performance improvement when alot of files are transfered.


## Installation

Add this line to your application's Gemfile:

    gem 'kitchen-ssh', group: :integration

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install kitchen-ssh

## Usage

In your .kitchen.yml file set driver to be 'ssh' or 'ssh_gzip'.
<commit_msg>add example to README<commit_after># kitchen-ssh

ssh driver for test-kitchen for any running server with an ip address

server must be created and destroyed natively (e.g. via cloud or virtualization console).
specify driver parameters
*  hostname
*  port
*  username
*  password
*  sudo
*  ssh_key
*  forward_agent

There is also a second driver called ssh_gzip that will also gzip file before transfer which can provide 
a big performance improvement when alot of files are transfered.


## Installation

Add this line to your application's Gemfile:

    gem 'kitchen-ssh', group: :integration

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install kitchen-ssh

## Usage

In your .kitchen.yml file set driver to be 'ssh' or 'ssh_gzip'.

##Example

```yaml
---
driver:
  name: ssh
  hostname: your-ip
  port: 22
  username: username 
  ssh_key: /path/to/id_rsa
```
{'fraction_non_alphanumeric': 0.0649666059502125, 'fraction_numerical': 0.0012143290831815423, 'mean_word_length': 3.7085714285714286, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3645920', 'n_tokens_mistral': 524, 'n_tokens_neox': 480, 'n_words': 218}