awssh 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf4f811b2deee46c61931cb776834d68384ae7d6
-  data.tar.gz: 79bc526ecf91a64b45a690b1914902be7f84547d
+  metadata.gz: 9bf2bc6af45327f88c6e032246ac5e1beb9f1979
+  data.tar.gz: a1805533506765999724bf828d04ad64161e3d13
 SHA512:
-  metadata.gz: d4601030e632b861310b8a8874b866f4a395cd17e16f86fbd7c7299472389f9144ac0deaafac09c3d4ac0eee1320b2029d3a070935a9986ff3cb62e4565b6d83
-  data.tar.gz: c3a5e9d1abfc33514afcdf9a940fe16ecb4dffd4fa33e049dcf2dd6ba4f1e711bf0293afacb43f050cc2c46cd9fc144cc48608bedf7419284d66e0b266e55a9e
+  metadata.gz: 879626d24b5607ece2ece803ff912342fe094716d492fdde96f89fb7c94768e4f2ee4188ea0943f69ab2f373f353f125dfb14fef10f59fb369c76b743228001e
+  data.tar.gz: 39a7216cbe5473ba181f9056a281fc362a4b8fd3ab3914d4be466e4f3d4c8c8d85efc47a65f8f8561b6e64a0161fd8a9c30f947f908a10c820b0f8433ac65e28

data/README.md

@@ -13,7 +13,7 @@ Generally, you will install this directly:
 
     $ gem install awssh
 
-Add this line to your application's Gemfile:
+or, add this line to your application's Gemfile:
 
     gem 'awssh'
 
@@ -21,6 +21,18 @@ And then execute:
 
     $ bundle
 
+## Requirement
+
+The only requirement of the tool is that the Name tag on the instance maps to the DNS record.
+Generally, `awssh` expects that if the name of the instance is `foo.bar`, then it can
+connect to the server by appending the domain name as `foo.bar.example.com`.
+
+If you unset the domain name in the config, it will not append it. As such, if your Name
+tag maps directly to the DNS name, it will work as well.
+
+In the future, I might add a templated way for handling hostnames, to allow for
+more customization in DNS lookup.
+
 ## Usage
 
 ```
@@ -49,6 +61,33 @@ Options:
     -u, --user                       override user setting
 
 ```
+## Examples
+Given a list of servers:
+```
+web1.staging
+app1.staging
+web1.production
+web2.production
+app1.production
+app2.production
+app3.production
+```
+
+Connect to web1.staging
+```
+awssh web1 staging #=> web1.staging
+```
+
+Connect to all staging servers
+```
+awssh -m staging #=> web1.staging, app1.staging
+```
+
+Connect to all production servers, except app3.
+The hat `^` negates a match.
+```
+awssh -m production ^app3 #=> web1.production, web2.production, app1.production, app2.production
+```
 
 ## Config
 ```
@@ -64,9 +103,20 @@ cache: "~/.awssh.cache"        # cache file location
 expires: 86400                 # cache expiration time (in seconds)
 ```
 
+## Multi SSH
+
+`csshX` is available on Mac OSX through brew.
+
+`cssh` is available on linux, through apt or yum.
+
+If there are other programs like this, please let me know.
+
+Eventually, I'd like to support the programs with templated commands, to allow
+for more advanced usage.
+
 ## Caching
 
-Maintains a simple cache with expiration (default: 1 day)
+Maintains a simple cache with expiration (default: 1 day).
 The cache just contains the list of servers' names.
 You can disable the cache by setting the cache value to false in the config file.
 
@@ -74,13 +124,13 @@ You can disable the cache by setting the cache value to false in the config file
 
 To get around using multiple RVM's and still have access to awssh command
 
-alias awssh='rvm <rvm version> do awssh'
+`alias awssh='rvm <rvm version> do awssh'`
 
 When you install awssh into your default ruby, then change to a project ruby,
 the awssh gem is no longer available. This allows you to use the awssh gem
 from ruby. Just specify the default rvm version in <rvm verison> above.
 
-alias awssh='rvm 2.1.2 do awssh'
+`alias awssh='rvm 2.1.2 do awssh'`
 
 ## Contributing
 

data/lib/awssh/version.rb

@@ -2,7 +2,7 @@ module Awssh
   module Version
     MAJOR = 0
     MINOR = 1
-    TINY  = 7
+    TINY  = 8
     TAG   = nil
     LIST  = [MAJOR, MINOR, TINY, TAG].compact
     STRING = LIST.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: awssh
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Shawn Catanzarite