optica-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2707b665c02b7e9fab50ed54997fcd7f6deaba82
-  data.tar.gz: 6a1e0236dd17a745341c62fb12723a325ad89a78
+  metadata.gz: e231b226e1fd51fcf8a57d0e03c644e006a352a8
+  data.tar.gz: 36c245aaffdd8dfbe13bffdf24a8c9d717f24b56
 SHA512:
-  metadata.gz: f1011f391dd4695e3ebd5bc5833697d34e785d93b3510ff13fcd35c936731a4c9800b9a76cd4a2d7512620f2fbd8c2d9cedfe56a7bec06353b1fab1c69d5d759
-  data.tar.gz: 5be5f02624481514824262fd12fbde9d21287623996ee43d1f94d8526a60d0f3bb0f43653e516ed5e44bd90469203f367124f3f7e8314f73a0bb5f716d855522
+  metadata.gz: 7395337003e0e80229826b0a9aef7a036faca0df9dbb773c6006e655ef574f2493e4508b3ac702ef98377b0a5e359a1ed9de848e189592c34b38d3167d2b06d1
+  data.tar.gz: f6cd27ba9404d9d858d118196c9b42978aec4328265b36e76b58cdd5023ea0e552e7fe91e873dad08b12f0b8b3afedcb5551f7b499a59d7debc04da54885d365

data/README.md

@@ -20,8 +20,8 @@ You'll want to configure the command-line client to use your Optica instance:
 ```text
 Usage: optical [options] [FIELD=FILTER] [FIELD2=FILTER2...]
 
-  Fetch host information from Optica, and cache it for 15 minutes. Output the
-  fetched information as single-line JSON hashes, suitable for furhter processing with `jq`.
+  Fetch host information from Optica, and cache it for 15 minutes.
+  Output the fetched information as a JSON stream, suitable for processing with `jq`.
 
   FIELD: any optica field; see your optica host for availible fields
   FILTER: either a bare string, like "optica", or a regex string, like "/^(o|O)ptica?/"
@@ -30,10 +30,23 @@ Options:
     -s, --select a,b,c               Retrieve the given fields, in addition to the defaults
     -a, --all                        Retrieve all fields (default is just role,id,hostname)
     -v, --verbose                    Print debug information to STDERR
-    -p, --pretty[=true]              Pretty-print JSON (default true when STDOUT is a TTY)
+    -p, --pretty[=false]             Pretty-print JSON (default true when STDOUT is a TTY)
     -r, --refresh                    Delete cache before performing request.
     -h, --host URI                   Optica host (default "https://optica.d.musta.ch")
     -H, --set-default-host URI       Set the default optica host
+
+Examples:
+  Retrieve all nodes with a role starting with "example-":
+    optical role=/^example-/
+
+  Retrieve all the nodes registered to a test optica instance:
+    optical -h https://optica-test.example.com
+
+  Retrieve all data about my nodes:
+    optical --all launched_by=`whoami`
+
+  SSH into the first matched node:
+    ssh $(optical role=example branch=jake-test | head -n 1 | jq -r .hostname)
 ```
 
 ## Development

data/lib/optica/client/cli.rb

@@ -53,8 +53,8 @@ module Optica
 
           o.separator ''
           o.separator <<-EOS
-  Fetch host information from Optica, and cache it for 15 minutes. Output the
-  fetched information as single-line JSON hashes, suitable for furhter processing with `jq`.
+  Fetch host information from Optica, and cache it for 15 minutes.
+  Output the fetched information as a JSON stream, suitable for processing with `jq`.
 
   FIELD: any optica field; see your optica host for availible fields
   FILTER: either a bare string, like "optica", or a regex string, like "/^(o|O)ptica?/"
@@ -120,6 +120,21 @@ module Optica
             log "set default host to #{h}"
           end
 
+          o.separator ''
+          o.separator 'Examples:'
+          o.separator <<-EOS
+  Retrieve all nodes with a role starting with "example-":
+    optical role=/^example-/
+
+  Retrieve all the nodes registered to a test optica instance:
+    optical -h https://optica-test.example.com
+
+  Retrieve all data about my nodes:
+    optical --all launched_by=`whoami`
+
+  SSH into the first matched node:
+    ssh $(optical role=example branch=jake-test | head -n 1 | jq -r .hostname)
+          EOS
         end
       end
 

data/lib/optica/client/version.rb

@@ -1,5 +1,5 @@
 module Optica
   module Client
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optica-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jake Teton-Landis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filecache