@fusion.dev/helix-cli 0.4.2 → 0.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# @fusion.dev/helix-cli
|
|
2
|
+
|
|
3
|
+
The Helix command line. Holds components to the conventions Helix is built on,
|
|
4
|
+
derives themes, scaffolds a project, and serves the derivation to an agent.
|
|
5
|
+
|
|
6
|
+
```sh
|
|
7
|
+
npm install --save-dev @fusion.dev/helix-cli
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
helix component check # the CI shape: nothing printed on success
|
|
12
|
+
helix component audit # every rule and what it found
|
|
13
|
+
helix component fix # the rules that can write
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
| Verb | What it does |
|
|
17
|
+
|---|---|
|
|
18
|
+
| `component` | Holds components to the conventions. `--only <rule>` runs one of `attributes` `axes` `corners` `events` `hooks` `parts` `reflected` `seeds` `selectors` `ssr` `stable` `tokens` and the rest |
|
|
19
|
+
| `theme` | `init` a starter intent, `build` it to CSS, `audit` every contrast pair, `check` in CI |
|
|
20
|
+
| `new` | Scaffolds a project from a Helix template |
|
|
21
|
+
| `mcp` | Serves the derivation to an agent over stdio, as an MCP server |
|
|
22
|
+
|
|
23
|
+
`--json` is on every verb, in a shape a script can read without parsing
|
|
24
|
+
sentences: the rules, their counts and their findings. `--no-color` is the third
|
|
25
|
+
way to turn color off, for a terminal that reports itself capable and is not.
|
|
26
|
+
Color is already off when stdout is not a terminal and when `NO_COLOR` is set.
|
|
27
|
+
|
|
28
|
+
## What it reads
|
|
29
|
+
|
|
30
|
+
`component` reads the tiers named by a `helix` key in `fusion.json`, or by
|
|
31
|
+
`helix.json` where the Fusion CLI is not in use. A rule that needs a
|
|
32
|
+
manifest says so rather than reporting a clean tree it never looked at, so a
|
|
33
|
+
fresh clone wants `cem analyze` before the rules that read one mean anything.
|
|
34
|
+
|
|
35
|
+
## Two shapes, one measurement
|
|
36
|
+
|
|
37
|
+
`audit` prints every rule and exits 1 on a finding. `check` runs the same
|
|
38
|
+
measurement and prints nothing on success. Use `audit` while you work and
|
|
39
|
+
`check` in CI, and never both in one script: the difference is what is printed,
|
|
40
|
+
never what is judged.
|
|
41
|
+
|
|
42
|
+
[Documentation](https://helix.fusion.dev)
|
|
43
|
+
|
|
44
|
+
MIT
|
package/package.json
CHANGED