CarGDev/reactwizard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: document CLI flags and add help

Browse Source
This commit is contained in:
Carlos
2025-07-01 22:41:40 -04:00
parent 90f3230a85
commit 219895fb76
2 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
HELP.md Normal file
View File

@@ -0,0 +1,9 @@
# React Crafter CLI Help
Usage:
npx react-crafter <project-directory> [options]
Options:
--typescript Scaffold the project using the TypeScript template
-V, --version Output the version number
-h, --help Display help information

9
README.md
View File

@@ -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. 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 ## Commands
Here’s a summary of the commands you can use after setting up your project: Here’s a summary of the commands you can use after setting up your project: