keen-cli 0.1.6 → 0.1.7

data/README.md

@@ -21,6 +21,7 @@ Commands:
   keen average               # Alias for queries:run -a average
   keen count                 # Alias for queries:run -a count
   keen count-unique          # Alias for queries:run -a count_unique
+  keen docs                  # Open the full Keen IO documentation in a browser
   keen events:add            # Add one or more events and print the result
   keen extraction            # Alias for queries:run -a extraction
   keen help [COMMAND]        # Describe available commands or one specific command
@@ -82,7 +83,8 @@ $ keen projects:describe -p XXXXXXXXXXXXXXX -k AAAAAAAAAAAAAA
 
 keen-cli has a variety of commands, and most are namespaced for clarity.
 
-* `version` - Print version information
+* `version` - Print version information.
+* `docs` - Open the full [Keen IO docs](https://keen.io/docs) in a browser window. Pass `--reference` to go straight to the [API Technical Reference](https://keen.io/docs/api/reference/).
 
 ##### Projects
 
@@ -259,6 +261,7 @@ Parameters that apply to most commands include:
 
 ### Changelog
 
++ 0.1.7 - Add docs command
 + 0.1.6 - Big refactoring to make importing events much cleaner and batching happen automatically. Also adds `queries:url`.
 + 0.1.5 – Support adding events from files with `--file`. Optionally add from CSV with `--csv`.
 + 0.1.4 – Support absolute timeframes via `--start` and `--end` flags

data/lib/keen-cli/cli.rb

@@ -26,6 +26,20 @@ module KeenCli
       end
     end
 
+    desc 'docs', 'Open the full Keen IO documentation in a browser'
+    map %w(--docs) => :docs
+
+    shared_options
+    option :reference
+
+    def docs
+      docs_url = options[:reference] ? 'https://keen.io/docs/api/reference/' :
+                                       'https://keen.io/docs'
+      docs_url.tap do |url|
+        `open #{url}`
+      end
+    end
+
   end
 
 end

data/lib/keen-cli/version.rb

@@ -1,3 +1,3 @@
 module KeenCli
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-09 00:00:00.000000000 Z
+date: 2014-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen