Add lib/help.js

Author: gkoberger

lib/docs.js

@@ -2,6 +2,7 @@ var request = require('request');
 
 exports.swagger = true;
 exports.login = true;
+exports.desc = "Upload your docs to ReadMe.io";
 
 exports.run = function(config, info) {
   console.log('Uploading Swagger file...');

lib/generate.js

@@ -1,5 +1,6 @@
 exports.swagger = true;
 exports.login = false;
+exports.desc = "Output your Swagger file";
 
 exports.run = function(config, info) {
   console.log(JSON.stringify(info.swagger, undefined, 2));

lib/help.js

@@ -0,0 +1,29 @@
+var glob = require('glob');
+var path = require('path');
+var _ = require('lodash');
+
+exports.swagger = false;
+exports.login = false;
+exports.desc = "Learn what you can do with api";
+
+exports.run = function(config, info) {
+  console.log("");
+  console.log("Here's a list of what you can do with " + 'api'.yellow + ":");
+  console.log("");
+  var files = glob.sync(path.join(__dirname, "*"));
+
+  _.each(files, function(file) {
+    var action = file.match(/(\w+).js/)[1];
+    var info = require(file).desc || "";
+    console.log("  $".grey + pad(" api " + action) + " " + info.grey);
+  });
+  
+  console.log("");
+  console.log("Just getting started?".green);
+  console.log("Run " + "api init".yellow + " to create your Swagger file.");
+  console.log("");
+
+  function pad(text) {
+    return (text + "                     ").substr(0,15)
+  }
+};

lib/host.js

@@ -2,6 +2,7 @@ var request = require('request');
 
 exports.swagger = true;
 exports.login = true;
+exports.desc = "Get a public URL for your API";
 
 exports.run = function(config, info) {
   console.log('Uploading Swagger file...');

lib/init.js

@@ -7,6 +7,7 @@ var utils = require('../utils');
 
 exports.swagger = false;
 exports.login = false;
+exports.desc = "Create a new API specification";
 
 var types = [
   { "name": "application/json", "checked": true },

lib/login.js

@@ -1,6 +1,10 @@
 var jsonfile = require('jsonfile')
 var open = require('open');
 
+exports.swagger = false;
+exports.login = false;
+exports.desc = "Authenticate this computer";
+
 exports.run = function(config, info) {
   if(info.args[1] == 'info') {
     try {

lib/mock.js

@@ -3,6 +3,7 @@ var request = require('request');
 
 exports.swagger = true;
 exports.login = true;
+exports.desc = "Run a mock server based on your API";
 
 exports.run = function(config, info) {
   console.log('Uploading Swagger file...');

lib/test.js

@@ -1,5 +1,6 @@
 exports.swagger = true;
 exports.login = true;
+exports.desc = "Internal use, will be deleted soon :)";
 
 exports.run = function(config, info) {
   console.log('SWAGGER', info.swagger);