From 219895fb7617e1c34119a59e668cba05db990256 Mon Sep 17 00:00:00 2001 From: CarGDev Date: Tue, 1 Jul 2025 22:41:40 -0400 Subject: [PATCH] docs: document CLI flags and add help --- HELP.md | 9 +++++++++ README.md | 9 +++++++++ 2 files changed, 18 insertions(+) create mode 100644 HELP.md diff --git a/HELP.md b/HELP.md new file mode 100644 index 0000000..8c198cc --- /dev/null +++ b/HELP.md @@ -0,0 +1,9 @@ +# React Crafter CLI Help + +Usage: + npx react-crafter [options] + +Options: + --typescript Scaffold the project using the TypeScript template + -V, --version Output the version number + -h, --help Display help information diff --git a/README.md b/README.md index d900f8f..ffac8f2 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,15 @@ npx react-crafter awesome-project During setup you'll select either JavaScript or TypeScript. React Crafter then calls `create-vite` with the matching template (`react` or `react-ts`) so you won't see any additional prompts. +## CLI Flags + +React Crafter supports a few command line options: + +- `--typescript` – scaffold the project using the TypeScript template without a prompt. +- `-V, --version` – output the CLI version. +- `-h, --help` – display usage information. + + ## Commands Here’s a summary of the commands you can use after setting up your project: