tutuca 0.9.16 → 0.9.18

package/README.md

@@ -59,6 +59,74 @@ Zero-dependency batteries included SPA framework.
 </html>
 ```
 
+## CLI
+
+Tutuca ships a single-file CLI (`dist/tutuca-cli.js`) for inspecting, linting,
+documenting, and rendering components defined in an ES module. The module just
+needs to export `getComponents()` and, for render-time commands, `getExamples()`
+in the storybook shape `{ title, description?, groups?, items: [{ title, description?, value, view? }] }`.
+
+### Setup
+
+```sh
+npm install --save-dev tutuca jsdom
+# prettier is optional, only needed for --pretty
+npm install --save-dev prettier
+```
+
+The package exposes `tutuca` via `bin`, so `npx tutuca` (or a global `npm i -g tutuca jsdom`) just works. `jsdom` is a peer dep because it's only needed for `render`, `lint`, and `doctor`.
+
+### Commands
+
+```
+tutuca <module-path> <command> [args] [flags]
+tutuca help [command]
+```
+
+| Command | What it does |
+|---|---|
+| `info` | Export inventory and counts for the module |
+| `list` | List components and their fields/views |
+| `examples` | List the examples defined in the module's section |
+| `docs [name]` | Component API docs — all, or one by name |
+| `lint [name]` | Run lint checks — all, or one by name (exit 2 on errors) |
+| `render [name] [--title t] [--view v]` | Render examples to HTML |
+| `doctor` | Lint + render smoke test over the whole module |
+
+Global flags: `-f, --format <cli\|md\|json\|html>`, `-o, --output <file>`, `--pretty`, `-h, --help`.
+Exit codes: `0` ok, `1` usage, `2` lint errors, `3` render crash.
+
+### Usage examples
+
+```sh
+# Summary of what the module exports
+npx tutuca ./src/components.js info
+
+# API docs for one component, as markdown
+npx tutuca ./src/components.js docs Button --format md -o docs/button.md
+
+# Render every example to HTML, pretty-printed
+npx tutuca ./src/components.js render --format html --pretty -o dist/examples.html
+
+# Render a single named example
+npx tutuca ./src/components.js render Button --title "Disabled state"
+
+# Lint just one component (exit 2 if findings)
+npx tutuca ./src/components.js lint Button
+
+# CI smoke test — lints and renders everything
+npx tutuca ./src/components.js doctor
+```
+
+### Wrapping
+
+The invocation stays short even without wrapping, but common patterns:
+
+- **`package.json` scripts** — `"docs": "tutuca ./src/components.js docs"`
+- **Shell alias** — `tut() { npx tutuca ./src/components.js "$@"; }`, then `tut render Button`
+- **`justfile` / `Makefile`** — one recipe per subcommand, passing through positionals
+- **Programmatic** — `import "tutuca/cli"` (the bundled entry) for custom build integration
+
 ## License
 
 MIT