create-krispya 0.5.1 → 0.5.3

package/README.md

@@ -28,6 +28,8 @@ yarn create krispya
 | Library     | Publishable npm package with ESM/CJS output              |
 | Monorepo    | pnpm workspace with shared configs and multiple packages |
 
+> **Note:** Monorepos require pnpm. Applications and libraries support pnpm, npm, and yarn.
+
 ## Templates
 
 | Template     | Description                       |
@@ -63,7 +65,7 @@ my-workspace/
 
 ### Adding Packages
 
-Run the CLI from within a monorepo to add new packages:
+**Interactive:**
 
 ```bash
 cd my-workspace
@@ -71,12 +73,59 @@ pnpm create krispya
 # Select "Add new package to this workspace"
 ```
 
+**Non-interactive (for scripts/AI):**
+
+```bash
+# Add a library to packages/
+pnpm create krispya my-lib --workspace --type library --template react
+
+# Add an app to apps/
+pnpm create krispya my-app --workspace --template r3f --drei --leva
+```
+
+The CLI automatically detects workspace directories from `pnpm-workspace.yaml`. If you have custom directories beyond `apps/` and `packages/` (e.g., `examples/`, `modules/`), you'll be prompted to select where to place the new package (interactive mode only).
+
 Sub-packages automatically:
 
 - Extend shared configs via `@config/*` workspace dependencies
 - Skip redundant files (`.gitignore`, `.vscode/`, etc.)
 - Use root-level dev tools (oxlint, oxfmt)
 
+### Validating a Workspace
+
+Check if a monorepo is properly configured:
+
+```bash
+pnpm create krispya --check
+```
+
+Returns exit code `0` if valid, `1` if invalid. Validates:
+
+- `.config/typescript` package exists
+- Linter config exists (`.config/oxlint`, `eslint.config.js`, or `biome.json`)
+- Formatter config exists (`.config/oxfmt`, `.prettierrc.json`, or `biome.json`)
+
+Useful in scripts:
+
+```bash
+if pnpm create krispya --check; then
+  pnpm create krispya  # add package
+fi
+```
+
+### AI Instruction Files
+
+When creating a monorepo, you can generate AI instruction files to help AI assistants understand the workspace:
+
+| File                              | Tool                    |
+| --------------------------------- | ----------------------- |
+| `.cursor/rules`                   | Cursor                  |
+| `AGENTS.md`                       | GitHub Copilot, general |
+| `CLAUDE.md`                       | Claude                  |
+| `.github/copilot-instructions.md` | GitHub Copilot          |
+
+Select which files to generate during monorepo creation. Your selection can be saved as a default.
+
 ## Tooling Options
 
 | Category  | Options                      | Default   |
@@ -93,17 +142,27 @@ Sub-packages automatically:
 ```
 create-krispya [name] [options]
 
-Options:
+Project Options:
   --type <type>               app | library (default: app)
   --template <type>           vanilla | react | r3f (+ -js variants)
-  --monorepo                  Create a pnpm monorepo workspace
   --linter <type>             eslint | oxlint | biome
   --formatter <type>          prettier | oxfmt | biome
   --bundler <bundler>         unbuild | tsdown (libraries only)
-  --package-manager <pm>      npm | yarn | pnpm
+  --package-manager <pm>      npm | yarn | pnpm (monorepos: pnpm only)
   --node-version <version>    Node.js version (default: latest)
   --pnpm-manage-versions      Enable pnpm version management (default: true)
-  -y, --yes                   Skip prompts, use defaults
+
+Workspace Options:
+  --workspace                 Add package to current monorepo (non-interactive)
+  --dir <directory>           Target directory (default: apps/ or packages/)
+
+Utility Options:
+  --path <directory>          Run in specified directory instead of cwd
+  --check                     Validate current monorepo workspace (exit 0/1)
+  --fix                       Fix monorepo by generating missing config packages
+                              (use with --linter and --formatter for non-interactive)
+  --clear-config              Clear saved preferences (editor, window reuse)
+  --config-path               Print path to config file
 ```
 
 ### R3F Integrations
@@ -132,10 +191,14 @@ For `r3f`/`r3f-js` templates:
 pnpm create krispya
 
 # React app with defaults
-pnpm create krispya my-app --template react -y
+pnpm create krispya my-app --template react
 
-# Monorepo workspace
-pnpm create krispya my-workspace --monorepo
+# Monorepo workspace (select "Monorepo" in prompts)
+pnpm create krispya my-workspace
+
+# Add package to monorepo (non-interactive)
+pnpm create krispya my-lib --workspace --type library --template react
+pnpm create krispya my-example --workspace --dir examples --template r3f
 
 # R3F with integrations
 pnpm create krispya my-3d-app --template r3f --drei --rapier --leva
@@ -145,6 +208,41 @@ pnpm create krispya my-lib --type library --template react --bundler tsdown
 
 # Custom tooling
 pnpm create krispya my-app --linter eslint --formatter prettier
+
+# Validate monorepo workspace
+pnpm create krispya --check
+
+# Validate a different directory
+pnpm create krispya --check --path ~/Dev/my-monorepo
+
+# Fix monorepo (interactive)
+pnpm create krispya --fix
+
+# Fix monorepo (non-interactive)
+pnpm create krispya --fix --linter oxlint --formatter oxfmt
+
+# Clear saved preferences
+pnpm create krispya --clear-config
+```
+
+## Preferences
+
+The CLI saves preferences for:
+
+- **Editor** — Cursor, VS Code, WebStorm, or skip
+- **Window reuse** — Open in current window or new window
+- **AI files** — Which AI instruction files to generate for monorepos
+
+Clear saved preferences:
+
+```bash
+pnpm create krispya --clear-config
+```
+
+View config file location:
+
+```bash
+pnpm create krispya --config-path
 ```
 
 ## Post-Creation