Updates to README to reflect mods to CLI BaseCommand

Signed-off-by: George M Dias <GDIAS@MITRE.ORG>

Author: georgedias

README.md

@@ -13,20 +13,20 @@ import YAML from 'yaml'
 
 export default class InspecProfile extends BaseCommand<typeof InspecProfile> {
   static readonly usage =
-    '<%= command.id %> -i <stig-xccdf-xml> [-o <output-folder>] [-h] [-m <metadata-json>] ' +
-    '[-T (rule|group|cis|version)] [-s] [-L (info|warn|debug|verbose)]'
+    '<%= command.id %> -X <stig-xccdf-xml> [-O <oval-xccdf-xml]  [-o <output-folder>] [-m <metadata-json>] ' +
+    '[-T (rule|group|cis|version)] [-s] [-L (info|warn|debug|verbose)] [-h] [--interactive]'
 
   static readonly description =
     'Generate a new skeleton profile based on a XCCDF benchmark file'
 
   static readonly examples = [
     {
-      description: '\x1B[93mRequired flag only\x1B[0m',
-      command: '<%= config.bin %> <%= command.id %> -i ./U_RHEL_6_STIG_V2R2_Manual-xccdf.xml',
+      description: '\x1B[93mBase Command\x1B[0m',
+      command: '<%= config.bin %> <%= command.id %> -X ./U_RHEL_6_STIG_V2R2_Manual-xccdf.xml',
     },
     {
       description: '\x1B[93mSpecifying OVAL and Output location\x1B[0m',
-      command: '<%= config.bin %> <%= command.id %> -i ./U_RHEL_9_STIG_V1R2_Manual-xccdf.xml -O ./RHEL_9_Benchmark-oval.xml -o ./output/directory',
+      command: '<%= config.bin %> <%= command.id %> -X ./U_RHEL_9_STIG_V1R2_Manual-xccdf.xml -O ./RHEL_9_Benchmark-oval.xml -o ./output/directory',
     },
   ]
 

src/commands/generate/inspec_profile.ts

@@ -11,7 +11,6 @@ export default class ReadPassthrough extends BaseCommand<typeof ReadPassthrough>
     static readonly examples = ['<%= config.bin %> <%= command.id %> -i hdf.json -o passthrough.json']
 
     static readonly flags = {
-      help: Flags.help({char: 'h'}),
       input: Flags.string({char: 'i', required: true, description: 'An input HDF file'}),
       output: Flags.string({char: 'o', description: 'An output `passthrough` JSON file (otherwise the data is sent to stdout)'}),
     }

src/commands/supplement/passthrough/read.ts

@@ -22,7 +22,6 @@ export default class WritePassthrough extends BaseCommand<typeof WritePassthroug
     ]
 
     static readonly flags = {
-      help: Flags.help({char: 'h'}),
       input: Flags.string({char: 'i', required: true, description: 'An input Heimdall Data Format file'}),
       passthroughFile: Flags.string({char: 'f', exclusive: ['passthroughData'], description: 'An input passthrough-data file (can contain any valid JSON); this flag or `passthroughData` must be provided'}),
       passthroughData: Flags.string({char: 'd', exclusive: ['passthroughFile'], description: 'Input passthrough-data (can be any valid JSON); this flag or `passthroughFile` must be provided'}),

src/commands/supplement/passthrough/write.ts

@@ -11,7 +11,6 @@ export default class ReadTarget extends BaseCommand<typeof ReadTarget> {
     static readonly examples = ['<%= config.bin %> <%= command.id %> -i hdf.json -o target.json']
 
     static readonly flags = {
-      help: Flags.help({char: 'h'}),
       input: Flags.string({char: 'i', required: true, description: 'An input HDF file'}),
       output: Flags.string({char: 'o', description: 'An output `target` JSON file (otherwise the data is sent to stdout)'}),
     }

src/commands/supplement/target/read.ts

@@ -22,7 +22,6 @@ export default class WriteTarget extends BaseCommand<typeof WriteTarget> {
     ]
 
     static readonly flags = {
-      help: Flags.help({char: 'h'}),
       input: Flags.string({char: 'i', required: true, description: 'An input Heimdall Data Format file'}),
       targetFile: Flags.string({char: 'f', exclusive: ['targetData'], description: 'An input target-data file (can contain any valid JSON); this flag or `targetData` must be provided'}),
       targetData: Flags.string({char: 'd', exclusive: ['targetFile'], description: 'Input target-data (can be any valid JSON); this flag or `targetFile` must be provided'}),

src/commands/supplement/target/write.ts

@@ -3,6 +3,17 @@ import {Args, Command, Flags, Interfaces} from '@oclif/core'
 export type Flags<T extends typeof Command> = Interfaces.InferredFlags<typeof BaseCommand['baseFlags'] & T['flags']>
 export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>
 
+export abstract class HelpBaseCommand extends Command {
+  static readonly baseFlags = {
+    help: Flags.help({
+      char: 'h',
+      aliases: ['explain', 'tell-me-more'],
+      // Show this flag under a separate GLOBAL section in help.
+      helpGroup: 'GLOBAL',
+      description: 'Show CLI help',
+    }),
+  };
+}
 export abstract class InteractiveBaseCommand extends Command {
   static readonly baseFlags = {
     interactive: Flags.boolean({
@@ -17,6 +28,7 @@ export abstract class InteractiveBaseCommand extends Command {
 export abstract class BaseCommand<T extends typeof Command> extends Command {
   // define flags that can be inherited by any command that extends BaseCommand
   static readonly baseFlags = {
+    ...HelpBaseCommand.baseFlags,
     ...InteractiveBaseCommand.baseFlags,
     logLevel: Flags.option({
       char: 'L',
@@ -47,7 +59,7 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     // If error message is for missing flags, display what fields
     // are required, otherwise show the error
     if (err.message.includes('See more help with --help')) {
-      this.warn(err.message.replace('--help', '\x1B[93m<cli-command> -h or --help\x1B[0m'))
+      this.warn(err.message.replace('--help', `\x1B[93m${process.argv.at(-2)} ${process.argv.at(-1)} -h or --help\x1B[0m`))
     } else {
       this.warn(err)
     }