@appfire-ux/audit-agent 0.20260702.1 → 0.20260702.2
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
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
# @appfire-ux/audit-agent
|
|
2
2
|
|
|
3
|
-
One-command install of two Claude Code audit agents for Appfire repos.
|
|
3
|
+
One-command install of two Claude Code audit agents for Appfire repos. **Every audit run refreshes both npm packages to `@latest`** (Phase 0):
|
|
4
|
+
|
|
5
|
+
- **`@appfire-ux/audit-agent`** — agent/command definitions in `.claude/`
|
|
6
|
+
- **`@appfire-ux/guidelines`** — rules, skills, and `guidelines/` kit
|
|
7
|
+
|
|
8
|
+
Agents:
|
|
4
9
|
|
|
5
10
|
- **ux-auditor** (`/ux-audit`) — guideline-compliance UX audit: design tokens, spacing/typography, accessibility, UX writing, messaging patterns, persona fit.
|
|
6
11
|
- **ui-auditor** (`/ui-audit`) — UI & usability audit from a UI Designer's perspective: cross-screen consistency, layout & visual hierarchy, information architecture, navigation, interaction design, forms, data-dense views, responsiveness. Screenshot-driven (browser MCP or bundled Playwright fallback).
|
|
@@ -27,11 +32,14 @@ Once, for all repos on your machine:
|
|
|
27
32
|
npx @appfire-ux/audit-agent --global # installs into ~/.claude/
|
|
28
33
|
```
|
|
29
34
|
|
|
30
|
-
## Update
|
|
35
|
+
## Update (manual, optional)
|
|
36
|
+
|
|
37
|
+
Phase 0 on every `/ux-audit`, `/ui-audit`, or `/full-audit` run already calls `npm update` + `@latest` for both packages. Use this only when you want to refresh **without** running an audit:
|
|
31
38
|
|
|
32
39
|
```bash
|
|
33
|
-
npm update @appfire-ux/audit-agent
|
|
40
|
+
npm update @appfire-ux/audit-agent @appfire-ux/guidelines
|
|
34
41
|
npx @appfire-ux/audit-agent
|
|
42
|
+
npx @appfire-ux/guidelines
|
|
35
43
|
```
|
|
36
44
|
|
|
37
45
|
## What gets installed
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@appfire-ux/audit-agent",
|
|
3
|
-
"version": "0.20260702.
|
|
3
|
+
"version": "0.20260702.2",
|
|
4
4
|
"description": "Claude Code audit agents for Appfire apps — installs ux-auditor (/ux-audit: guideline compliance) and ui-auditor (/ui-audit: UI consistency, IA, interaction design), auditing against @appfire-ux/guidelines",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"publishConfig": {
|
|
@@ -20,9 +20,17 @@ You are a senior UI Designer at Appfire doing a design critique of a shipped pro
|
|
|
20
20
|
|
|
21
21
|
Work through the phases below IN ORDER. Do not skip Phase 0 or Phase 7.
|
|
22
22
|
|
|
23
|
-
## Phase 0 — Bootstrap
|
|
23
|
+
## Phase 0 — Bootstrap audit toolchain
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Run **0a** then **0b** before any audit work. Record installed versions and any stale/failed steps in the report appendix.
|
|
26
|
+
|
|
27
|
+
### 0a — Refresh @appfire-ux/audit-agent
|
|
28
|
+
|
|
29
|
+
Same steps as ux-auditor Phase 0a: update/install `@appfire-ux/audit-agent@latest`, run `npx @appfire-ux/audit-agent`, verify `.claude/agents/` and `.claude/commands/` exist. Flag **"audit-agent possibly stale"** on npm failure when older files remain; STOP if no agent files and npm fails.
|
|
30
|
+
|
|
31
|
+
### 0b — Bootstrap @appfire-ux/guidelines
|
|
32
|
+
|
|
33
|
+
Same kit as ux-auditor (npm: `@appfire-ux/guidelines`, source: github.com/fuegokit/appfire-ux-guidelines; postinstall copies `.cursor/rules/ux-*.mdc`, `.cursor/skills/`, `guidelines/` into the project root).
|
|
26
34
|
|
|
27
35
|
1. Locate the repo-root `package.json` (monorepo → workspace root; none anywhere → `npm init -y` and note it in the appendix).
|
|
28
36
|
2. Kit present (`guidelines/` with `foundations/` + `personas/` AND at least one `.cursor/rules/ux-*.mdc`) → refresh:
|
|
@@ -15,9 +15,38 @@ You are a principal UX auditor at Appfire. You produce the most comprehensive, e
|
|
|
15
15
|
|
|
16
16
|
Work through the phases below IN ORDER. Do not skip Phase 0 or Phase 7.
|
|
17
17
|
|
|
18
|
-
## Phase 0 — Bootstrap
|
|
18
|
+
## Phase 0 — Bootstrap audit toolchain
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Run **0a** then **0b** before any audit work. Record installed versions and any stale/failed steps in the report appendix.
|
|
21
|
+
|
|
22
|
+
### 0a — Refresh @appfire-ux/audit-agent
|
|
23
|
+
|
|
24
|
+
This package ships the agent/command definitions in `.claude/`. Refresh them on every audit so methodology updates are picked up automatically.
|
|
25
|
+
|
|
26
|
+
1. At the repo-root `package.json` (monorepo → workspace root):
|
|
27
|
+
- **Listed in `devDependencies` or `dependencies`** → refresh:
|
|
28
|
+
```bash
|
|
29
|
+
npm update @appfire-ux/audit-agent
|
|
30
|
+
npx @appfire-ux/audit-agent
|
|
31
|
+
```
|
|
32
|
+
Compare `npm ls @appfire-ux/audit-agent --depth=0` with `npm view @appfire-ux/audit-agent version`. If still behind, force: `npm install @appfire-ux/audit-agent@latest`, then `npx @appfire-ux/audit-agent`.
|
|
33
|
+
- **Not listed** but `.claude/agents/ux-auditor.md` exists (e.g. global install) → refresh in place:
|
|
34
|
+
```bash
|
|
35
|
+
npx @appfire-ux/audit-agent@latest
|
|
36
|
+
```
|
|
37
|
+
- **Neither** → install as a dev tool, then copy agents:
|
|
38
|
+
```bash
|
|
39
|
+
npm install -D @appfire-ux/audit-agent@latest
|
|
40
|
+
```
|
|
41
|
+
(postinstall runs `npx` automatically; if not, run `npx @appfire-ux/audit-agent` explicitly). Note the fresh install in the appendix.
|
|
42
|
+
2. Verify post-conditions — these MUST exist before continuing:
|
|
43
|
+
- `.claude/agents/ux-auditor.md`, `.claude/agents/ui-auditor.md`
|
|
44
|
+
- `.claude/commands/ux-audit.md`, `.claude/commands/ui-audit.md`, `.claude/commands/full-audit.md`
|
|
45
|
+
3. Failure handling: npm fails but older `.claude/` files exist → proceed and flag **"audit-agent possibly stale"**. npm fails and no agent files → STOP and report the npm error.
|
|
46
|
+
|
|
47
|
+
### 0b — Bootstrap @appfire-ux/guidelines
|
|
48
|
+
|
|
49
|
+
The audit is driven by the Appfire UX Guidelines kit (npm: `@appfire-ux/guidelines`, source: github.com/fuegokit/appfire-ux-guidelines). Its postinstall script copies `.cursor/rules/ux-*.mdc`, `.cursor/skills/`, and `guidelines/` into the project root.
|
|
21
50
|
|
|
22
51
|
1. Locate the correct install directory: the repo-root `package.json`. In a monorepo, use the workspace root. If there is no `package.json` anywhere, run `npm init -y` first and note this in the report appendix.
|
|
23
52
|
2. Detect an existing kit: BOTH `guidelines/` (containing `foundations/` and `personas/`) AND at least one `.cursor/rules/ux-*.mdc` must exist.
|
|
@@ -28,7 +28,10 @@ Screenshot assets: `docs/ui-audit/assets/` and `docs/ux-audit/assets/` (per each
|
|
|
28
28
|
|
|
29
29
|
Do this yourself in the main session — **do not** delegate to either agent yet:
|
|
30
30
|
|
|
31
|
-
1.
|
|
31
|
+
1. **Refresh audit toolchain (Phase 0 from ux-auditor):**
|
|
32
|
+
- **0a** — `@appfire-ux/audit-agent@latest`: `npm update` / `npm install @latest` as needed, then `npx @appfire-ux/audit-agent`. Verify `.claude/agents/` and `.claude/commands/` are current.
|
|
33
|
+
- **0b** — `@appfire-ux/guidelines@latest`: `npm update` / `npm install @latest` as needed, then `npx @appfire-ux/guidelines`. Verify `.cursor/rules/ux-*.mdc` and `guidelines/` exist.
|
|
34
|
+
- Record both package versions and any stale/failed steps for the summary appendix.
|
|
32
35
|
2. Unless `--static-only`: detect dev command (`npm run dev`, etc.), start **one** dev server, note the base URL. Both agents will reuse it — do not start a second server.
|
|
33
36
|
|
|
34
37
|
## Step 2 — Launch agents in parallel
|
|
@@ -38,7 +41,9 @@ Spawn **ux-auditor** and **ui-auditor** **concurrently** (two parallel agent tas
|
|
|
38
41
|
Pass each agent this context:
|
|
39
42
|
|
|
40
43
|
```
|
|
41
|
-
Phase 0 (
|
|
44
|
+
Phase 0 (audit toolchain bootstrap) is ALREADY COMPLETE in the main session.
|
|
45
|
+
- audit-agent version: [npm ls / npm view]
|
|
46
|
+
- guidelines version: [npm ls / npm view]
|
|
42
47
|
- Kit verified at: [list key paths]
|
|
43
48
|
- Dev server: [running at URL | not started — static-only]
|
|
44
49
|
- Scope: [path or whole repo]
|
|
@@ -13,4 +13,4 @@ Interpretation:
|
|
|
13
13
|
- `--lang pl` — write the report in Polish (default: English).
|
|
14
14
|
- `--out <path>` — report location (default: `docs/ui-audit/UI-AUDIT-<date>.md`).
|
|
15
15
|
|
|
16
|
-
Launch the agent with these parameters and let it follow its full methodology, including bootstrapping/refreshing `@appfire-ux/guidelines` (Phase 0), early screenshot capture (Phase 3), and mandatory self-verification (Phase 7). When it finishes, relay: the report path, finding counts by severity, top 3 issues, capture coverage, and any limitations it reported.
|
|
16
|
+
Launch the agent with these parameters and let it follow its full methodology, including bootstrapping/refreshing `@appfire-ux/audit-agent` and `@appfire-ux/guidelines` (Phase 0), early screenshot capture (Phase 3), and mandatory self-verification (Phase 7). When it finishes, relay: the report path, finding counts by severity, top 3 issues, capture coverage, and any limitations it reported.
|
|
@@ -13,4 +13,4 @@ Interpretation:
|
|
|
13
13
|
- `--lang pl` — write the report in Polish (default: English).
|
|
14
14
|
- `--out <path>` — report location (default: `docs/ux-audit/UX-AUDIT-<date>.md`).
|
|
15
15
|
|
|
16
|
-
Launch the agent with these parameters and let it follow its full methodology, including bootstrapping/refreshing `@appfire-ux/guidelines` (Phase 0) and mandatory self-verification (Phase 7). When it finishes, relay: the report path, finding counts by severity, top 3 issues, and any limitations it reported.
|
|
16
|
+
Launch the agent with these parameters and let it follow its full methodology, including bootstrapping/refreshing `@appfire-ux/audit-agent` and `@appfire-ux/guidelines` (Phase 0) and mandatory self-verification (Phase 7). When it finishes, relay: the report path, finding counts by severity, top 3 issues, and any limitations it reported.
|