@crvy/strybk 0.0.3 → 0.0.5

package/CHANGELOG.md

@@ -5,6 +5,16 @@ 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.0.5] - 2026-07-06
+
+### Added
+
+- **cli:** Add --help/-h flag to print usage and exit 0
+## [0.0.4] - 2026-07-03
+
+### Other
+
+- Update README.md
 ## [0.0.3] - 2026-06-18
 
 ### Added

package/README.md

@@ -1,23 +1,11 @@
-# strybk
+# @crvy/strybk
 
 Generator-first Playwright screenshot testing for Storybook.
 
-## Development
-
-Install dependencies with Bun:
-
-```sh
-bun install
-```
-
-Common local commands:
+## Installation
 
 ```sh
-bun run lint
-bun run typecheck
-bun run test:bun
-bun run build
-bun run check
+npm install --save-dev @crvy/strybk
 ```
 
 ## CLI
@@ -93,3 +81,21 @@ If you want to persist the link in the consumer's manifest, Bun supports a `link
   }
 }
 ```
+
+## Development
+
+Install dependencies with Bun:
+
+```sh
+bun install
+```
+
+Common local commands:
+
+```sh
+bun run lint
+bun run typecheck
+bun run test:bun
+bun run build
+bun run check
+```

package/dist/src/cli.d.ts

@@ -4,6 +4,9 @@ export interface GenerateCliArgs {
     configPath: string;
     dryRun: boolean;
 }
+export declare const HELP_TEXT = "Usage: crvy-strybk generate --config <path> [options]\n\nGenerate Playwright screenshot spec files from a running Storybook index.\n\nThe Storybook server must be running at the configured `storybookUrl` so that\nindex.json can be fetched at generate time.\n\nOptions:\n  --config <path>     Path to strybk.config.ts (required)\n  --dry-run           Compute outputs without writing files\n  -h, --help          Show this help message\n";
+export declare function printHelp(): void;
+export declare function wantsHelp(argv: string[]): boolean;
 export declare function parseCliArgs(argv: string[]): GenerateCliArgs;
 export declare function runCli(argv: string[]): Promise<Array<{
     outputPath: string;

package/dist/src/cli.js

@@ -99,6 +99,24 @@ const writeGeneratedFiles = (outputs) => {
         writeFileSync(output.outputPath, output.content);
     }
 };
+export const HELP_TEXT = `Usage: crvy-strybk generate --config <path> [options]
+
+Generate Playwright screenshot spec files from a running Storybook index.
+
+The Storybook server must be running at the configured \`storybookUrl\` so that
+index.json can be fetched at generate time.
+
+Options:
+  --config <path>     Path to strybk.config.ts (required)
+  --dry-run           Compute outputs without writing files
+  -h, --help          Show this help message
+`;
+export function printHelp() {
+    console.log(HELP_TEXT);
+}
+export function wantsHelp(argv) {
+    return argv.includes("--help") || argv.includes("-h");
+}
 export function parseCliArgs(argv) {
     const [command, ...options] = argv;
     if (command !== "generate") {
@@ -155,6 +173,10 @@ export async function runCli(argv) {
     return outputs;
 }
 export async function main(argv = process.argv.slice(2)) {
+    if (wantsHelp(argv)) {
+        printHelp();
+        return;
+    }
     try {
         const outputs = await runCli(argv);
         const dryRun = argv.includes("--dry-run");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvy/strybk",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Generator-first Playwright screenshot testing for Storybook.",
   "keywords": [
     "crvy",