yam-harness 0.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 +18 -0
- package/COMMANDS.md +144 -0
- package/DECISIONS.md +70 -0
- package/LICENSE +21 -0
- package/README.md +159 -0
- package/ROADMAP.md +308 -0
- package/bin/yam.js +1966 -0
- package/package.json +74 -0
- package/references/context-reuse.md +59 -0
- package/references/current-docs.md +45 -0
- package/references/db-supabase-safety-lite.md +40 -0
- package/references/doctor-scan.md +56 -0
- package/references/eye.md +30 -0
- package/references/final-report.md +61 -0
- package/references/honest-completion.md +61 -0
- package/references/hook-lite.md +55 -0
- package/references/markdown-management.md +56 -0
- package/references/memory.md +59 -0
- package/references/mission.md +86 -0
- package/references/question.md +25 -0
- package/references/quick.md +70 -0
- package/references/risk-escalation.md +27 -0
- package/references/runtime-orchestration.md +57 -0
- package/references/scout.md +38 -0
- package/references/token-budget-reporter.md +44 -0
- package/references/token-economy.md +61 -0
- package/references/tool-trust-layer.md +113 -0
- package/references/truth-matrix.md +44 -0
- package/references/ueye.md +83 -0
- package/references/ui-quality.md +23 -0
- package/references/verification-levels.md +53 -0
- package/skills/deep/SKILL.md +76 -0
- package/skills/mission/SKILL.md +105 -0
- package/skills/question/SKILL.md +45 -0
- package/skills/quick/SKILL.md +81 -0
- package/skills/scout/SKILL.md +71 -0
- package/skills/ueye/SKILL.md +90 -0
- package/templates/mission-plan.md +46 -0
- package/templates/runtime-proof.md +54 -0
- package/templates/tuning-log.md +39 -0
- package/templates/ueye-review.md +62 -0
- package/templates/yam.project.md +71 -0
- package/yam.manifest.json +48 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Question
|
|
2
|
+
|
|
3
|
+
`question` is the smallest yam route: direct Q&A without implementation, broad research, or proof loops.
|
|
4
|
+
|
|
5
|
+
Use it when:
|
|
6
|
+
|
|
7
|
+
- The user asks a simple explanation question.
|
|
8
|
+
- The answer can be given from stable knowledge or current conversation context.
|
|
9
|
+
- A local fact can be checked with one narrow file/command.
|
|
10
|
+
- The user wants a quick answer, not a decision memo.
|
|
11
|
+
|
|
12
|
+
Default behavior:
|
|
13
|
+
|
|
14
|
+
- Answer first.
|
|
15
|
+
- Keep the answer compact.
|
|
16
|
+
- Do not change files.
|
|
17
|
+
- Do not turn the answer into research unless freshness or uncertainty requires it.
|
|
18
|
+
- If comparison, market context, external references, or third-party judgment are needed, switch to `scout`.
|
|
19
|
+
|
|
20
|
+
Useful output shape:
|
|
21
|
+
|
|
22
|
+
- Direct answer.
|
|
23
|
+
- Why.
|
|
24
|
+
- Practical next step.
|
|
25
|
+
- Uncertainty, only when relevant.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Quick
|
|
2
|
+
|
|
3
|
+
`quick` is the merged small-work route: fast patching, ordinary scoped implementation, and fast error scanning.
|
|
4
|
+
|
|
5
|
+
## Borrowed, With Weight Removed
|
|
6
|
+
|
|
7
|
+
From Sneakoscope:
|
|
8
|
+
|
|
9
|
+
- Honest completion language.
|
|
10
|
+
- Real versus assumed verification.
|
|
11
|
+
- Stop instead of claiming success when evidence is missing.
|
|
12
|
+
|
|
13
|
+
From ECC:
|
|
14
|
+
|
|
15
|
+
- Detect the smallest useful command.
|
|
16
|
+
- Group build/type/lint/test errors by file and root cause.
|
|
17
|
+
- Fix one error class at a time.
|
|
18
|
+
- Re-run the same focused command after a fix.
|
|
19
|
+
- Use a compact PASS/FAIL matrix.
|
|
20
|
+
|
|
21
|
+
From Karpathy-style minimal harness:
|
|
22
|
+
|
|
23
|
+
- Keep the instruction short enough to obey.
|
|
24
|
+
- Read the smallest useful context.
|
|
25
|
+
- Avoid ceremony unless it changes the result.
|
|
26
|
+
|
|
27
|
+
## Lanes
|
|
28
|
+
|
|
29
|
+
Patch:
|
|
30
|
+
|
|
31
|
+
- Best for copy, CSS, labels, simple bugs, small docs, and small config changes.
|
|
32
|
+
- Usually read 1-3 files.
|
|
33
|
+
- Usually run 0-1 command.
|
|
34
|
+
|
|
35
|
+
Build-fix:
|
|
36
|
+
|
|
37
|
+
- Best when there is a concrete command failure.
|
|
38
|
+
- Read the error output first.
|
|
39
|
+
- Sort dependency/import/type errors before logic errors.
|
|
40
|
+
- Fix one root cause before moving to the next.
|
|
41
|
+
|
|
42
|
+
Scan:
|
|
43
|
+
|
|
44
|
+
- Best when the user wants to know what is broken before editing.
|
|
45
|
+
- Report grouped errors, likely root cause, smallest first fix, and verification command.
|
|
46
|
+
- If the scan sees destructive DB/Supabase, migration, production write, or RLS/policy signals, stop quick mode and recommend `$deep`.
|
|
47
|
+
|
|
48
|
+
## Stop Conditions
|
|
49
|
+
|
|
50
|
+
Stop or recommend a heavier route when:
|
|
51
|
+
|
|
52
|
+
- The same error survives three focused attempts.
|
|
53
|
+
- A fix creates more errors than it removes.
|
|
54
|
+
- The change requires a new dependency, architecture change, or broad refactor.
|
|
55
|
+
- The surface touches auth, payments, data mutation, security, deployment, or process lifecycle.
|
|
56
|
+
- The requested work needs visual reference interpretation or screenshot-led QA.
|
|
57
|
+
|
|
58
|
+
## Verification Matrix
|
|
59
|
+
|
|
60
|
+
Use this compact shape when commands were run:
|
|
61
|
+
|
|
62
|
+
```text
|
|
63
|
+
Verification:
|
|
64
|
+
- typecheck: pass/fail/skipped
|
|
65
|
+
- lint: pass/fail/skipped
|
|
66
|
+
- test: pass/fail/skipped
|
|
67
|
+
- build: pass/fail/skipped
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Only include rows that matter to the actual run.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Risk Escalation
|
|
2
|
+
|
|
3
|
+
Escalate by recommendation, not silent mode switching.
|
|
4
|
+
|
|
5
|
+
Recommend `$deep` when work touches:
|
|
6
|
+
|
|
7
|
+
- DB schema or data mutation.
|
|
8
|
+
- Supabase destructive commands, migrations, production writes, RLS, or policy changes.
|
|
9
|
+
- Auth, payment, billing, permissions.
|
|
10
|
+
- Security-sensitive code.
|
|
11
|
+
- Deployment or release configuration.
|
|
12
|
+
- Broad refactor or many files.
|
|
13
|
+
- Failing verification.
|
|
14
|
+
- Unknown ownership or unclear acceptance criteria.
|
|
15
|
+
- Long-running process lifecycle.
|
|
16
|
+
|
|
17
|
+
Recommend `$mission` only when the user has an approved plan and real subagent/team execution would materially reduce risk.
|
|
18
|
+
|
|
19
|
+
Suggested phrase:
|
|
20
|
+
|
|
21
|
+
```text
|
|
22
|
+
This looks like a deeper route because it touches <risk>.
|
|
23
|
+
I can continue lightly, or switch to $deep for stronger single-agent verification.
|
|
24
|
+
Use $mission only if you want real subagent/team execution.
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Use `db-supabase-safety-lite.md` for the short DB/Supabase guardrail.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Runtime Verification
|
|
2
|
+
|
|
3
|
+
Runtime verification now lives inside `$deep` and may be used by `$mission`.
|
|
4
|
+
|
|
5
|
+
It combines tmux/process management, cleanup confirmation, browser QA, and proof summary when a verification claim needs runtime evidence.
|
|
6
|
+
|
|
7
|
+
Use for:
|
|
8
|
+
|
|
9
|
+
- Long-running dev servers.
|
|
10
|
+
- Test watchers.
|
|
11
|
+
- Multi-step broad tasks.
|
|
12
|
+
- Browser QA sessions.
|
|
13
|
+
- Work requiring before/after evidence.
|
|
14
|
+
|
|
15
|
+
Do not use for ordinary small edits.
|
|
16
|
+
|
|
17
|
+
## tmux Policy
|
|
18
|
+
|
|
19
|
+
tmux is a first-class runtime verification tool in `yam`, but it is not automatic.
|
|
20
|
+
|
|
21
|
+
Use tmux when it improves the work:
|
|
22
|
+
|
|
23
|
+
- Long-running dev servers.
|
|
24
|
+
- Test watchers.
|
|
25
|
+
- Multiple concurrent panes.
|
|
26
|
+
- Work where preserving logs or panes helps verification.
|
|
27
|
+
- Tasks that need a stable server while browser QA runs.
|
|
28
|
+
|
|
29
|
+
Do not use tmux just to make a small task look more verified.
|
|
30
|
+
|
|
31
|
+
When tmux is used, record:
|
|
32
|
+
|
|
33
|
+
- Session name.
|
|
34
|
+
- Pane id when available.
|
|
35
|
+
- Command running in the pane.
|
|
36
|
+
- Before/during/after observation.
|
|
37
|
+
- Whether the pane was left running intentionally or closed.
|
|
38
|
+
|
|
39
|
+
Runtime proof should include:
|
|
40
|
+
|
|
41
|
+
- Goal.
|
|
42
|
+
- Steps run.
|
|
43
|
+
- Commands/processes started.
|
|
44
|
+
- PIDs, ports, sessions, or panes when available.
|
|
45
|
+
- Checks before and after.
|
|
46
|
+
- Cleanup result.
|
|
47
|
+
- Truth status: proven, verified, partial, fixture_only, fixture_instrumented_real, integration_optional, real_required_missing, skipped, blocked, assumed.
|
|
48
|
+
|
|
49
|
+
## Cleanup Rule
|
|
50
|
+
|
|
51
|
+
Do not claim cleanup succeeded unless one of these is true:
|
|
52
|
+
|
|
53
|
+
- Process exit was checked.
|
|
54
|
+
- tmux pane/session was checked closed.
|
|
55
|
+
- The process was intentionally left running and reported that way.
|
|
56
|
+
|
|
57
|
+
For `$deep` runtime verification and `$mission`, cleanup evidence matters more than a polished final sentence.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Scout
|
|
2
|
+
|
|
3
|
+
`scout` is practical investigation and judgment, not academic research.
|
|
4
|
+
|
|
5
|
+
Use for:
|
|
6
|
+
|
|
7
|
+
- Current docs.
|
|
8
|
+
- Library or tool comparison.
|
|
9
|
+
- Design references.
|
|
10
|
+
- Product direction options.
|
|
11
|
+
- Risk discovery before implementation.
|
|
12
|
+
- Third-party judgment before implementation.
|
|
13
|
+
- Objective and subjective evaluation together.
|
|
14
|
+
- Macro, realistic, and future-facing direction checks.
|
|
15
|
+
|
|
16
|
+
Default behavior:
|
|
17
|
+
|
|
18
|
+
- Define the question narrowly.
|
|
19
|
+
- Prefer official or primary sources.
|
|
20
|
+
- Gather 3-7 high-signal references by default.
|
|
21
|
+
- Use current docs proof only for modern SDK/API/cloud-service behavior where stale knowledge is plausible.
|
|
22
|
+
- Summarize options and recommendation.
|
|
23
|
+
- Separate fact, inference, opinion, and recommendation.
|
|
24
|
+
- Do not change code unless the user asks.
|
|
25
|
+
|
|
26
|
+
Judgment format:
|
|
27
|
+
|
|
28
|
+
- Objective judgment: evidence, constraints, cost, feasibility, and known reality.
|
|
29
|
+
- Subjective judgment: taste, product instinct, design sensibility, and likely user perception.
|
|
30
|
+
- Macro view: category direction and broad movement.
|
|
31
|
+
- Realistic view: what can be done soon with the current project and skill level.
|
|
32
|
+
- Future view: second-order effects, durability, and what may age well or badly.
|
|
33
|
+
|
|
34
|
+
Escalate:
|
|
35
|
+
|
|
36
|
+
- Use `question` for direct answers that do not need sources.
|
|
37
|
+
- Use `deep` only when the user asks for heavy verification.
|
|
38
|
+
- Use implementation routes only after the user asks to change code.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Token Budget Reporter
|
|
2
|
+
|
|
3
|
+
`yam` tracks token pressure without hooks or automatic surveillance.
|
|
4
|
+
|
|
5
|
+
Use the CLI after a run when you want a quick budget check:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
yam measure quick --files 3 --commands 1 --report-lines 5 --seconds 40
|
|
9
|
+
yam measure ueye --files 7 --commands 2 --report-lines 18 --seconds 260
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Metrics
|
|
13
|
+
|
|
14
|
+
- `files`: files or large snippets intentionally read.
|
|
15
|
+
- `commands`: verification or inspection commands that materially shaped the answer.
|
|
16
|
+
- `report-lines`: approximate final answer length in rendered lines.
|
|
17
|
+
- `seconds`: rough elapsed working time.
|
|
18
|
+
|
|
19
|
+
## Meaning
|
|
20
|
+
|
|
21
|
+
`ok` means the run fit the route's intended weight.
|
|
22
|
+
|
|
23
|
+
`over budget` means the route may still be valid, but the next run should either narrow scope or intentionally choose a heavier route.
|
|
24
|
+
|
|
25
|
+
`no measurements` means no actuals were provided; use `yam budget <route>` for static limits.
|
|
26
|
+
|
|
27
|
+
## Route Policy
|
|
28
|
+
|
|
29
|
+
- `$quick`: should stay small. If it repeatedly exceeds budget, the request is probably `$deep` or `$mission`.
|
|
30
|
+
- `$ueye`: may use visual/browser checks and nearby design context, but should avoid broad design archaeology unless the user asked for design-heavy work.
|
|
31
|
+
- `$question`: should answer directly. If it needs sources or comparison, switch to `$scout`.
|
|
32
|
+
- `$scout`: may gather a bounded set of high-signal sources and should separate evidence from judgment.
|
|
33
|
+
- `$deep`: can exceed ordinary budgets, but the reason must be risk-tied; single-agent runtime/tmux/browser checks belong here when verification needs them.
|
|
34
|
+
- `$mission`: can spend more context on real subagent/team lanes, cross-verification, doctor scan, and runtime evidence, but only for approved plans where real subagents are used or explicitly unavailable/partial.
|
|
35
|
+
|
|
36
|
+
## Compared Baseline
|
|
37
|
+
|
|
38
|
+
Sneakoscope would favor stronger automatic evidence collection.
|
|
39
|
+
|
|
40
|
+
ECC would favor selective, low-context reporting.
|
|
41
|
+
|
|
42
|
+
Karpathy-style minimal harness would remove the measurement unless it changes behavior.
|
|
43
|
+
|
|
44
|
+
`yam` keeps manual measurement because it helps reduce over-reading without installing hooks.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Token Economy
|
|
2
|
+
|
|
3
|
+
Token economy is part of quality.
|
|
4
|
+
|
|
5
|
+
Default behavior:
|
|
6
|
+
|
|
7
|
+
- Read `yam.project.md` first when present.
|
|
8
|
+
- Start with the narrowest likely file set.
|
|
9
|
+
- Prefer `rg`, file names, and local snippets over broad reading.
|
|
10
|
+
- Read nearby patterns before reading whole modules.
|
|
11
|
+
- Summarize large files instead of loading full context when possible.
|
|
12
|
+
- Stop searching once the edit surface is clear.
|
|
13
|
+
- Do not open long docs or generated files unless they are directly needed.
|
|
14
|
+
- Treat `yam.project.md` as the reusable context source; inspect it with `yam pack` when it seems stale.
|
|
15
|
+
- Do not produce long reports for small work.
|
|
16
|
+
- Use `yam measure <route>` after real runs when budget drift needs tuning.
|
|
17
|
+
|
|
18
|
+
Suggested read budgets:
|
|
19
|
+
|
|
20
|
+
```text
|
|
21
|
+
quick
|
|
22
|
+
- Start with 1 to 3 files for patch work.
|
|
23
|
+
- Allow a small module or error surface only when the first hypothesis fails or the scan points wider.
|
|
24
|
+
- Prefer one focused command, two at most.
|
|
25
|
+
|
|
26
|
+
ueye
|
|
27
|
+
- Project direction, source screen, target component, nearby styles/tokens.
|
|
28
|
+
- Avoid full design-system archaeology for simple tweaks.
|
|
29
|
+
- Visual claims require source-screen evidence or a partial truth cap.
|
|
30
|
+
|
|
31
|
+
question
|
|
32
|
+
- 0 to 2 files.
|
|
33
|
+
- Prefer current conversation context and stable knowledge.
|
|
34
|
+
- Switch to scout when evidence, source freshness, or comparison matters.
|
|
35
|
+
|
|
36
|
+
scout
|
|
37
|
+
- 3 to 7 high-signal sources.
|
|
38
|
+
- Prefer official docs and primary sources.
|
|
39
|
+
|
|
40
|
+
deep
|
|
41
|
+
- Wider single-agent reading is allowed, but explain why.
|
|
42
|
+
- Runtime/tmux/browser context should be tied to verification evidence.
|
|
43
|
+
|
|
44
|
+
mission
|
|
45
|
+
- Wider reading is allowed only for approved real subagent/team execution.
|
|
46
|
+
- Runtime/tmux/browser context should be tied to mission evidence.
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Measured budgets:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
yam measure quick --files 3 --commands 1 --report-lines 5 --seconds 40
|
|
53
|
+
yam measure deep --files 18 --commands 4 --report-lines 32 --seconds 900
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Escalate reading only when:
|
|
57
|
+
|
|
58
|
+
- The first edit surface is wrong.
|
|
59
|
+
- Tests or runtime output contradict the hypothesis.
|
|
60
|
+
- Risk surface is broader than expected.
|
|
61
|
+
- The user asks for deeper analysis.
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
# Tool Trust Layer
|
|
2
|
+
|
|
3
|
+
`yam` should grow a proof-first trust layer, but not a proof-first cage.
|
|
4
|
+
|
|
5
|
+
The goal is to help a beginner start small and then move toward professional implementation with evidence, without making every step feel like a release gate.
|
|
6
|
+
This is not a lightweight-only direction. `yam-lite` is light; `yam` is progressive.
|
|
7
|
+
|
|
8
|
+
## Depth Ladder
|
|
9
|
+
|
|
10
|
+
Every route carries a basic contract:
|
|
11
|
+
|
|
12
|
+
- respect project direction before changing code
|
|
13
|
+
- use context packs or memory before broad re-reading
|
|
14
|
+
- verify only what was actually checked
|
|
15
|
+
- report remaining tasks and fix-first issues when useful
|
|
16
|
+
|
|
17
|
+
Then depth increases by route:
|
|
18
|
+
|
|
19
|
+
- `$question`: answer without unnecessary research.
|
|
20
|
+
- `$scout`: investigate and judge without implementation by default.
|
|
21
|
+
- `$quick`: implement quickly with focused verification.
|
|
22
|
+
- `$ueye`: implement/review UI with real visual evidence when feasible.
|
|
23
|
+
- `$deep`: prove risky single-agent work with stronger runtime/tool evidence.
|
|
24
|
+
- `$mission`: coordinate real subagents/team lanes with cross-verification.
|
|
25
|
+
|
|
26
|
+
## Surfaces To Wrap
|
|
27
|
+
|
|
28
|
+
- Codex CLI/App readiness.
|
|
29
|
+
- Browser and Computer Use availability.
|
|
30
|
+
- tmux and long-running process lifecycle.
|
|
31
|
+
- Subagent/team availability for `$mission`.
|
|
32
|
+
- imagegen or screenshot evidence for `$ueye`.
|
|
33
|
+
- Context7 or official docs for current package/API questions.
|
|
34
|
+
- codex-lb or provider routing health when configured.
|
|
35
|
+
- DB/Supabase safety for destructive or migration work.
|
|
36
|
+
- Research, QA, wiki/context, proof, and release-gate workflows.
|
|
37
|
+
|
|
38
|
+
## yam Policy
|
|
39
|
+
|
|
40
|
+
Default:
|
|
41
|
+
|
|
42
|
+
- No automatic trust gate.
|
|
43
|
+
- No automatic proof loop.
|
|
44
|
+
- No automatic tmux.
|
|
45
|
+
- No automatic subagents.
|
|
46
|
+
- No automatic external provider setup.
|
|
47
|
+
- Basic direction fit and honest verification boundaries still apply.
|
|
48
|
+
|
|
49
|
+
Advisory:
|
|
50
|
+
|
|
51
|
+
- `yam-lite` hook may suggest routes and warn about overclaiming.
|
|
52
|
+
- `yam pack` may warn about stale project direction, command drift, active hooks, or Sneakoscope surfaces.
|
|
53
|
+
|
|
54
|
+
On demand:
|
|
55
|
+
|
|
56
|
+
- `$quick`: smallest honest local verification.
|
|
57
|
+
- `$ueye`: visual evidence and truth caps.
|
|
58
|
+
- `$deep`: single-agent heavy proof, runtime/tmux/browser/process cleanup.
|
|
59
|
+
- `$mission`: real subagent/team execution with cross-verification.
|
|
60
|
+
- `yam tools doctor`: inspect tool readiness without changing project state.
|
|
61
|
+
- `yam proof`: summarize actual evidence without running verification.
|
|
62
|
+
|
|
63
|
+
## Borrow From Sneakoscope
|
|
64
|
+
|
|
65
|
+
- Tool readiness checks.
|
|
66
|
+
- Hook status and trust reporting.
|
|
67
|
+
- DB/Supabase destructive-operation gate thinking.
|
|
68
|
+
- Computer Use and screenshot evidence caps.
|
|
69
|
+
- tmux/process cleanup truth.
|
|
70
|
+
- Source-intelligence proof for current docs.
|
|
71
|
+
- Destructive DB/Supabase command detection and production-write caution.
|
|
72
|
+
- Feature/release inventory as an optional doctor, not a default gate.
|
|
73
|
+
|
|
74
|
+
## Borrow From ECC
|
|
75
|
+
|
|
76
|
+
- Selective install and profiles.
|
|
77
|
+
- Evidence boundaries.
|
|
78
|
+
- Low-context command detection.
|
|
79
|
+
- Optional orchestration instead of always-on orchestration.
|
|
80
|
+
|
|
81
|
+
## Borrow From Open Design
|
|
82
|
+
|
|
83
|
+
- Real preview/screenshot evidence.
|
|
84
|
+
- Compact design direction.
|
|
85
|
+
- P0 visual gates for design-heavy work.
|
|
86
|
+
|
|
87
|
+
## Reject
|
|
88
|
+
|
|
89
|
+
- Always-on Team route.
|
|
90
|
+
- Always-on hook enforcement.
|
|
91
|
+
- Release gates for normal coding.
|
|
92
|
+
- Mandatory generated image review for every UI task.
|
|
93
|
+
- Broad MCP/tool scans before small work.
|
|
94
|
+
- Provider config mutation without explicit user approval.
|
|
95
|
+
|
|
96
|
+
## Implemented Shape
|
|
97
|
+
|
|
98
|
+
`yam tools doctor` should be read-only by default:
|
|
99
|
+
|
|
100
|
+
- report installed/available tools
|
|
101
|
+
- report package scripts
|
|
102
|
+
- report hook conflicts
|
|
103
|
+
- report known high-risk surfaces
|
|
104
|
+
- suggest route and proof level
|
|
105
|
+
- do not install, configure, or mutate
|
|
106
|
+
|
|
107
|
+
`yam proof` should summarize what actually ran:
|
|
108
|
+
|
|
109
|
+
- command evidence
|
|
110
|
+
- browser/screenshot evidence
|
|
111
|
+
- runtime/tmux/process cleanup evidence
|
|
112
|
+
- truth status
|
|
113
|
+
- skipped/blocked/assumed items
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Truth Matrix
|
|
2
|
+
|
|
3
|
+
Use precise verification language.
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
verified
|
|
7
|
+
Actual command, browser check, screenshot, or test passed.
|
|
8
|
+
|
|
9
|
+
proven
|
|
10
|
+
Runtime-specific: physical or process evidence supports the claim, such as a live server response, browser check, tmux pane evidence, or verified process exit.
|
|
11
|
+
|
|
12
|
+
partial
|
|
13
|
+
Some meaningful checks passed, but not the full surface.
|
|
14
|
+
|
|
15
|
+
fixture_only
|
|
16
|
+
Fixture or mock evidence exists, but it cannot support a real runtime claim.
|
|
17
|
+
|
|
18
|
+
fixture_instrumented_real
|
|
19
|
+
A real backend or process was involved, but the run was shaped by fixture instrumentation. Do not report it as fully proven.
|
|
20
|
+
|
|
21
|
+
integration_optional
|
|
22
|
+
A live integration/runtime check was optional and not requested. This is not a failure, but it is not verified.
|
|
23
|
+
|
|
24
|
+
real_required_missing
|
|
25
|
+
The user or route required live runtime evidence, but that evidence was unavailable.
|
|
26
|
+
|
|
27
|
+
skipped
|
|
28
|
+
Verification intentionally skipped because the change is tiny or not runnable.
|
|
29
|
+
|
|
30
|
+
blocked
|
|
31
|
+
Verification could not run because of environment, tool, auth, network, or time limits.
|
|
32
|
+
|
|
33
|
+
assumed
|
|
34
|
+
Reasonable inference from code reading, but no execution evidence.
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Never say `verified` when the correct status is `partial`, `skipped`, `blocked`, or `assumed`.
|
|
38
|
+
|
|
39
|
+
Never say `proven` for runtime work unless the runtime evidence exists.
|
|
40
|
+
|
|
41
|
+
Never say full visual `verified` when the only evidence is a reference image, generated image, code reading, or text-only critique.
|
|
42
|
+
|
|
43
|
+
For ordinary routes, prefer `verified`, `partial`, `skipped`, `blocked`, or `assumed`.
|
|
44
|
+
For `$deep` runtime verification and `$mission`, use the more precise runtime statuses when they prevent overclaiming.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Ueye
|
|
2
|
+
|
|
3
|
+
`ueye` is the merged UI/design route: design-heavy implementation, screenshot-led UX review, and visual QA.
|
|
4
|
+
|
|
5
|
+
## Borrowed, With Weight Removed
|
|
6
|
+
|
|
7
|
+
From Sneakoscope image UX review:
|
|
8
|
+
|
|
9
|
+
- Source-screen inventory before visual claims.
|
|
10
|
+
- P0-P3 issue ledger.
|
|
11
|
+
- Fix P0/P1 first, then cheap local P2 issues.
|
|
12
|
+
- Recheck changed or high-risk screens after fixes when feasible.
|
|
13
|
+
- Cap text-only or missing-screenshot reviews as partial instead of fully verified.
|
|
14
|
+
|
|
15
|
+
Kept out from Sneakoscope by design:
|
|
16
|
+
|
|
17
|
+
- Mandatory generated annotated images.
|
|
18
|
+
- Image voxel ledgers.
|
|
19
|
+
- Release gates for every UI change.
|
|
20
|
+
- Always-on proof loops.
|
|
21
|
+
|
|
22
|
+
From Open Design:
|
|
23
|
+
|
|
24
|
+
- Real examples and previews matter more than abstract prose.
|
|
25
|
+
- Design direction should be compact and searchable.
|
|
26
|
+
- P0 gates should reject placeholder visuals, generic UI, and broken responsive states.
|
|
27
|
+
- UI work should be self-contained enough to inspect.
|
|
28
|
+
|
|
29
|
+
From ECC:
|
|
30
|
+
|
|
31
|
+
- Separate evidence from judgment.
|
|
32
|
+
- Keep review output compact.
|
|
33
|
+
- Escalate only when the risk justifies it.
|
|
34
|
+
|
|
35
|
+
## Source-Screen Inventory
|
|
36
|
+
|
|
37
|
+
Acceptable sources:
|
|
38
|
+
|
|
39
|
+
- User-provided screenshot.
|
|
40
|
+
- Browser screenshot from a local or remote URL.
|
|
41
|
+
- Exported static artifact image.
|
|
42
|
+
- Current screen when the browser tool can inspect it.
|
|
43
|
+
- Reference image, as direction evidence only.
|
|
44
|
+
- Generated annotated image, as derivative review aid only.
|
|
45
|
+
|
|
46
|
+
Record:
|
|
47
|
+
|
|
48
|
+
- Source type.
|
|
49
|
+
- Screen or URL.
|
|
50
|
+
- State: default, loading, error, empty, disabled, hover/focus, mobile, or unknown.
|
|
51
|
+
- Whether visual verification is full, partial, skipped, or blocked.
|
|
52
|
+
|
|
53
|
+
Bound:
|
|
54
|
+
|
|
55
|
+
- Inspect 1-3 primary images by default.
|
|
56
|
+
- Keep the source-screen inventory to the 5 most important rows by default.
|
|
57
|
+
- Generated callout images are optional and should usually be at most one per review pass.
|
|
58
|
+
- P0/P1 issues can expand the review; P2/P3 should stay top-few unless the user asks for a full polish pass.
|
|
59
|
+
|
|
60
|
+
## P0-P3 Ledger
|
|
61
|
+
|
|
62
|
+
- P0: blocker, unusable, impossible to complete primary workflow, severe accessibility or responsive failure.
|
|
63
|
+
- P1: major issue that strongly harms conversion, comprehension, trust, or task completion.
|
|
64
|
+
- P2: noticeable quality issue: spacing, alignment, hierarchy, contrast, density, state polish.
|
|
65
|
+
- P3: optional polish.
|
|
66
|
+
|
|
67
|
+
## Implementation Loop
|
|
68
|
+
|
|
69
|
+
1. Direction fit.
|
|
70
|
+
2. Source-screen inventory.
|
|
71
|
+
3. Nearby pattern and token scan.
|
|
72
|
+
4. Implementation.
|
|
73
|
+
5. Screenshot/browser recheck when feasible.
|
|
74
|
+
6. P0/P1 closeout.
|
|
75
|
+
7. Truth status.
|
|
76
|
+
|
|
77
|
+
## Truth Caps
|
|
78
|
+
|
|
79
|
+
- Full visual verification: real source-screen evidence and relevant recheck.
|
|
80
|
+
- Partial: text-only review, no screenshot, browser unavailable, or source-state gaps.
|
|
81
|
+
- Blocked: requested visual claim cannot be inspected.
|
|
82
|
+
- Assumed: implementation follows code patterns but visual result was not observed.
|
|
83
|
+
- Reference-only or generated-only evidence cannot upgrade a result to full visual verification.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# UI Quality
|
|
2
|
+
|
|
3
|
+
Direction comes before decoration.
|
|
4
|
+
|
|
5
|
+
Check:
|
|
6
|
+
|
|
7
|
+
- What real source-screen evidence supports the visual claim?
|
|
8
|
+
- Does the change match the product domain?
|
|
9
|
+
- Does it fit existing components, tokens, spacing, typography, and interaction patterns?
|
|
10
|
+
- Is the primary workflow easier to scan or complete?
|
|
11
|
+
- Does text fit on mobile and desktop?
|
|
12
|
+
- Are states covered when relevant: default, loading, error, empty, disabled, hover/focus, mobile?
|
|
13
|
+
- Is color contrast sufficient?
|
|
14
|
+
- Is the UI less generic after the change?
|
|
15
|
+
|
|
16
|
+
Avoid:
|
|
17
|
+
|
|
18
|
+
- Generic purple gradients.
|
|
19
|
+
- Decorative blobs.
|
|
20
|
+
- Cards inside cards.
|
|
21
|
+
- Marketing layouts for operational tools.
|
|
22
|
+
- New dependencies for small visual flourishes.
|
|
23
|
+
- Treating reference/generated images as proof of the implemented screen.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Verification Levels
|
|
2
|
+
|
|
3
|
+
## Level 0: Read/Inspect
|
|
4
|
+
|
|
5
|
+
For copy, spacing, small CSS, docs, or no-runtime changes.
|
|
6
|
+
|
|
7
|
+
Expected:
|
|
8
|
+
|
|
9
|
+
- Re-read the changed file or relevant snippet.
|
|
10
|
+
- Check local project fit.
|
|
11
|
+
- Report that no command was run.
|
|
12
|
+
|
|
13
|
+
## Level 1: One Relevant Check
|
|
14
|
+
|
|
15
|
+
For small JS/TS/component changes.
|
|
16
|
+
|
|
17
|
+
Examples:
|
|
18
|
+
|
|
19
|
+
- One focused test.
|
|
20
|
+
- Typecheck.
|
|
21
|
+
- Lint for touched area.
|
|
22
|
+
|
|
23
|
+
## Level 2: Focused Confidence
|
|
24
|
+
|
|
25
|
+
For feature-sized work.
|
|
26
|
+
|
|
27
|
+
Examples:
|
|
28
|
+
|
|
29
|
+
- Typecheck plus related test.
|
|
30
|
+
- Build if no narrower test exists.
|
|
31
|
+
|
|
32
|
+
## Level 3: UI Confidence
|
|
33
|
+
|
|
34
|
+
For visible UI changes.
|
|
35
|
+
|
|
36
|
+
Expected when feasible:
|
|
37
|
+
|
|
38
|
+
- Desktop screenshot or browser check.
|
|
39
|
+
- Mobile viewport check.
|
|
40
|
+
- Check overflow, alignment, contrast, density, and core states.
|
|
41
|
+
|
|
42
|
+
## Level 4: Deep Confidence
|
|
43
|
+
|
|
44
|
+
For auth, payment, DB, migration, release, broad refactor, or user-requested deep verification.
|
|
45
|
+
|
|
46
|
+
Examples:
|
|
47
|
+
|
|
48
|
+
- Build.
|
|
49
|
+
- Test suite or relevant suites.
|
|
50
|
+
- Browser QA.
|
|
51
|
+
- Security check.
|
|
52
|
+
- Proof summary.
|
|
53
|
+
|