Permalink
Browse files

make this place livable!

  • Loading branch information...
jamis committed Feb 2, 2009
1 parent a4a945c commit def7a172f8d527aecde8842bd6c00d77f2a9ed78
Showing with 105 additions and 0 deletions.
  1. +3 −0 CHANGELOG.rdoc
  2. +8 −0 Manifest
  3. +66 −0 README.rdoc
  4. +28 −0 Rakefile
View
@@ -0,0 +1,3 @@
+=== (unreleased)
+
+* Initial release
View
@@ -0,0 +1,8 @@
+CHANGELOG.rdoc
+lib/net/ssh/shell/process.rb
+lib/net/ssh/shell/subshell.rb
+lib/net/ssh/shell/version.rb
+lib/net/ssh/shell.rb
+Rakefile
+README.rdoc
+Manifest
View
@@ -0,0 +1,66 @@
+= Net::SSH::Shell
+
+== DESCRIPTION:
+
+Net::SSH::Shell is a library for interacting with stateful (e.g., interactive) shells on remote hosts. It hides (or tries to hide) the potentially complex Net::SSH state machines you'd otherwise need to write to interact with "su" and similar shells.
+
+One of the significant benefits you get from this library versus using Net::SSH directly is that your shell is _stateful_. With Net::SSH, if you invoke "cd /" in one exec call, and "pwd" in another, the two are done in different shells so the directory change in the first has no effect on the working directory of the second. With Net::SSH::Shell, though, commands are all invoked via the _same_ shell, so changes in directory or additions to the environment all affect subsequent commands.
+
+== FEATURES:
+
+* Interact with login shells
+* Support for "subshell" environments, like "su" or "sudo bash"
+
+== SYNOPSIS:
+
+In a nutshell:
+
+ require 'net/ssh/shell'
+
+ Net::SSH::Start('host', 'user') do |ssh|
+ ssh.shell do |sh|
+ sh.execute "cd /usr/local"
+ sh.execute "pwd"
+ sh.execute "export FOO=bar"
+ sh.execute "echo $FOO"
+ end
+ end
+
+See Net::SSH::Shell for more documentation.
+
+== REQUIREMENTS:
+
+* net-ssh (version 2)
+
+If you want to use any of the Rake tasks, you'll need:
+
+* Echoe (for the Rakefile)
+
+== INSTALL:
+
+* gem install net-ssh-shell (might need sudo privileges)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jamis Buck <jamis@37signals.com>
+
+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.
View
@@ -0,0 +1,28 @@
+require './lib/net/ssh/shell/version'
+
+begin
+ require 'echoe'
+rescue LoadError
+ abort "You'll need to have `echoe' installed to use Net::SSH::Shell's Rakefile"
+end
+
+version = Net::SSH::Shell::Version::STRING.dup
+if ENV['SNAPSHOT'].to_i == 1
+ version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+end
+
+Echoe.new('net-ssh-shell', version) do |p|
+ p.changelog = "CHANGELOG.rdoc"
+
+ p.author = "Jamis Buck"
+ p.email = "jamis@jamisbuck.org"
+ p.summary = "A simple library to aid with stateful shell interactions"
+ p.url = "http://net-ssh.rubyforge.org/shell"
+
+ p.dependencies = ["net-ssh >=2.0.9"]
+
+ p.need_zip = true
+ p.include_rakefile = true
+
+ p.rdoc_pattern = /^(lib|README.rdoc|CHANGELOG.rdoc)/
+end

0 comments on commit def7a17

Please sign in to comment.