qualia-framework 4.4.0 → 5.1.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/AGENTS.md +24 -0
- package/CLAUDE.md +12 -63
- package/README.md +24 -18
- package/agents/builder.md +13 -33
- package/agents/plan-checker.md +18 -0
- package/agents/planner.md +17 -0
- package/agents/verifier.md +70 -0
- package/agents/visual-evaluator.md +132 -0
- package/bin/cli.js +64 -23
- package/bin/install.js +375 -29
- package/bin/qualia-ui.js +208 -1
- package/bin/slop-detect.mjs +362 -0
- package/bin/state.js +218 -2
- package/docs/erp-contract.md +5 -0
- package/docs/install-redesign-builder-prompt.md +290 -0
- package/docs/install-redesign-pilot.md +234 -0
- package/docs/playwright-loop-builder-prompt.md +185 -0
- package/docs/playwright-loop-design-notes.md +108 -0
- package/docs/playwright-loop-pilot-results.md +170 -0
- package/docs/playwright-loop-review-2026-05-03.md +65 -0
- package/docs/playwright-loop-tester-prompt.md +213 -0
- package/docs/reviews/matt-pocock-skills-analysis.md +300 -0
- package/guide.md +9 -5
- package/hooks/env-empty-guard.js +74 -0
- package/hooks/pre-compact.js +19 -9
- package/hooks/pre-deploy-gate.js +8 -2
- package/hooks/pre-push.js +26 -12
- package/hooks/supabase-destructive-guard.js +62 -0
- package/hooks/vercel-account-guard.js +91 -0
- package/package.json +2 -1
- package/rules/design-brand.md +114 -0
- package/rules/design-laws.md +148 -0
- package/rules/design-product.md +114 -0
- package/rules/design-rubric.md +157 -0
- package/rules/grounding.md +4 -0
- package/skills/qualia-build/SKILL.md +40 -46
- package/skills/qualia-discuss/SKILL.md +51 -68
- package/skills/qualia-handoff/SKILL.md +1 -0
- package/skills/qualia-issues/SKILL.md +151 -0
- package/skills/qualia-map/SKILL.md +78 -35
- package/skills/qualia-new/REFERENCE.md +139 -0
- package/skills/qualia-new/SKILL.md +85 -124
- package/skills/qualia-optimize/REFERENCE.md +202 -0
- package/skills/qualia-optimize/SKILL.md +72 -237
- package/skills/qualia-plan/SKILL.md +58 -65
- package/skills/qualia-polish/SKILL.md +180 -136
- package/skills/qualia-polish-loop/REFERENCE.md +265 -0
- package/skills/qualia-polish-loop/SKILL.md +201 -0
- package/skills/qualia-polish-loop/fixtures/broken.html +117 -0
- package/skills/qualia-polish-loop/fixtures/clean.html +196 -0
- package/skills/qualia-polish-loop/scripts/loop.mjs +302 -0
- package/skills/qualia-polish-loop/scripts/playwright-capture.mjs +197 -0
- package/skills/qualia-polish-loop/scripts/score.mjs +176 -0
- package/skills/qualia-report/SKILL.md +141 -180
- package/skills/qualia-research/SKILL.md +28 -33
- package/skills/qualia-road/SKILL.md +103 -0
- package/skills/qualia-ship/SKILL.md +1 -0
- package/skills/qualia-task/SKILL.md +1 -1
- package/skills/qualia-test/SKILL.md +50 -2
- package/skills/qualia-triage/SKILL.md +152 -0
- package/skills/qualia-verify/SKILL.md +63 -104
- package/skills/qualia-zoom/SKILL.md +51 -0
- package/skills/zoho-workflow/SKILL.md +64 -0
- package/templates/CONTEXT.md +36 -0
- package/templates/DESIGN.md +229 -435
- package/templates/PRODUCT.md +95 -0
- package/templates/decisions/ADR-template.md +30 -0
- package/tests/bin.test.sh +451 -7
- package/tests/state.test.sh +58 -0
- package/skills/qualia-design/SKILL.md +0 -169
package/bin/state.js
CHANGED
|
@@ -735,6 +735,22 @@ function cmdTransition(opts) {
|
|
|
735
735
|
function cmdInit(opts) {
|
|
736
736
|
if (!opts.project) return output(fail("MISSING_ARG", "--project required"));
|
|
737
737
|
|
|
738
|
+
// v5.0: Throwaway-name guard. The insights report documents the user
|
|
739
|
+
// accidentally creating a project literally named "test-name-only" instead
|
|
740
|
+
// of the real client name. Names matching common scratch/test patterns get
|
|
741
|
+
// a 1-line confirmation step (bypass with --force).
|
|
742
|
+
if (!opts.force) {
|
|
743
|
+
const SUSPICIOUS = /^(test|tmp|temp|foo|bar|baz|scratch|demo|sample|untitled|new[\W_-]?project|example)(\b|[\W_-])/i;
|
|
744
|
+
if (SUSPICIOUS.test(opts.project)) {
|
|
745
|
+
return output(
|
|
746
|
+
fail(
|
|
747
|
+
"SUSPICIOUS_NAME",
|
|
748
|
+
`Project name '${opts.project}' looks temporary/test-like. If this is the real client project name, re-run with --force. Otherwise re-run with the actual project name.`
|
|
749
|
+
)
|
|
750
|
+
);
|
|
751
|
+
}
|
|
752
|
+
}
|
|
753
|
+
|
|
738
754
|
// Refuse to clobber an active project unless --force.
|
|
739
755
|
// Lifetime preservation runs lower in this fn — but current-phase fields
|
|
740
756
|
// (phase, status, wave, tasks_done, tasks_total, gap_cycles) ARE wiped
|
|
@@ -1173,7 +1189,24 @@ function cmdCloseMilestone(opts) {
|
|
|
1173
1189
|
t.milestone_name = readNextMilestoneNameFromJourney(t.milestone);
|
|
1174
1190
|
t.last_updated = new Date().toISOString();
|
|
1175
1191
|
|
|
1176
|
-
|
|
1192
|
+
// v5.0 — journal-protected write. STATE.md is intentionally NOT mutated here
|
|
1193
|
+
// (the next /qualia-milestone step calls `state.js init --force` which fully
|
|
1194
|
+
// rewrites STATE.md for the new milestone). The journal still snapshots
|
|
1195
|
+
// tracking.json so a crash mid-write can be detected and recovered by the
|
|
1196
|
+
// next session via recoverFromJournal().
|
|
1197
|
+
const backupTracking = (() => {
|
|
1198
|
+
try { return fs.readFileSync(TRACKING_FILE, "utf8"); } catch { return null; }
|
|
1199
|
+
})();
|
|
1200
|
+
try {
|
|
1201
|
+
writeJournal(null, backupTracking);
|
|
1202
|
+
writeTracking(t);
|
|
1203
|
+
clearJournal();
|
|
1204
|
+
} catch (e) {
|
|
1205
|
+
// Restore tracking.json from backup if write failed mid-way.
|
|
1206
|
+
try { if (backupTracking) atomicWrite(TRACKING_FILE, backupTracking); } catch {}
|
|
1207
|
+
clearJournal();
|
|
1208
|
+
return output(fail("WRITE_ERROR", `close-milestone write failed: ${e.message}. tracking.json restored from backup.`));
|
|
1209
|
+
}
|
|
1177
1210
|
|
|
1178
1211
|
_trace("close-milestone", "allow", {
|
|
1179
1212
|
closed_milestone: closedMilestone,
|
|
@@ -1267,6 +1300,186 @@ function cmdBackfillLifetime(opts) {
|
|
|
1267
1300
|
});
|
|
1268
1301
|
}
|
|
1269
1302
|
|
|
1303
|
+
// ─── Backfill Milestones from JOURNEY.md ─────────────────
|
|
1304
|
+
// Reconstructs the milestones[] array + lifetime counters from the
|
|
1305
|
+
// "Milestone arc" table in .planning/JOURNEY.md. Required when a project
|
|
1306
|
+
// pre-dates v4 milestone bookkeeping (or had its tracking.json reset)
|
|
1307
|
+
// but JOURNEY.md captures the historical arc. Idempotent — only adds
|
|
1308
|
+
// missing milestones or overwrites entries flagged backfilled:true.
|
|
1309
|
+
//
|
|
1310
|
+
// JOURNEY.md table format expected:
|
|
1311
|
+
// | # | Milestone | Status | Phases | Closed |
|
|
1312
|
+
// | 1 | Name | CLOSED | 1–13 | YYYY-MM-DD |
|
|
1313
|
+
// | 5 | Name | OPEN | rolling| — |
|
|
1314
|
+
//
|
|
1315
|
+
// Phase counting handles ranges (`1–13` → 13), comma lists (`14, 15, 16.1–16.6` → 8),
|
|
1316
|
+
// and "rolling" / "—" / "-" → 0.
|
|
1317
|
+
function cmdBackfillMilestones(opts) {
|
|
1318
|
+
const t = readTracking();
|
|
1319
|
+
if (!t) return output(fail("NO_PROJECT", "No .planning/ found."));
|
|
1320
|
+
ensureLifetime(t);
|
|
1321
|
+
|
|
1322
|
+
const journeyPath = path.join(PLANNING, "JOURNEY.md");
|
|
1323
|
+
if (!fs.existsSync(journeyPath)) {
|
|
1324
|
+
return output(fail("NO_JOURNEY", "JOURNEY.md not found. Cannot backfill without milestone history source."));
|
|
1325
|
+
}
|
|
1326
|
+
|
|
1327
|
+
const content = fs.readFileSync(journeyPath, "utf8");
|
|
1328
|
+
|
|
1329
|
+
// Parse the milestone arc table. Each row must have 5 columns:
|
|
1330
|
+
// num | name | status | phases | closed
|
|
1331
|
+
const rows = [];
|
|
1332
|
+
const lines = content.split(/\r?\n/);
|
|
1333
|
+
for (const line of lines) {
|
|
1334
|
+
const m = line.match(
|
|
1335
|
+
/^\|\s*(\d+)\s*\|\s*([^|]+?)\s*\|\s*(CLOSED|OPEN|CURRENT)\s*\|\s*([^|]+?)\s*\|\s*([^|]+?)\s*\|/i
|
|
1336
|
+
);
|
|
1337
|
+
if (m) {
|
|
1338
|
+
rows.push({
|
|
1339
|
+
num: parseInt(m[1], 10),
|
|
1340
|
+
name: m[2].trim(),
|
|
1341
|
+
status: m[3].trim().toUpperCase(),
|
|
1342
|
+
phasesStr: m[4].trim(),
|
|
1343
|
+
closedStr: m[5].trim(),
|
|
1344
|
+
});
|
|
1345
|
+
}
|
|
1346
|
+
}
|
|
1347
|
+
|
|
1348
|
+
if (rows.length === 0) {
|
|
1349
|
+
return output(
|
|
1350
|
+
fail(
|
|
1351
|
+
"NO_MILESTONE_TABLE",
|
|
1352
|
+
"No milestone arc table found in JOURNEY.md. Expected `| # | Milestone | Status | Phases | Closed |` header followed by rows."
|
|
1353
|
+
)
|
|
1354
|
+
);
|
|
1355
|
+
}
|
|
1356
|
+
|
|
1357
|
+
// Count phases from a phasesStr.
|
|
1358
|
+
// "1–13" → 13. "14, 15, 16.1–16.6" → 8. "19–25" → 7. "rolling" / "—" / "-" → 0.
|
|
1359
|
+
const countPhases = (s) => {
|
|
1360
|
+
if (!s) return 0;
|
|
1361
|
+
const lower = s.toLowerCase();
|
|
1362
|
+
if (lower === "—" || lower === "-" || lower === "rolling" || lower === "n/a") return 0;
|
|
1363
|
+
let count = 0;
|
|
1364
|
+
for (const seg of s.split(",")) {
|
|
1365
|
+
const trimmed = seg.trim();
|
|
1366
|
+
if (!trimmed || trimmed === "—" || trimmed === "-") continue;
|
|
1367
|
+
// Match X–Y or X-Y where X/Y can be "13" or "16.6"
|
|
1368
|
+
const range = trimmed.match(/^(\d+(?:\.\d+)?)\s*[–-]\s*(\d+(?:\.\d+)?)$/);
|
|
1369
|
+
if (range) {
|
|
1370
|
+
const startStr = range[1];
|
|
1371
|
+
const endStr = range[2];
|
|
1372
|
+
// Sub-phase range like "16.1–16.6" → count by sub-index difference + 1
|
|
1373
|
+
if (startStr.includes(".") && endStr.includes(".")) {
|
|
1374
|
+
const startSub = parseInt(startStr.split(".")[1], 10);
|
|
1375
|
+
const endSub = parseInt(endStr.split(".")[1], 10);
|
|
1376
|
+
count += Math.max(0, endSub - startSub + 1);
|
|
1377
|
+
} else {
|
|
1378
|
+
const start = parseInt(startStr, 10);
|
|
1379
|
+
const end = parseInt(endStr, 10);
|
|
1380
|
+
count += Math.max(0, end - start + 1);
|
|
1381
|
+
}
|
|
1382
|
+
} else {
|
|
1383
|
+
// Single phase like "14" or "17.1"
|
|
1384
|
+
count += 1;
|
|
1385
|
+
}
|
|
1386
|
+
}
|
|
1387
|
+
return count;
|
|
1388
|
+
};
|
|
1389
|
+
|
|
1390
|
+
const closed = rows.filter((r) => r.status === "CLOSED").sort((a, b) => a.num - b.num);
|
|
1391
|
+
const openRow = rows.find((r) => r.status === "OPEN" || r.status === "CURRENT");
|
|
1392
|
+
|
|
1393
|
+
t.milestones = Array.isArray(t.milestones) ? t.milestones : [];
|
|
1394
|
+
let added = 0;
|
|
1395
|
+
let updated = 0;
|
|
1396
|
+
let totalClosedPhases = 0;
|
|
1397
|
+
const closedSummaries = [];
|
|
1398
|
+
|
|
1399
|
+
for (const row of closed) {
|
|
1400
|
+
const phaseCount = countPhases(row.phasesStr);
|
|
1401
|
+
totalClosedPhases += phaseCount;
|
|
1402
|
+
|
|
1403
|
+
const dateMatch = row.closedStr.match(/\d{4}-\d{2}-\d{2}/);
|
|
1404
|
+
const closedAt = dateMatch ? `${dateMatch[0]}T00:00:00.000Z` : "";
|
|
1405
|
+
|
|
1406
|
+
const summary = {
|
|
1407
|
+
num: row.num,
|
|
1408
|
+
name: row.name,
|
|
1409
|
+
total_phases: phaseCount,
|
|
1410
|
+
phases_completed: phaseCount,
|
|
1411
|
+
tasks_completed: 0, // unknown for historical backfill
|
|
1412
|
+
shipped_url: "",
|
|
1413
|
+
closed_at: closedAt,
|
|
1414
|
+
backfilled: true,
|
|
1415
|
+
};
|
|
1416
|
+
closedSummaries.push({ num: row.num, name: row.name, phases: phaseCount });
|
|
1417
|
+
|
|
1418
|
+
const existing = t.milestones.findIndex((mm) => mm && mm.num === row.num);
|
|
1419
|
+
if (existing >= 0) {
|
|
1420
|
+
// Don't override entries that came from real /qualia-milestone close
|
|
1421
|
+
// (they have richer data). Only overwrite previously-backfilled entries.
|
|
1422
|
+
if (t.milestones[existing].backfilled) {
|
|
1423
|
+
t.milestones[existing] = summary;
|
|
1424
|
+
updated++;
|
|
1425
|
+
}
|
|
1426
|
+
} else {
|
|
1427
|
+
t.milestones.push(summary);
|
|
1428
|
+
added++;
|
|
1429
|
+
}
|
|
1430
|
+
}
|
|
1431
|
+
|
|
1432
|
+
// Stable order by milestone number.
|
|
1433
|
+
t.milestones.sort((a, b) => (a.num || 0) - (b.num || 0));
|
|
1434
|
+
|
|
1435
|
+
const lastClosed = closed.length > 0 ? closed[closed.length - 1].num : 0;
|
|
1436
|
+
|
|
1437
|
+
// Math.max — never reduce lifetime counters. Preserves real /qualia-milestone
|
|
1438
|
+
// history if a project was partly closed properly and partly backfilled.
|
|
1439
|
+
t.lifetime.milestones_completed = Math.max(
|
|
1440
|
+
t.lifetime.milestones_completed || 0,
|
|
1441
|
+
closed.length
|
|
1442
|
+
);
|
|
1443
|
+
t.lifetime.last_closed_milestone = Math.max(
|
|
1444
|
+
t.lifetime.last_closed_milestone || 0,
|
|
1445
|
+
lastClosed
|
|
1446
|
+
);
|
|
1447
|
+
t.lifetime.total_phases = Math.max(
|
|
1448
|
+
t.lifetime.total_phases || 0,
|
|
1449
|
+
totalClosedPhases
|
|
1450
|
+
);
|
|
1451
|
+
|
|
1452
|
+
// Set current milestone — prefer the OPEN row; otherwise next-after-last-closed.
|
|
1453
|
+
if (openRow) {
|
|
1454
|
+
t.milestone = openRow.num;
|
|
1455
|
+
t.milestone_name = openRow.name;
|
|
1456
|
+
} else if (lastClosed > 0) {
|
|
1457
|
+
t.milestone = lastClosed + 1;
|
|
1458
|
+
t.milestone_name = readNextMilestoneNameFromJourney(t.milestone);
|
|
1459
|
+
}
|
|
1460
|
+
|
|
1461
|
+
t.last_updated = new Date().toISOString();
|
|
1462
|
+
writeTracking(t);
|
|
1463
|
+
|
|
1464
|
+
_trace("backfill-milestones", "allow", {
|
|
1465
|
+
added,
|
|
1466
|
+
updated,
|
|
1467
|
+
closed_count: closed.length,
|
|
1468
|
+
total_phases: totalClosedPhases,
|
|
1469
|
+
lifetime: t.lifetime,
|
|
1470
|
+
});
|
|
1471
|
+
|
|
1472
|
+
output({
|
|
1473
|
+
ok: true,
|
|
1474
|
+
action: "backfill-milestones",
|
|
1475
|
+
added,
|
|
1476
|
+
updated,
|
|
1477
|
+
closed: closedSummaries,
|
|
1478
|
+
open_milestone: openRow ? { num: openRow.num, name: openRow.name } : null,
|
|
1479
|
+
lifetime: t.lifetime,
|
|
1480
|
+
});
|
|
1481
|
+
}
|
|
1482
|
+
|
|
1270
1483
|
// ─── Next Report ID ──────────────────────────────────────
|
|
1271
1484
|
// Increments report_seq and returns the next QS-REPORT-NN id. Per-project
|
|
1272
1485
|
// counter (lives in tracking.json). /qualia-report calls this to tag each
|
|
@@ -1342,6 +1555,9 @@ try {
|
|
|
1342
1555
|
case "backfill-lifetime":
|
|
1343
1556
|
cmdBackfillLifetime(opts);
|
|
1344
1557
|
break;
|
|
1558
|
+
case "backfill-milestones":
|
|
1559
|
+
cmdBackfillMilestones(opts);
|
|
1560
|
+
break;
|
|
1345
1561
|
case "next-report-id":
|
|
1346
1562
|
cmdNextReportId(opts);
|
|
1347
1563
|
break;
|
|
@@ -1349,7 +1565,7 @@ try {
|
|
|
1349
1565
|
output(
|
|
1350
1566
|
fail(
|
|
1351
1567
|
"UNKNOWN_COMMAND",
|
|
1352
|
-
`Usage: state.js <check|transition|init|fix|validate-plan|close-milestone|backfill-lifetime|next-report-id> [--options]`
|
|
1568
|
+
`Usage: state.js <check|transition|init|fix|validate-plan|close-milestone|backfill-lifetime|backfill-milestones|next-report-id> [--options]`
|
|
1353
1569
|
)
|
|
1354
1570
|
);
|
|
1355
1571
|
}
|
package/docs/erp-contract.md
CHANGED
|
@@ -200,6 +200,11 @@ Authorization: Bearer <api-key>
|
|
|
200
200
|
external callers. Internal idempotent UPSERT on `(project_id,
|
|
201
201
|
client_report_id)` retries is the one exception (see "Idempotent UPSERT
|
|
202
202
|
on retry" above).
|
|
203
|
+
- The ERP resolves each report to a canonical internal project when possible.
|
|
204
|
+
Repository URL is the strongest signal, followed by repo/project slug, then
|
|
205
|
+
configured aliases, then the human report project name. This keeps legacy
|
|
206
|
+
repo/report names like `USD-Academy` or `USD-ACVADEMY` correctly linked to
|
|
207
|
+
ERP project names like `Underdog-Sales-Academy`.
|
|
203
208
|
- **`dry_run` retention (v4.0.4+):** The ERP deletes rows where
|
|
204
209
|
`dry_run = true AND submitted_at < now() - 7 days` via a daily cron at
|
|
205
210
|
03:00 UTC. Production report views (list, project tree, email digests)
|
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
# Qualia Framework — Install Redesign (v5.1.0 candidate)
|
|
2
|
+
## Builder Agent Prompt
|
|
3
|
+
|
|
4
|
+
**Hand this entire file to a fresh Claude Code session.** Self-contained — no context from the originating session is needed. Same pattern as `docs/playwright-loop-builder-prompt.md` which produced v5.0's polish-loop work.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## What you are building
|
|
9
|
+
|
|
10
|
+
A redesigned installer for the Qualia Framework that:
|
|
11
|
+
|
|
12
|
+
1. **Asks the user where to install** — Claude Code (`~/.claude/`), OpenAI Codex (`~/.codex/`), or both — and adapts the install per target
|
|
13
|
+
2. **Shows real-time visual progress** during the install — what file is being read, what's being copied, what's being configured — not silent then suddenly done
|
|
14
|
+
3. **Has top-notch cosmetics** throughout — every line of output is intentional and beautiful
|
|
15
|
+
|
|
16
|
+
The current installer (`bin/install.js`, ~830 lines) is functional but minimal. It copies files in batches and prints section headers ("Skills", "Templates", "Hooks") with terse `✓ {name}` lines. Fawzi wants the install to FEEL like a polished product — like the framework is announcing itself with care, not just dumping files.
|
|
17
|
+
|
|
18
|
+
## Why this matters
|
|
19
|
+
|
|
20
|
+
- **First impression is the install.** Every Qualia user (Fawzi, Hasan, Moayad, Rama, Sally, future hires) experiences the framework first through `npx qualia-framework install`. A boring install signals a boring framework.
|
|
21
|
+
- **Cross-tool reach.** v5.0.0 already produces `AGENTS.md` (the cross-vendor open standard adopted by Codex, Cursor, Aider, Continue). Codex users could already use the framework today — they just don't know it because the installer only writes to `~/.claude/`. Multi-target makes that explicit.
|
|
22
|
+
- **Visual feedback is trust.** When the installer is silent for 5 seconds while it copies 32 skills + 12 hooks + 24 templates, the user wonders if it hung. Live progress makes the framework feel alive.
|
|
23
|
+
|
|
24
|
+
## The repository you're working in
|
|
25
|
+
|
|
26
|
+
`/home/qualia-new/qualia-framework` — the Qualia Framework npm package, currently at v5.0.0 on branch `feat/env-empty-guard` (locally, not yet pushed). 274 tests pass. v5.0.0 release is queued for tomorrow morning publish to npm.
|
|
27
|
+
|
|
28
|
+
**Your work goes ON TOP of v5.0.0, as v5.1.0.** You'll bump version, add CHANGELOG entry, modify `bin/install.js`, possibly add `bin/install-cosmetics.js` helper, update tests.
|
|
29
|
+
|
|
30
|
+
## Files to study before writing code
|
|
31
|
+
|
|
32
|
+
1. `/home/qualia-new/qualia-framework/bin/install.js` — the current installer (~830 lines). Read it fully to understand the install phases (cleanup → CLAUDE.md/AGENTS.md → skills → agents → rules → hooks → settings.json → MCP → templates → knowledge layer → bin scripts → ERP config → final banner).
|
|
33
|
+
2. `/home/qualia-new/qualia-framework/bin/qualia-ui.js` — the existing cosmetics helper (banners, dividers, end-cards, status). Reuse and extend; don't duplicate.
|
|
34
|
+
3. `/home/qualia-new/qualia-framework/CLAUDE.md` and `AGENTS.md` — to understand what gets templated with `{{ROLE}}` for each install target
|
|
35
|
+
4. `/home/qualia-new/qualia-framework/CHANGELOG.md` v5.0.0 entry — to match the writing style for v5.1.0
|
|
36
|
+
5. `/home/qualia-new/qualia-framework/tests/bin.test.sh` — the install test patterns (lines ~440 onward have the install assertions you'll mirror)
|
|
37
|
+
|
|
38
|
+
## The 3 deliverables
|
|
39
|
+
|
|
40
|
+
### Deliverable 1 — Multi-target install (Claude Code / Codex / Both)
|
|
41
|
+
|
|
42
|
+
**Behavior:**
|
|
43
|
+
|
|
44
|
+
After the user enters their team code (existing flow), the installer asks:
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
Where would you like to install Qualia?
|
|
48
|
+
|
|
49
|
+
[1] Claude Code only (recommended — full feature set)
|
|
50
|
+
[2] OpenAI Codex only (AGENTS.md + project-level rules)
|
|
51
|
+
[3] Both (max compatibility)
|
|
52
|
+
|
|
53
|
+
Choice [1]:
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Default is `1` (Claude Code only) for backward-compat. The user types `1`/`2`/`3` and Enter.
|
|
57
|
+
|
|
58
|
+
**Per-target install paths:**
|
|
59
|
+
|
|
60
|
+
| Target | Directory | What gets installed |
|
|
61
|
+
|---|---|---|
|
|
62
|
+
| Claude Code | `~/.claude/` | Everything as today (skills/, agents/, hooks/, rules/, qualia-templates/, knowledge/, settings.json, CLAUDE.md, AGENTS.md, bin/, .qualia-config.json) |
|
|
63
|
+
| Codex | `~/.codex/` (or wherever Codex config lives — research this) | A subset that Codex actually uses: `AGENTS.md` (the framework conventions), `instructions.md` if Codex uses one, possibly mirrored skills/ and templates/ if Codex's runtime supports skills (research this — it might not; in that case skip those) |
|
|
64
|
+
| Both | both directories | Run the Claude Code install first, then the Codex install |
|
|
65
|
+
|
|
66
|
+
**Critical research step you MUST do FIRST:**
|
|
67
|
+
|
|
68
|
+
Use `WebFetch` or `Bash` to research Codex CLI's actual configuration layout:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# Check if user has codex installed
|
|
72
|
+
which codex 2>/dev/null
|
|
73
|
+
codex --version 2>/dev/null
|
|
74
|
+
|
|
75
|
+
# Look for documented config paths
|
|
76
|
+
ls ~/.codex/ 2>/dev/null
|
|
77
|
+
ls ~/.config/codex/ 2>/dev/null
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Search for: "OpenAI Codex CLI configuration directory", "Codex AGENTS.md", "Codex skills system" (if any).
|
|
81
|
+
|
|
82
|
+
If Codex CLI is too thin to support a meaningful framework install (e.g., it only reads AGENTS.md and that's it), say so explicitly in your output — don't pretend to install more than makes sense. Write a clear note in the CHANGELOG entry: "Codex install writes AGENTS.md only — Codex's runtime does not currently support skills/hooks/agents on disk."
|
|
83
|
+
|
|
84
|
+
**If Codex is not installed locally:**
|
|
85
|
+
|
|
86
|
+
Don't crash. Show a soft warning:
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
⚠ Codex CLI not detected on this system.
|
|
90
|
+
Installing AGENTS.md to ~/.codex/AGENTS.md anyway — Codex will pick it up
|
|
91
|
+
when you install via `npm install -g @openai/codex`.
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Then proceed with the Codex-side install (just the file writes).
|
|
95
|
+
|
|
96
|
+
### Deliverable 2 — Real-time visual progress
|
|
97
|
+
|
|
98
|
+
**Current installer:** prints section headers, then a batch of `✓ {name}` lines all at once when each section completes. Looks like nothing → nothing → blast of green checkmarks.
|
|
99
|
+
|
|
100
|
+
**Redesigned installer:** every meaningful operation prints a "doing" line before, then updates to "done" after. Like a live activity log.
|
|
101
|
+
|
|
102
|
+
**Pattern (use Unicode box-drawing for the progression):**
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
▸ Skills (32)
|
|
106
|
+
─────────────────────────────────────────
|
|
107
|
+
⏳ Reading skills/ from framework...
|
|
108
|
+
✓ Reading skills/ from framework
|
|
109
|
+
⏳ Copying qualia-build...
|
|
110
|
+
✓ qualia-build (3 files)
|
|
111
|
+
⏳ Copying qualia-discuss...
|
|
112
|
+
✓ qualia-discuss (1 file)
|
|
113
|
+
⏳ Copying qualia-issues...
|
|
114
|
+
✓ qualia-issues (1 file)
|
|
115
|
+
...
|
|
116
|
+
✓ Skills installed (32 total)
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Use ANSI escape sequences to OVERWRITE the `⏳` line with the `✓` line in place (cursor-up + clear-line) — so the output reads as a steadily-completing list, not a doubled set of lines.
|
|
120
|
+
|
|
121
|
+
**For long ops (template recursive copy, knowledge layer init, settings.json merge):**
|
|
122
|
+
|
|
123
|
+
Show a spinner that ticks every 100ms:
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
⠋ Merging settings.json (preserving 14 user keys)
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Implement as a tiny helper `startSpinner(text)` returning `stop({ status: "ok" | "warn" | "error", message?: string })`. Don't pull in `ora` or any external dep — write ~30 lines of vanilla Node using `process.stdout.write` + an interval.
|
|
130
|
+
|
|
131
|
+
**For each skill/agent/hook/rule/template copied:**
|
|
132
|
+
|
|
133
|
+
The current `ok({name})` print becomes a 2-line lifecycle:
|
|
134
|
+
|
|
135
|
+
1. Before copy: `⏳ {name}` (dim, with a working glyph)
|
|
136
|
+
2. After copy: `✓ {name}` (green, replacing the line above)
|
|
137
|
+
|
|
138
|
+
For very fast ops (single file, < 50ms) you can skip the "doing" state and go straight to ✓.
|
|
139
|
+
|
|
140
|
+
**Enhancements to existing `bin/qualia-ui.js`:**
|
|
141
|
+
|
|
142
|
+
Add these new helpers and export them:
|
|
143
|
+
|
|
144
|
+
- `spinner(text)` → `{ stop(result) }` — animated spinner with cursor-hide/show
|
|
145
|
+
- `step(text)` → returns a step-handle with `.ok(suffix?)`, `.warn(msg)`, `.fail(msg)` that overwrite the line
|
|
146
|
+
- `progress(current, total, label)` — render a bar like `[████████░░] 8/10 — Skills`
|
|
147
|
+
- `divider(width)` — variable-width dim divider
|
|
148
|
+
- `box({title, lines, color})` — boxed section like the welcome banner
|
|
149
|
+
- `kv(label, value, options?)` — left-padded label, right-aligned value, dim/highlight options
|
|
150
|
+
|
|
151
|
+
Preserve all existing `qualia-ui.js` exports — additive only.
|
|
152
|
+
|
|
153
|
+
### Deliverable 3 — Top-notch cosmetics throughout
|
|
154
|
+
|
|
155
|
+
The full install output, end-to-end, should feel like a single intentional document. Specific things to fix:
|
|
156
|
+
|
|
157
|
+
**The current install banner** (the welcome card at the top with `⬢ Q U A L I A`) is good. Keep its bones, but consider:
|
|
158
|
+
- Subtle 2-color gradient on the title (teal → cyan) using truecolor escape
|
|
159
|
+
- A breath of vertical space (one blank line above and below)
|
|
160
|
+
- Version + framework subtitle aligned right of the hex glyph
|
|
161
|
+
|
|
162
|
+
**Section separators** between phases (Skills, Agents, Rules, Hooks, Templates, etc.):
|
|
163
|
+
- Currently: bold teal triangle + section name + dim divider
|
|
164
|
+
- Upgrade: add a 2-letter status indicator at the right margin showing pass count, like `▸ Skills 32 ✓`
|
|
165
|
+
- After each section completes, show a one-line "section summary" with the count and elapsed time: ` └─ 32 skills · 0.3s`
|
|
166
|
+
|
|
167
|
+
**Final summary card** (the "INSTALLED" banner at the end):
|
|
168
|
+
- Currently: name + role + version + 7 metric kv lines + Quick Start
|
|
169
|
+
- Upgrade: add a "Targets" row showing where you installed (`Claude Code · Codex · Both`)
|
|
170
|
+
- Add a "Time" row showing total install duration
|
|
171
|
+
- Add a contextual "First command to try" line based on whether the user has a `.planning/` already (suggest `/qualia` if they do, `/qualia-new` if not)
|
|
172
|
+
|
|
173
|
+
**Color palette discipline:**
|
|
174
|
+
- Match the existing OKLCH-tinted neutrals in `bin/qualia-ui.js`
|
|
175
|
+
- Don't introduce new colors — extend the existing teal/green/dim/white system
|
|
176
|
+
- Errors stay red (#ef4444), warns stay yellow (#eab308) — don't change these (muscle memory)
|
|
177
|
+
|
|
178
|
+
**Glyph rules:**
|
|
179
|
+
- ⬢ = brand mark, only for the welcome banner and final card
|
|
180
|
+
- ▸ = section header
|
|
181
|
+
- ✓ = success
|
|
182
|
+
- ⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏ = spinner frames (Braille pattern dots)
|
|
183
|
+
- ⏳ = pending/in-flight
|
|
184
|
+
- ⚠ = warning
|
|
185
|
+
- ✗ = error
|
|
186
|
+
- └─ = section close
|
|
187
|
+
- · = inline separator
|
|
188
|
+
|
|
189
|
+
Don't introduce other glyphs without strong reason.
|
|
190
|
+
|
|
191
|
+
## Hard constraints (non-negotiable)
|
|
192
|
+
|
|
193
|
+
1. **Backward compatibility.** A user typing only their team code with no target choice (legacy stdin pipe `echo "QS-FAWZI-01" | npx qualia-framework install`) MUST still work — default to Claude Code only. Don't break the existing `bin.test.sh` install assertions.
|
|
194
|
+
|
|
195
|
+
2. **No new external dependencies.** No `ora`, no `chalk`, no `ink`. Vanilla Node + ANSI escapes. The current installer is dependency-free; preserve that.
|
|
196
|
+
|
|
197
|
+
3. **Cross-platform (Windows + macOS + Linux).** ANSI escapes work on modern Windows 10+ but verify the spinner doesn't break on `cmd.exe`. If `process.stdout.isTTY` is false (piped install), degrade gracefully — print plain `→ {name}` and `✓ {name}` lines instead of overwriting.
|
|
198
|
+
|
|
199
|
+
4. **Atomic writes for new target paths.** When installing to `~/.codex/`, follow the same atomic-write (tmp + rename) pattern that v5.0 added for `settings.json` and CLAUDE.md.
|
|
200
|
+
|
|
201
|
+
5. **Backups before overwrite** — same as v5.0's CLAUDE.md/settings.json discipline. If `~/.codex/AGENTS.md` exists with a different content hash than what we'd write, back it up to `~/.codex/AGENTS.md.bak.{ISO-timestamp}` before overwriting.
|
|
202
|
+
|
|
203
|
+
6. **No surprise side effects.** Installing to Codex doesn't auto-install Codex CLI itself. If it's not present, write the files and tell the user to install Codex separately.
|
|
204
|
+
|
|
205
|
+
7. **Slop-detect clean.** Run `node bin/slop-detect.mjs` on every modified `.md` file. The CHANGELOG and any new docs you write must pass.
|
|
206
|
+
|
|
207
|
+
8. **Tests pass.** All 274 existing tests must continue to pass. Add new tests for: target selection (1/2/3 input), Codex install path creation, AGENTS.md backup-before-overwrite, spinner degradation when non-TTY, multi-target ("Both") flow.
|
|
208
|
+
|
|
209
|
+
## Deliverables (the DONE definition)
|
|
210
|
+
|
|
211
|
+
Return DONE only when all of these are true:
|
|
212
|
+
|
|
213
|
+
1. ✅ `bin/install.js` modified to ask the install-target question after the team code prompt
|
|
214
|
+
2. ✅ Codex-target install actually writes to `~/.codex/` (or whatever the research found is correct)
|
|
215
|
+
3. ✅ All file copies have a "before/after" 2-line lifecycle (or single-line for sub-50ms ops)
|
|
216
|
+
4. ✅ `bin/qualia-ui.js` extended with `spinner()`, `step()`, `progress()`, `box()`, `kv()` helpers
|
|
217
|
+
5. ✅ Final summary card shows install targets, total time, and contextual first-command suggestion
|
|
218
|
+
6. ✅ TTY-degraded mode works (test: `echo QS-FAWZI-01 | node bin/install.js > /tmp/log.txt`; the log should be readable, no orphaned escape codes)
|
|
219
|
+
7. ✅ Backups for existing AGENTS.md / instructions.md in Codex target dir
|
|
220
|
+
8. ✅ All 274 v5.0 tests still pass + at least 5 new tests for v5.1 multi-target
|
|
221
|
+
9. ✅ `node bin/slop-detect.mjs` clean on all modified .md files
|
|
222
|
+
10. ✅ `package.json` bumped to 5.1.0
|
|
223
|
+
11. ✅ CHANGELOG.md has a v5.1.0 entry with the same writing style as the v5.0.0 entry, including:
|
|
224
|
+
- The "why this matters" framing (first impression, cross-tool reach, visual trust)
|
|
225
|
+
- The 3 deliverables
|
|
226
|
+
- The Codex install scope (whatever the research determined)
|
|
227
|
+
- Honest caveats (what doesn't work, what's deferred)
|
|
228
|
+
12. ✅ `docs/install-redesign-pilot.md` documenting:
|
|
229
|
+
- The full install output captured for each target choice (1, 2, 3)
|
|
230
|
+
- Screenshots or terminal-recording converted to ANSI text
|
|
231
|
+
- Timing measurements
|
|
232
|
+
- Any TTY-degradation issues found
|
|
233
|
+
|
|
234
|
+
## Self-test scenarios (run all 3 before declaring DONE)
|
|
235
|
+
|
|
236
|
+
**Scenario 1 — Claude Code only.**
|
|
237
|
+
```bash
|
|
238
|
+
TMP=$(mktemp -d)
|
|
239
|
+
echo -e "QS-FAWZI-01\n1\n" | HOME="$TMP" node bin/install.js > "$TMP/log.txt" 2>&1
|
|
240
|
+
```
|
|
241
|
+
- Verify: `~/.claude/` populated as today. `~/.codex/` does not exist or is empty.
|
|
242
|
+
- Verify: `$TMP/log.txt` shows the new visual progress (every section has live updates).
|
|
243
|
+
- Verify: total install time is ≤ 2× the current install time (live updates shouldn't more than double cost).
|
|
244
|
+
|
|
245
|
+
**Scenario 2 — Codex only.**
|
|
246
|
+
```bash
|
|
247
|
+
TMP=$(mktemp -d)
|
|
248
|
+
echo -e "QS-FAWZI-01\n2\n" | HOME="$TMP" node bin/install.js > "$TMP/log.txt" 2>&1
|
|
249
|
+
```
|
|
250
|
+
- Verify: `~/.codex/AGENTS.md` exists with `Role: OWNER` substituted.
|
|
251
|
+
- Verify: `~/.claude/` is NOT populated (we picked target 2 only).
|
|
252
|
+
- Verify: log shows "Codex CLI not detected — file written anyway" if `which codex` fails.
|
|
253
|
+
|
|
254
|
+
**Scenario 3 — Both.**
|
|
255
|
+
```bash
|
|
256
|
+
TMP=$(mktemp -d)
|
|
257
|
+
echo -e "QS-FAWZI-01\n3\n" | HOME="$TMP" node bin/install.js > "$TMP/log.txt" 2>&1
|
|
258
|
+
```
|
|
259
|
+
- Verify: both `~/.claude/` and `~/.codex/` populated correctly.
|
|
260
|
+
- Verify: final summary card shows "Targets: Claude Code · Codex".
|
|
261
|
+
|
|
262
|
+
## Things you MUST NOT do
|
|
263
|
+
|
|
264
|
+
- Don't change the team-code prompt itself (existing format works, has tests, don't break them).
|
|
265
|
+
- Don't add interactive yes/no prompts beyond the target-selection question — the install should still complete via stdin pipe with no extra input needed.
|
|
266
|
+
- Don't change `~/.claude/` install behavior beyond cosmetics. The semantic install logic (which files go where) stays exactly as v5.0.
|
|
267
|
+
- Don't wire Codex to any external API or auto-install. File copies only.
|
|
268
|
+
- Don't bump major version (still 5.x). This is a minor (5.1.0).
|
|
269
|
+
- Don't break the ERP API key save/load flow — `~/.claude/.erp-api-key` stays where it is.
|
|
270
|
+
- Don't drop the EXPERIMENTAL Playwright caveat in the v5.0.0 CHANGELOG — preserve it as historical context.
|
|
271
|
+
|
|
272
|
+
## Reference: where v5.0's similar work happened
|
|
273
|
+
|
|
274
|
+
Look at how the polish-loop builder agent (commit `907312c`) handled a similar scope — building a flagship feature with self-tests, CHANGELOG, install assertions. Match its discipline:
|
|
275
|
+
- Per-iteration commits during pilot scenarios (`qpl-N:` prefix style — yours could be `install-redesign-N:`)
|
|
276
|
+
- Honest caveats in CHANGELOG (don't oversell)
|
|
277
|
+
- Pilot results doc with concrete measurements
|
|
278
|
+
- Trust-boundary comment in any new agent role file (none expected here, but if you create one, copy the pattern from `agents/builder.md` lines 11-17)
|
|
279
|
+
|
|
280
|
+
## When you encounter unknowns
|
|
281
|
+
|
|
282
|
+
- **Codex config layout** — the most likely unknown. If web search + local probing don't give a clear answer, write the simplest version (just `~/.codex/AGENTS.md`) and document it explicitly: "Codex install scope: AGENTS.md only. If Codex's runtime later supports skills/hooks on disk, the framework can extend this."
|
|
283
|
+
- **TTY degradation edge cases** — if cmd.exe on Windows has issues, document and gate the spinner behind `process.platform !== "win32"` for the spinner specifically. The 2-line copy/✓ pattern should work everywhere.
|
|
284
|
+
- **Existing install test breakage** — if you can't avoid breaking a test, the test was overspecified. Update the test, but document WHY in the commit message.
|
|
285
|
+
|
|
286
|
+
## One last thing
|
|
287
|
+
|
|
288
|
+
Fawzi (the framework owner, OWNER role) will read your output as the FIRST install he runs. He's tired tonight and trusting you to deliver. Honest reporting beats good-news theater. If something doesn't work cleanly, mark it experimental and say so — same discipline as the polish-loop EXPERIMENTAL Playwright caveat.
|
|
289
|
+
|
|
290
|
+
When you finish, write your DONE report at `docs/install-redesign-pilot.md` (file already mentioned above) and return a tight summary: targets working, lines of code added/changed, test count, slop-detect status, any BLOCKED items.
|