brandrail 0.4.1 → 0.5.0
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 +9 -2
- package/dist/brandrail.mjs +40123 -2893
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -12,11 +12,15 @@ npx brandrail scan <url> # check a running page in a real browser
|
|
|
12
12
|
## With a Brandrail account
|
|
13
13
|
|
|
14
14
|
```bash
|
|
15
|
-
|
|
16
|
-
|
|
15
|
+
npx brandrail connect # sign in through the browser; sets up the Brand Kit, AI rule files,
|
|
16
|
+
# the MCP server for Claude Code / Cursor / Copilot, and the UI kit
|
|
17
17
|
npx brandrail check --changed --upload # only changed lines, results in the dashboard
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
+
`connect` makes an API key on your machine and saves it in `~/.config/brandrail/credentials.json` (mode 600);
|
|
21
|
+
Brandrail only ever receives its hash, and the files it writes into the repo hold no key. AI tools start
|
|
22
|
+
`npx brandrail mcp`, which checks code on your machine: code is never uploaded. In CI, set `BRANDRAIL_KEY` instead.
|
|
23
|
+
|
|
20
24
|
## Commands
|
|
21
25
|
|
|
22
26
|
| Command | |
|
|
@@ -26,5 +30,8 @@ npx brandrail check --changed --upload # only changed lines, results in the d
|
|
|
26
30
|
| `init` | `--from-api`, `--mcp`, `--tokens-css <file>`, `--no-rules`, `--force`. Writes the Brand Kit as CSS variables; import that file once at your app entry |
|
|
27
31
|
| `import <tokens.json>` | DTCG, Tokens Studio or Figma variables JSON into the config. `--replace`, `--primitives` |
|
|
28
32
|
| `rules` | List the rules |
|
|
33
|
+
| `connect` | `--no-browser`, `--no-install`, `--remote` (hosted MCP server), `--framework`, `--force` (sign in again) |
|
|
34
|
+
| `mcp` | The MCP server over stdio, for AI tools. `--framework`, `--report` (send scores, never code) |
|
|
35
|
+
| `whoami`, `logout` | Show or remove the saved sign-in |
|
|
29
36
|
|
|
30
37
|
Nothing is uploaded unless you pass `--upload`, and code snippets are never uploaded.
|