@wireweave/cli 0.1.1-beta.11 → 0.1.1-beta.12

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.
Files changed (2) hide show
  1. package/README.md +14 -61
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,76 +1,29 @@
1
1
  # @wireweave/cli
2
2
 
3
- The terminal frontend for the Wireweave wireframe DSL — parse, validate, render, analyze, diff, and export `.wf` files from your shell.
3
+ The terminal entry point for Wireweave language tools.
4
4
 
5
- ## What it does
5
+ The [public tool contract](../../docs/spec/TOOLING.md#4-cli) defines this package's APIs, behavior, configuration and compatibility. The [language contract](../../docs/spec/LANGUAGE.md) defines the DSL. [Package metadata](package.json) owns package versions, exports, dependencies and scripts.
6
6
 
7
- The CLI is a thin frontend over [`@wireweave/sdk`](https://github.com/wireweave/sdk). Every command runs through the SDK's single `dispatch()` entry point, which routes the call to the right place:
7
+ ## Installation
8
8
 
9
- - **Local commands** (`parse`, `validate`, `render`, `analyze`, `diff`, `validate-ux`, `export-json`, `export-figma`, `list-components`) run fully in-process. No network, no API key.
10
- - **Auth commands** (`login`, `logout`, `whoami`) talk to the Wireweave API to verify and persist a key for tools that need one.
11
-
12
- The persistent token lives at `~/.wireweave/config.json` (`0600`) with shape `{ "token": string, "apiUrl"?: string }`.
13
-
14
- ## Install
9
+ Use Node.js >=22.13.0. Replace `<pinned-version>` with the release selected for your toolchain.
15
10
 
16
11
  ```bash
17
- npm install -g @wireweave/cli
12
+ npm install --global '@wireweave/cli@<pinned-version>'
18
13
  ```
19
14
 
20
- Or run without installing:
21
-
22
- ```bash
23
- npx @wireweave/cli parse design.wf
24
- ```
15
+ The installed executable is `wireweave`. Setup, transports and credentials are defined by the tool contract.
25
16
 
26
- Requires Node.js 18+.
17
+ ## Development
27
18
 
28
- ## Usage
19
+ Run from the monorepo root after the [workspace setup](../../README.md).
29
20
 
30
21
  ```bash
31
- # Local — no network, no key required
32
- wireweave parse design.wf
33
- wireweave validate design.wf --strict
34
- wireweave render design.wf --theme dark -o design.html
35
- wireweave analyze design.wf --format summary
36
- wireweave diff old.wf new.wf --ignore-order
37
- wireweave validate-ux design.wf --min-severity warning
38
- wireweave export-json design.wf -o design.json
39
- wireweave export-figma design.wf -o design.figma.json
40
- wireweave list-components --category form
41
-
42
- # Auth
43
- wireweave login --api-key <key> # or pipe via stdin / WIREWEAVE_API_KEY
44
- wireweave whoami
45
- wireweave logout
22
+ pnpm --filter @wireweave/cli run build
23
+ pnpm --filter @wireweave/cli run typecheck
24
+ pnpm --filter @wireweave/cli run lint
25
+ pnpm --filter @wireweave/cli run test
26
+ pnpm --filter @wireweave/cli run format:check
46
27
  ```
47
28
 
48
- ## Commands
49
-
50
- | Command | Network | Description |
51
- | --------------------- | ------- | ----------------------------------------------------------------------------------------------------------- |
52
- | `parse <file>` | local | Parse a `.wf`/`.wireframe` file and print its AST as JSON. |
53
- | `validate <file>` | local | Validate syntax. `--strict` also rejects unknown attributes. |
54
- | `render <file>` | local | Render to HTML. `--theme light\|dark`, `--full-document`, `-o <path>`. |
55
- | `analyze <file>` | local | Statistics, accessibility, and complexity. `--format json\|summary`, `--no-*` toggles. |
56
- | `diff <old> <new>` | local | Compare two wireframes. `--ignore-attributes`, `--ignore-order`, `--format`. |
57
- | `validate-ux <file>` | local | Check against UX best-practice rules. `--categories`, `--min-severity`, `--max-issues`, `--disabled-rules`. |
58
- | `export-json <file>` | local | Export as JSON. `--include-locations`, `--no-pretty-print`, `--include-empty-attributes`. |
59
- | `export-figma <file>` | local | Export to Figma-compatible JSON. |
60
- | `list-components` | local | List DSL components. `--category`, `--format table\|json`. |
61
- | `login` | network | Verify an API key and store it. `--api-key`, `--api-url`. |
62
- | `whoami` | network | Verify the stored key and show the configured account. |
63
- | `logout` | local | Remove the stored API key from disk. |
64
-
65
- ## Environment
66
-
67
- | Variable | Default | Purpose |
68
- | ------------------- | --------------------------- | -------------------------------------- |
69
- | `WIREWEAVE_API_URL` | `https://api.wireweave.org` | Override the API base. |
70
- | `WIREWEAVE_API_KEY` | — | Per-shell override of the saved token. |
71
-
72
- Part of the [Wireweave monorepo](https://github.com/wireweave/wireweave).
73
-
74
- ## License
75
-
76
- MIT
29
+ License: MIT.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wireweave/cli",
3
- "version": "0.1.1-beta.11",
3
+ "version": "0.1.1-beta.12",
4
4
  "description": "Wireweave CLI — auth, render, and AI agent for the Wireweave wireframe DSL",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -18,7 +18,7 @@
18
18
  },
19
19
  "dependencies": {
20
20
  "commander": "^12.1.0",
21
- "@wireweave/sdk": "0.1.1-beta.11"
21
+ "@wireweave/sdk": "0.1.1-beta.12"
22
22
  },
23
23
  "devDependencies": {
24
24
  "@commitlint/cli": "^21.0.1",