add better help'

Author: PeterPetrik

src/clientcommands.cpp

@@ -118,8 +118,6 @@ void ClientCommands::info( bool isJsonFormat )
     throw QString( "no mergin project in the current directory" );
 
   QTextStream out( stdout );
-
-
   if ( isJsonFormat )
   {
     QJsonObject jsonData

src/clientmain.cpp

@@ -11,6 +11,7 @@
 #include <QCommandLineParser>
 #include <QProcessEnvironment>
 #include <QDir>
+#include <QTextStream>
 
 #include "clientcommands.h"
 #include "coreutils.h"
@@ -25,7 +26,7 @@ struct Args
   QString projectNamespace;
   QString projectName;
   QString dataDir;
-  QString logFile;
+  bool isVerbose;
   bool isJsonFormat;
   int timeout = 10000;
 };
@@ -50,45 +51,78 @@ QString parseEnvArg( const QString &value, const QString &envKey, bool required
   return ret;
 }
 
+QString appDescription()
+{
+  QString ret =
+    "Mergin Command Line Client\n"\
+    "\n"\
+    "Auth\n"\
+    "----\n"\
+    " - use URL, username, password from command line args - e.g.  --url https://dev.mergin.io/ --user martin --password XYZ\n"\
+    " - for any bits (URL / username / password) not specified as command line args, you may use env variables: MERGIN_URL, MERGIN_USER, MERGIN_PASSWORD\n"\
+    " - if URL is omitted, we would use public.cloudmergin.com\n"\
+    "\n"\
+    "Commands\n"\
+    "--------\n"\
+    "  1. manage remote projects (create / remote)\n"\
+    "    mergin create martin/test-project\n"\
+    "    mergin remove martin/test-project\n"\
+    "\n"\
+    "  2. initial download\n"\
+    "    mergin download martin/test-project\n"\
+    "      - project is downloaded to current dir + 'test-project' subdir - like git does\n"\
+    "  3. operations within the current working directory (error if .mergin subdir is missing in the current dir)\n"\
+    "    mergin sync\n"\
+    "      - both pulls remote changes and pushes local changes to server\n"\
+    "    mergin info [--json]\n"\
+    "      - shows project information";
+  return ret;
+}
+
 Args parseArgs()
 {
   Args args;
   QCommandLineParser parser;
-  parser.setApplicationDescription( "Mergin Command Line Client" );
+  parser.setApplicationDescription( appDescription() );
   QCommandLineOption helpOption = parser.addHelpOption();
   QCommandLineOption versionOption = parser.addVersionOption();
-  QCommandLineOption logOption( "log", "log file (debug output)", "log" );
-  parser.addOption( logOption );
-  QCommandLineOption jsonOption( "json", "output as JSON format (e.g. in info format)", "json" );
+  QCommandLineOption verboseOption( "verbose", "Verbose mode. Prints out more information." );
+  parser.addOption( verboseOption );
+  QCommandLineOption jsonOption( "json", "Output 'info' command output in JSON format" );
   parser.addOption( jsonOption );
-
-  parser.addPositionalArgument( "command", "create/remove/download/sync/info" );
-  parser.addPositionalArgument( "project", "namespace/projectname [only for create/remove/download]" );
-
   QCommandLineOption urlOption( "url", "or use env. var MERGIN_URL. defaults to https://public.cloudmergin.com/", "url" );
   parser.addOption( urlOption );
   QCommandLineOption userOption( "user", "or use env. var MERGIN_USER", "user" );
   parser.addOption( userOption );
   QCommandLineOption passwordOption( "password", "or use env. var MERGIN_PASSWORD", "password" );
   parser.addOption( passwordOption );
 
+  parser.addPositionalArgument( "command", "create/remove/download/sync/info" );
+  parser.addPositionalArgument( "project", "namespace/projectname [only for create/remove/download]" );
+
   parser.parse( QCoreApplication::arguments() );
 
   const QStringList posArgs = parser.positionalArguments();
   if ( parser.isSet( helpOption ) || posArgs.isEmpty() )
-    parser.showHelp(); // exits the ap
+    parser.showHelp(); // exits the app
 
   if ( parser.isSet( versionOption ) )
     parser.showVersion(); // exits the app
 
   args.url = parseEnvArg( parser.value( urlOption ), "MERGIN_URL", false ); // MerginApi has public.cloudmergin.com as default
   args.user = parseEnvArg( parser.value( userOption ), "MERGIN_USER" );
   args.pass = parseEnvArg( parser.value( passwordOption ), "MERGIN_PASSWORD" );
-  args.logFile = parser.value( logOption );
+  args.isVerbose = parser.isSet( verboseOption );
   args.isJsonFormat = parser.isSet( jsonOption );
 
-  if ( !args.logFile.isEmpty() )
-    CoreUtils::setLogFilename( args.logFile );
+  if ( args.isVerbose )
+  {
+    CoreUtils::setLogFilename( CoreUtils::LOG_TO_STDOUT );
+  }
+  else
+  {
+    CoreUtils::setLogFilename( CoreUtils::LOG_TO_DEVNULL );
+  }
 
   args.command = posArgs.at( 0 );
   if ( args.command == "create" ||
@@ -102,7 +136,7 @@ Args parseArgs()
     }
 
     if ( !MerginApi::extractProjectName( posArgs.at( 1 ), args.projectNamespace, args.projectName ) )
-      throw QString( "Invalid project, must have format namaspace/projectname: " ) + posArgs.at( 1 );
+      throw QString( "Invalid project, must have format namaspace/project: " ) + posArgs.at( 1 );
 
     args.dataDir = QDir::currentPath();
 
@@ -172,7 +206,8 @@ int main( int argc, char *argv[] )
   }
   catch ( const QString &s )
   {
-    CoreUtils::log( "merginclient", s );
+    QTextStream out( stderr );
+    out << "Error: " << s;
     return EXIT_FAILURE;
   }