Cli: cleaned-up the Help

Author: steveshortt

Synapse.NodeService.cli/Program.cs

@@ -147,17 +147,19 @@ protected override void WriteHelpAndExit(string errorMessage = null)
             Console.WriteLine( "Syntax:" );
             Console_WriteLine( "  synapse.node.cli.exe service {0}command{1} | {0}httpAction parm:value{1} |", ConsoleColor.Cyan, "{", "}" );
             Console.WriteLine( "       interactive|i [url:http://{1}host:port{2}/synapse/node]\r\n", "", "{", "}" );
-            Console_WriteLine( "  interactive{0,-2}Run this CLI in interactive mode. Optionally specify URL.", ConsoleColor.Green, "" );
+            Console_WriteLine( "  About URLs:{0,-2}URL is an optional parameter on all commands except 'service'", ConsoleColor.Green, "" );
+            Console.WriteLine( "{0,-15}commands. Specify as [url:http://{1}host:port{2}/synapse/node].", "", "{", "}" );
+            Console.WriteLine( "{0,-15}URL default is localhost:{1}port{2} (See WebApiPort in config.yaml)\r\n", "", "{", "}" );
+            Console.WriteLine( "  interactive{0,-2}Run this CLI in interactive mode, optionally specify URL.", "" );
             Console.WriteLine( "{0,-15}All commands below work in standard or interactive modes.\r\n", "" );
             Console.WriteLine( "  service{0,-6}Install/Uninstall the Windows Service, or Run the Service", "" );
             Console.WriteLine( "{0,-15}as a cmdline-hosted daemon.", "" );
             Console.WriteLine( "{0,-15}- Commands: install|uninstall|run", "" );
             Console.WriteLine( "{0,-15}- Example:  synapse.node.cli service run\r\n", "" );
-            Console.WriteLine( "  httpAction{0,-3}Execute a command, optionally include URL", "" );
-            Console.WriteLine( "{0,-15}Parm help: synapse.node.cli {1}httpAction{2} help.", "", "{", "}" );
-            Console.WriteLine( "{0,-15}URL: url:http://{1}host:port{2}/synapse/node\r\n", "", "{", "}" );
+            Console.WriteLine( "  httpAction{0,-3}Execute a command, optionally specify URL.", "" );
+            Console.WriteLine( "{0,-15}Parm help: synapse.node.cli {1}httpAction{2} help.\r\n", "", "{", "}" );
             Console.WriteLine( "  - httpActions:", "" );
-            Console.WriteLine( "    - Hello|hi           Returns 'Hello World'.", "" );
+            Console.WriteLine( "    - Hello|hi           Returns 'Hello, World!'.", "" );
             Console.WriteLine( "    - WhoAmI|who         Returns NodeServer User Context.", "" );
             Console.WriteLine( "    - Start|s            Start a new Plan Instance.", "" );
             Console.WriteLine( "    - Cancel|c           Cancel a Plan Instance.", "" );
@@ -169,10 +171,10 @@ protected override void WriteHelpAndExit(string errorMessage = null)
             Console.WriteLine( "    - QueueItems|qi      Returns the list of items remaining in the queue.", "" );
             Console.WriteLine( "    - Undrainstop|ust    Resumes normal request processing.\r\n", "" );
             Console.WriteLine( "  Examples:", "" );
-            Console.WriteLine( "    synapse.node.cli l url:http://somehost/synapse/node", "" );
-            Console.WriteLine( "    synapse.node.cli li help", "" );
-            Console.WriteLine( "    synapse.node.cli li planName:foo url:http://somehost/synapse/node", "" );
-            Console.WriteLine( "    synapse.node.cli li planName:foo", "" );
+            Console.WriteLine( "    synapse.node.cli hi url:http://somehost/synapse/node", "" );
+            Console.WriteLine( "    synapse.node.cli s help", "" );
+            Console.WriteLine( "    synapse.node.cli s planInstanceId:0 dryRun:false filePath:C:\\planFile.yaml", "" );
+            Console.WriteLine( "    synapse.node.cli dst url:http://somehost/synapse/node", "" );
             Console.WriteLine( "    synapse.node.cli i url:http://somehost/synapse/node", "" );
             Console.WriteLine( "    synapse.node.cli i", "" );