@spiracss/html-cli 0.2.2 → 0.3.0

package/README.md

@@ -1,20 +1,14 @@
 # @spiracss/html-cli
 
-CLI tools for SpiraCSS HTML to SCSS generation, HTML structure linting, and placeholder formatting.
+A CLI tool designed primarily for AI agents and automation scripts—generates SCSS from HTML, validates structure, and formats placeholders. The [VS Code extension](https://marketplace.visualstudio.com/items?itemName=spiracss.spiracss-html-to-scss) uses this package internally; for manual use, prefer the extension.
 
 ## About SpiraCSS
 
-[SpiraCSS](https://spiracss.jp) is a CSS architecture built on minimal structural principles derived from HTML/CSS. It reduces inconsistencies in structural decisions that are common in CSS design by replacing individual intuition with clear principles. Designed for AI-assisted implementation and tool-based validation, it aims to shorten development time and ensure consistent quality.
+[SpiraCSS](https://spiracss.jp) is a CSS architecture based on one principle. The HTML structure determines how to write styles, eliminating the need for individual judgment. Designed for AI agents and tool-based validation.
 
-Overview: [SpiraCSS Design Principles](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/en/principles.md)
+This CLI is designed to be used with the [SpiraCSS Design Principles](https://spiracss.jp/architecture/principles/).
 
-Key points:
-- Structural decisions can be derived from class names and HTML structure.
-- `shared`/`interaction`/`rel` comment conventions can be treated as tool-verifiable contracts.
-- SpiraCSS projects should place [`spiracss.config.js`](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/en/tooling/spiracss-config.md) at the project root so that generation and validation follow the same policy.
-- Download [spiracss-ai-doc.md](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/ai/spiracss-ai-doc.md) and use it as a reference document for AI-assisted workflows.
-
-This CLI provides the same SCSS starting point for both humans and AI.
+→ [See how it works](https://spiracss.jp)
 
 ## Status
 
@@ -26,6 +20,10 @@ Beta release. Breaking changes may still occur.
 
 ## Install
 
+```bash
+yarn add -D @spiracss/html-cli
+```
+
 ```bash
 npm install -D @spiracss/html-cli
 ```
@@ -42,21 +40,23 @@ Use `--root` for a single component root. Use `--selection` for fragments.
 
 ```bash
 # Generate SCSS from a component root (root mode)
-cat file.html | npx spiracss-html-to-scss --root --stdin --base-dir src/pages
+cat file.html | yarn spiracss-html-to-scss --root --stdin --base-dir src/pages
 
 # Generate SCSS from fragments (selection mode)
-cat fragment.html | npx spiracss-html-to-scss --selection --stdin --base-dir src/pages
+cat fragment.html | yarn spiracss-html-to-scss --selection --stdin --base-dir src/pages
 
 # Lint a component root
-cat file.html | npx spiracss-html-lint --root --stdin
+cat file.html | yarn spiracss-html-lint --root --stdin
 
 # Lint fragments
-cat fragment.html | npx spiracss-html-lint --selection --stdin
+cat fragment.html | yarn spiracss-html-lint --selection --stdin
 
 # Insert placeholders
-cat file.html | npx spiracss-html-format --stdin
+cat file.html | yarn spiracss-html-format --stdin
 ```
 
+Note: If you use npm, replace `yarn` with `npx` or `npm exec`.
+
 ## Configuration
 
 SpiraCSS tools share a common configuration file at the project root: `spiracss.config.js` (htmlFormat, selectorPolicy, generator options, naming).
@@ -85,14 +85,12 @@ Note: If your project is CommonJS (no `"type": "module"` in `package.json`), use
 
 ## Docs
 
-- [SpiraCSS Design Principles](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/en/principles.md) | \[[JA](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/ja/principles.md)\]
-- [HTML CLI guide](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/en/tooling/html-cli.md) | \[[JA](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/ja/tooling/html-cli.md)\]
-- [HTML to SCSS guide](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/en/tooling/html-to-scss.md) | \[[JA](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/ja/tooling/html-to-scss.md)\]
-- [Quickstart](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/en/quickstart.md) | \[[JA](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/ja/quickstart.md)\]
-- [`spiracss.config.js` guide](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/en/tooling/spiracss-config.md) | \[[JA](https://github.com/zetsubo-dev/spiracss/blob/master/docs_spira/ja/tooling/spiracss-config.md)\]
+- [HTML CLI](https://spiracss.jp/tooling/html-cli/)
+- [HTML to SCSS (VS Code)](https://spiracss.jp/tooling/html-to-scss/)
+- [Configuration](https://spiracss.jp/configuration/)
 
 ## Related Tools
 
 - [SpiraCSS Stylelint Plugin (npm)](https://www.npmjs.com/package/@spiracss/stylelint-plugin)
-- [SpiraCSS Comment Links (VS Code Marketplace)](https://marketplace.visualstudio.com/items?itemName=spiracss.spiracss-comment-links)
-- [SpiraCSS HTML to SCSS (VS Code Marketplace)](https://marketplace.visualstudio.com/items?itemName=spiracss.spiracss-html-to-scss)
+- SpiraCSS Comment Links ([VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=spiracss.spiracss-comment-links) / [Open VSX](https://open-vsx.org/extension/spiracss/spiracss-comment-links))
+- SpiraCSS HTML to SCSS ([VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=spiracss.spiracss-html-to-scss) / [Open VSX](https://open-vsx.org/extension/spiracss/spiracss-html-to-scss))