Implement general help description (#44)

* added initial help description in const string

* fix grammar

* add summary to upload w manifest, added usage to main command

* fix lint

* update description

* fix typo

src/commands/android.ts

@@ -37,8 +37,9 @@ Optionally, you can also include a UUID to identify the upload session.
 
 const androidUploadWithManifestDescription =
 `
-This command uploads the provided file using the packaged AndroidManifest.xml file provided. 
-The application ID, version code, and optional UUID will be extracted from the manifest. 
+This command uploads the provided file using the packaged AndroidManifest.xml provided. 
+You need to provide the path to the mapping file, and the path to the AndroidManifest.xml file.
+The application ID, version code, and optional UUID will be extracted from the manifest file. 
 This command is recommended if you want to automate the upload process without manually specifying the application details.
 `;
 
@@ -61,7 +62,7 @@ androidCommand
   .showHelpAfterError(true)
   .usage('--app-id <value> --version-code <int> --file <path> [--uuid <value>]')
   .description(androidUploadDescription)
-  .summary(`Uploads the Android mapping.txt file of the given path with provided application ID, version code, and optional UUID`)
+  .summary(`Uploads the Android mapping.txt file with the provided application ID, version code, and optional UUID`)
   .requiredOption('--app-id <value>', 'Application ID')
   .requiredOption('--version-code <int>', 'Version code')
   .requiredOption('--file <path>', 'Path to the mapping file')
@@ -108,6 +109,7 @@ androidCommand
   .command('upload-with-manifest')
   .showHelpAfterError(true)
   .usage('--manifest <path> --file <path>')
+  .summary(`Uploads the Android mapping.txt file with metadata extracted from the AndroidManifest.xml file`)
   .description(androidUploadWithManifestDescription)
   .requiredOption('--manifest <path>', 'Path to the packaged AndroidManifest.xml file')
   .requiredOption('--file <path>', 'Path to the mapping.txt file')

src/index.ts

@@ -26,10 +26,17 @@ import { sourcefilesCommand } from './commands/sourcefiles';
 
 const program = new Command();
 
+const helpDescription =
+`A CLI tool for uploading and displaying of Android, iOS, and Browser symbolication files to and from Splunk O11y Cloud.
+
+For each respective command listed below, please run 'o11y-dem-cli <command>' for an overview of available subcommands and options
+`;
+
 program
   .version('1.0.0')
-  .description('A CLI Tool to allow uploading of Android, iOS, and Browser symbolication files to Splunk O11y Cloud');
-
+  .description(helpDescription)
+  .usage('[ios|android|sourcemaps] [sub-command] [options]');
+
 program.addCommand(iosCommand);
 program.addCommand(androidCommand);
 program.addCommand(sourcemapsCommand);