Train - Transport Interface

Train lets you talk to your local or remote operating systems with a unified interface.

It allows you to:

  • execute commands via run_command
  • interact with files via file
  • identify the target operating system via os

Train supports:

  • Local execution
  • SSH
  • WinRM
  • Docker
  • Mock (for testing and debugging)




require 'train'
train = Train.create('local')


require 'train'
train = Train.create('ssh',
  host: '', port: 22, user: 'root', key_files: '/vagrant')


require 'train'
train = Train.create('winrm',
  host: '', user: 'Administrator', password: '...', ssl: true, self_signed: true)


require 'train'
train = Train.create('docker', host: 'container_id...')


To get a list of available options for a plugin:

puts Train.options('ssh')

This will provide all configuration options:

  :host     => { :required => true},
  :port     => { :default  => 22, :required => true},
  :user     => { :default  => "root", :required => true},
  :keys     => { :default  => nil},
  :password => { :default  => nil},


# start or reuse a connection
conn = train.connection

# run a command on Linux/Unix/Mac
puts conn.run_command('whoami').stdout

# get OS info
puts conn.os[:family]
puts conn.os[:release]

# access files
puts conn.file('/proc/version').content

# close the connection


We perform unit, integration and windows tests.

  • unit tests ensure the intended behaviour of the implementation
  • integration tests run against VMs and docker containers
  • windows tests that run on appveyor for windows integration tests


# run windows tests
bundle exec rake test:windows

# run single tests
bundle exec ruby -I .\test\windows\ .\test\windows\local_test.rb

Kudos and Contributors

Train is heavily based on the work of:


  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request


| Author: | Dominik Richter ([email protected])

| Author: | Christoph Hartmann ([email protected])

| Copyright: | Copyright (c) 2015 Chef Software Inc.

| Copyright: | Copyright (c) 2015 Vulcano Security GmbH.

| License: | Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.