@crvy/rprtr 0.2.3 → 0.2.4

package/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.4] - 2026-07-06
+
+### Added
+
+- **cli:** Add --help/-h flag to print usage and exit 0
 ## [0.2.3] - 2026-07-03
 
 ### Fixed

package/dist/cli.d.ts

@@ -6,6 +6,9 @@ interface ResolvedCliOptions extends ServerOptions {
     reportPath: string;
     outputDir: string;
 }
+export declare const HELP_TEXT = "Usage: crvy-rprtr [artifact-dir] [options]\n\nStart the @crvy/rprtr visual regression report UI server.\n\nArguments:\n  artifact-dir                Directory of downloaded CI test artifacts. When set,\n                              --report-path defaults to <dir>/report.json and\n                              --screenshot-dir defaults to <dir>/screenshots.\n\nOptions:\n  -p, --port <number>           Server port (default: 3000)\n  -s, --screenshot-dir <dir>    Screenshot artifact directory (default: ./screenshots)\n  -r, --report-path <path>      Path to report.json (default: ./report.json)\n  -o, --output-dir <dir>        Playwright test output directory (default: ./test-results)\n  -c, --config <path>           Path to playwright.config.ts, used for approval routing\n  -h, --help                    Show this help message\n";
+export declare function printHelp(): void;
+export declare function wantsHelp(args: string[]): boolean;
 export declare function resolveCliOptions(args: string[]): ResolvedCliOptions;
 export {};
 //# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAKA,OAAO,EAAe,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AAO7D,UAAU,kBAAmB,SAAQ,aAAa;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,kBAAkB,CA8BpE"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAKA,OAAO,EAAe,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AAO7D,UAAU,kBAAmB,SAAQ,aAAa;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,eAAO,MAAM,SAAS,00BAgBrB,CAAA;AAED,wBAAgB,SAAS,IAAI,IAAI,CAEhC;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAEjD;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,kBAAkB,CA8BpE"}

package/dist/cli.js

@@ -32,6 +32,29 @@ var DEFAULT_PORT = 3e3;
 var DEFAULT_SCREENSHOT_DIR = "./screenshots";
 var DEFAULT_REPORT_PATH = "./report.json";
 var DEFAULT_OUTPUT_DIR = "./test-results";
+var HELP_TEXT = `Usage: crvy-rprtr [artifact-dir] [options]
+
+Start the @crvy/rprtr visual regression report UI server.
+
+Arguments:
+  artifact-dir                Directory of downloaded CI test artifacts. When set,
+                              --report-path defaults to <dir>/report.json and
+                              --screenshot-dir defaults to <dir>/screenshots.
+
+Options:
+  -p, --port <number>           Server port (default: 3000)
+  -s, --screenshot-dir <dir>    Screenshot artifact directory (default: ./screenshots)
+  -r, --report-path <path>      Path to report.json (default: ./report.json)
+  -o, --output-dir <dir>        Playwright test output directory (default: ./test-results)
+  -c, --config <path>           Path to playwright.config.ts, used for approval routing
+  -h, --help                    Show this help message
+`;
+function printHelp() {
+  console.log(HELP_TEXT);
+}
+function wantsHelp(args) {
+  return args.includes("--help") || args.includes("-h");
+}
 function resolveCliOptions(args) {
   const { values, positionals } = parseArgs({
     args,
@@ -59,8 +82,16 @@ function resolveCliOptions(args) {
   };
 }
 if (isDirectExecution(import.meta.url)) {
-  await startServer(resolveCliOptions(process.argv.slice(2)));
+  const args = process.argv.slice(2);
+  if (wantsHelp(args)) {
+    printHelp();
+  } else {
+    await startServer(resolveCliOptions(args));
+  }
 }
 export {
-  resolveCliOptions
+  HELP_TEXT,
+  printHelp,
+  resolveCliOptions,
+  wantsHelp
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvy/rprtr",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Playwright reporter with visual regression UI for comparing and approving screenshot tests",
   "keywords": [
     "crvy",