docs: align cli flags with synthetics docs (#914)

* docs: align cli flags with synthetics docs

* apply suggestions from code review

Co-authored-by: Justin Kambic <jk@elastic.co>

---------

Co-authored-by: Justin Kambic <jk@elastic.co>

src/cli.ts

@@ -80,19 +80,22 @@ program
       Object.keys(reporters)
     )
   )
-  .option('--inline', 'Run inline journeys from heartbeat')
+  .option('--inline', 'read journeys from stdin instead of reading from files')
   .option('-r, --require <modules...>', 'module(s) to preload')
   .option('--sandbox', 'enable chromium sand-boxing')
-  .option('--rich-events', 'Mimics a heartbeat run')
-  .option('--no-headless', 'run browser in head-full mode')
+  .option(
+    '--rich-events',
+    'preset flag used when running monitors directly via Heartbeat'
+  )
+  .option('--no-headless', 'run with the browser in headful mode')
   .option(
     '--capability <features...>',
     'Enable capabilities through feature flags'
   )
   .addOption(
     new Option(
       '--screenshots [flag]',
-      'take screenshots at end of each step'
+      'Control whether to capture screenshots at the end of each step'
     ).choices(['on', 'off', 'only-on-failure'])
   )
   .option(

src/options.ts

@@ -189,7 +189,7 @@ export function parseThrottling() {
 export function getCommonCommandOpts() {
   const params = createOption(
     '-p, --params <jsonstring>',
-    'JSON object that gets injected to all journeys'
+    'JSON object that defines any variables your tests require.'
   ).argParser(JSON.parse);
 
   const playwrightOpts = createOption(
@@ -199,7 +199,7 @@ export function getCommonCommandOpts() {
 
   const pattern = createOption(
     '--pattern <pattern>',
-    'RegExp pattern to match journey/monitor files that are different from the default (ex: /*.journey.(ts|js)$/)'
+    'RegExp pattern to match journey files in the current working directory (default: /*.journey.(ts|js)$/)'
   );
 
   const apiDocsLink =
@@ -214,16 +214,16 @@ export function getCommonCommandOpts() {
 
   const configOpt = createOption(
     '-c, --config <path>',
-    'configuration path (default: synthetics.config.js)'
+    'path to the configuration file (default: synthetics.config.(js|ts))'
   );
 
   const tags = createOption(
     '--tags <name...>',
-    'run/push tests with a tag that matches the glob'
+    'run/push tests with the tag(s) matching a pattern'
   );
   const match = createOption(
     '--match <name>',
-    'run/push tests with a name or tags that matches the glob'
+    'run/push tests with a name or tags that matches a pattern'
   );
 
   return {