@cbartens/bkit 6.0.0 → 6.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/.bkit/README.md +154 -151
- package/.bkit/core/.agents/context.md +95 -29
- package/.bkit/core/.agents/docs.md +17 -15
- package/.bkit/core/.agents/plugins/bkit/hooks/bkit-gateguard.cjs +1 -0
- package/.bkit/core/.agents/plugins/bkit/hooks/bkit-guardrails.cjs +6 -5
- package/.bkit/core/.agents/plugins/bkit/hooks/bkit-readguard.cjs +1 -0
- package/.bkit/core/.agents/plugins/bkit/hooks/bkit-rules.cjs +65 -0
- package/.bkit/core/.agents/rules.md +108 -107
- package/.bkit/core/.agents/skills.md +63 -15
- package/.bkit/core/.bkit/README.md +154 -151
- package/.bkit/core/.bkit/authoring.md +714 -84
- package/.bkit/core/.bkit/cli.md +407 -0
- package/.bkit/core/.bkit/cloud.md +281 -193
- package/.bkit/core/.bkit/comparison.md +43 -41
- package/.bkit/core/.bkit/install.md +154 -84
- package/.bkit/core/.bkit/jsonl.md +193 -130
- package/.bkit/core/.bkit/pipeline.md +114 -114
- package/.bkit/core/.bkit/prompts.md +272 -165
- package/.bkit/core/.bkit/providers.md +457 -271
- package/.bkit/core/.bkit/router.md +69 -0
- package/.bkit/core/.bkit/templates.md +529 -256
- package/.bkit/core/.bkit/trackers.md +80 -52
- package/.bkit/core/.bkit/workflows.md +589 -504
- package/.bkit/core/.claude/hooks/bkit-gateguard.cjs +2 -2
- package/.bkit/core/.claude/hooks/bkit-guardrails.cjs +3 -3
- package/.bkit/core/.claude/hooks/bkit-preflight.sh +45 -14
- package/.bkit/core/.codex/hooks/bkit-guardrails.cjs +3 -3
- package/.bkit/core/.codex/hooks/bkit-rules.cjs +57 -0
- package/.bkit/core/.cursor/hooks/bkit-guardrails.cjs +7 -7
- package/.bkit/core/.cursor/hooks/bkit-preflight.sh +47 -12
- package/.bkit/core/.opencode/plugin/bkit-rules.js +89 -0
- package/.bkit/core/AGENTS.md +5 -73
- package/.bkit/core/docs/templates/bkit-audit-accessibility.md +127 -105
- package/.bkit/core/docs/templates/bkit-audit-adoption.md +104 -70
- package/.bkit/core/docs/templates/bkit-audit-agents.md +94 -72
- package/.bkit/core/docs/templates/bkit-audit-aio-seo.md +99 -78
- package/.bkit/core/docs/templates/bkit-audit-analytics.md +140 -82
- package/.bkit/core/docs/templates/bkit-audit-annotations.md +98 -72
- package/.bkit/core/docs/templates/bkit-audit-app-performance.md +121 -96
- package/.bkit/core/docs/templates/bkit-audit-app-store.md +157 -76
- package/.bkit/core/docs/templates/bkit-audit-architecture.md +113 -71
- package/.bkit/core/docs/templates/bkit-audit-ci-performance.md +75 -72
- package/.bkit/core/docs/templates/bkit-audit-config.md +122 -76
- package/.bkit/core/docs/templates/bkit-audit-cost.md +85 -74
- package/.bkit/core/docs/templates/bkit-audit-coverage.md +75 -68
- package/.bkit/core/docs/templates/bkit-audit-database.md +101 -70
- package/.bkit/core/docs/templates/bkit-audit-dead-code.md +164 -83
- package/.bkit/core/docs/templates/bkit-audit-deferrals.md +115 -86
- package/.bkit/core/docs/templates/bkit-audit-dependencies.md +264 -88
- package/.bkit/core/docs/templates/bkit-audit-documentation.md +118 -93
- package/.bkit/core/docs/templates/bkit-audit-duplication.md +139 -86
- package/.bkit/core/docs/templates/bkit-audit-failures.md +110 -81
- package/.bkit/core/docs/templates/bkit-audit-flakes.md +99 -74
- package/.bkit/core/docs/templates/bkit-audit-gates.md +105 -77
- package/.bkit/core/docs/templates/bkit-audit-issues.md +104 -80
- package/.bkit/core/docs/templates/bkit-audit-llm.md +131 -58
- package/.bkit/core/docs/templates/bkit-audit-logs.md +123 -100
- package/.bkit/core/docs/templates/bkit-audit-models.md +98 -53
- package/.bkit/core/docs/templates/bkit-audit-privacy.md +56 -52
- package/.bkit/core/docs/templates/bkit-audit-prompts.md +63 -54
- package/.bkit/core/docs/templates/bkit-audit-red-team.md +124 -68
- package/.bkit/core/docs/templates/bkit-audit-reliability.md +95 -70
- package/.bkit/core/docs/templates/bkit-audit-repo.md +169 -73
- package/.bkit/core/docs/templates/bkit-audit-security.md +206 -96
- package/.bkit/core/docs/templates/bkit-audit-slop.md +77 -70
- package/.bkit/core/docs/templates/bkit-audit-testing.md +162 -114
- package/.bkit/core/docs/templates/bkit-audit-usability.md +113 -71
- package/.bkit/core/docs/templates/bkit-plan.md +138 -132
- package/.bkit/core/engine/checks/after/auth.ts +40 -37
- package/.bkit/core/engine/checks/after/ci-yml.ts +65 -2
- package/.bkit/core/engine/checks/after/index.ts +12 -2
- package/.bkit/core/engine/checks/after/tools.ts +80 -33
- package/.bkit/core/engine/checks/before/context-fetch.ts +227 -33
- package/.bkit/core/engine/checks/before/env.ts +1 -1
- package/.bkit/core/engine/checks/before/index.ts +7 -0
- package/.bkit/core/engine/checks/before/repo.ts +40 -0
- package/.bkit/core/engine/checks/status-holes.ts +916 -123
- package/.bkit/core/engine/checks/tips/catalogue.ts +68 -17
- package/.bkit/core/engine/checks/tips/detect.ts +32 -0
- package/.bkit/core/engine/checks/tips/index.ts +47 -6
- package/.bkit/core/engine/cli.ts +238 -84
- package/.bkit/core/engine/commands/analysis.ts +128 -76
- package/.bkit/core/engine/commands/ci/ci.ts +363 -29
- package/.bkit/core/engine/commands/ci/pins.ts +172 -0
- package/.bkit/core/engine/commands/ci/push-gate.ts +223 -0
- package/.bkit/core/engine/commands/install/uninstall.ts +21 -27
- package/.bkit/core/engine/commands/install/upgrade.ts +32 -15
- package/.bkit/core/engine/commands/land.ts +126 -11
- package/.bkit/core/engine/commands/lib.ts +303 -6
- package/.bkit/core/engine/commands/registry.ts +6 -2
- package/.bkit/core/engine/commands/setup/setup.ts +1 -0
- package/.bkit/core/engine/commands/stats.ts +91 -35
- package/.bkit/core/engine/commands/workflow/branches.ts +1477 -117
- package/.bkit/core/engine/commands/workflow/challenge.ts +114 -39
- package/.bkit/core/engine/commands/workflow/completeness.ts +109 -0
- package/.bkit/core/engine/commands/workflow/context.ts +433 -55
- package/.bkit/core/engine/commands/workflow/counters.ts +244 -39
- package/.bkit/core/engine/commands/workflow/decisions.ts +61 -17
- package/.bkit/core/engine/commands/workflow/disk.ts +237 -55
- package/.bkit/core/engine/commands/workflow/fids.ts +19 -1
- package/.bkit/core/engine/commands/workflow/issues.ts +6 -0
- package/.bkit/core/engine/commands/workflow/ledgers.ts +458 -18
- package/.bkit/core/engine/commands/workflow/locks.ts +2 -0
- package/.bkit/core/engine/commands/workflow/plan-blocks.ts +124 -15
- package/.bkit/core/engine/commands/workflow/plans.ts +257 -0
- package/.bkit/core/engine/commands/workflow/prs.ts +12 -3
- package/.bkit/core/engine/commands/workflow/repo.ts +8 -0
- package/.bkit/core/engine/commands/workflow/roadmap.ts +56 -15
- package/.bkit/core/engine/commands/workflow/run-facts.ts +22 -31
- package/.bkit/core/engine/commands/workflow/runs.ts +652 -34
- package/.bkit/core/engine/commands/workflow/runtime.ts +3 -0
- package/.bkit/core/engine/commands/workflow/skills.ts +1 -0
- package/.bkit/core/engine/commands/workflow/status.ts +200 -17
- package/.bkit/core/engine/commands/workflow/step-table.ts +75 -33
- package/.bkit/core/engine/commands/workflow/steps.ts +635 -24
- package/.bkit/core/engine/commands/workflow/summary-findings.ts +177 -0
- package/.bkit/core/engine/commands/workflow/summary.ts +192 -46
- package/.bkit/core/engine/commands/workflow/tasks.ts +409 -0
- package/.bkit/core/engine/commands/workflow/test-blocks.ts +254 -0
- package/.bkit/core/engine/commands/workflow/tests-changed.ts +201 -0
- package/.bkit/core/engine/commands/workflow/tests.ts +1285 -356
- package/.bkit/core/engine/commands/workflow/workflows.ts +228 -43
- package/.bkit/core/engine/commands/workflow/worktrees.ts +389 -47
- package/.bkit/core/engine/install/cloud-env.ts +251 -121
- package/.bkit/core/engine/install/context-ci-workflow.ts +102 -0
- package/.bkit/core/engine/install/manifest.ts +60 -12
- package/.bkit/core/engine/install/modules/antigravity.ts +3 -2
- package/.bkit/core/engine/install/modules/cloud.ts +3 -3
- package/.bkit/core/engine/install/modules/codex.ts +15 -2
- package/.bkit/core/engine/install/modules/core.ts +956 -52
- package/.bkit/core/engine/install/modules/cursor.ts +6 -6
- package/.bkit/core/engine/install/modules/opencode.ts +16 -4
- package/.bkit/core/engine/install/template-notes.ts +130 -0
- package/.bkit/core/engine/install/version-file.ts +3 -2
- package/.bkit/core/engine/install/write.ts +5 -0
- package/.bkit/core/engine/ledgers/compact.ts +124 -0
- package/.bkit/core/engine/ledgers/journal.ts +291 -0
- package/.bkit/core/engine/ledgers/status.ts +160 -9
- package/.bkit/core/engine/ledgers/telemetry.ts +158 -21
- package/.bkit/core/engine/render/hosts.ts +114 -14
- package/.bkit/core/engine/shared/bkit-latest.ts +26 -4
- package/.bkit/core/engine/shared/dep-updater.ts +60 -0
- package/.bkit/core/engine/shared/egress.ts +1 -1
- package/.bkit/core/engine/shared/package-manager.ts +9 -0
- package/.bkit/core/engine/shared/settings.ts +92 -17
- package/.bkit/core/engine/shared/timeouts.ts +2 -0
- package/.bkit/core/engine/tools/cli-doc.ts +111 -0
- package/.bkit/core/engine/tools/grammar-density.ts +1 -1
- package/.bkit/core/engine/tools/instructions-sources.ts +15 -17
- package/.bkit/core/engine/tools/instructions.ts +94 -43
- package/.bkit/core/hooks/antigravity-hook.js +25 -10
- package/.bkit/core/hooks/gateguard-engine.js +53 -29
- package/.bkit/core/hooks/guardrails-shell.js +4 -4
- package/.bkit/core/hooks/guardrails-tiers.js +3 -3
- package/.bkit/core/hooks/preflight-linear.sh +9 -9
- package/.bkit/core/hooks/preflight-rules.sh +8 -0
- package/.bkit/core/hooks/readguard-engine.js +29 -10
- package/.bkit/core/hooks/session-rules-advisory.js +61 -0
- package/.bkit/core/prompts/bkit-audit-generate.md +187 -116
- package/.bkit/core/prompts/bkit-build-challenge-1.md +56 -37
- package/.bkit/core/prompts/bkit-build-challenge-2.md +65 -45
- package/.bkit/core/prompts/bkit-build-install-skills.md +38 -29
- package/.bkit/core/prompts/bkit-build-plan-convert.md +43 -32
- package/.bkit/core/prompts/bkit-build-plan-current.md +49 -39
- package/.bkit/core/prompts/bkit-build-plan-gaps-remediate.md +79 -55
- package/.bkit/core/prompts/bkit-build-plan-tasks.md +149 -0
- package/.bkit/core/prompts/bkit-build-plan-tests.md +120 -0
- package/.bkit/core/prompts/bkit-build-plan-verify.md +87 -50
- package/.bkit/core/prompts/bkit-debug-abort-handover.md +36 -35
- package/.bkit/core/prompts/bkit-debug-failure-diagnose.md +96 -64
- package/.bkit/core/prompts/bkit-debug-failure-remediate.md +54 -45
- package/.bkit/core/prompts/bkit-debug-failure-reproduce.md +42 -33
- package/.bkit/core/prompts/bkit-debug-failure-soak.md +53 -37
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-1.md +35 -30
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-2.md +34 -29
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-3.md +32 -28
- package/.bkit/core/prompts/bkit-design-generate.md +68 -52
- package/.bkit/core/prompts/bkit-design-organise.md +73 -35
- package/.bkit/core/prompts/bkit-design-review-1.md +58 -54
- package/.bkit/core/prompts/bkit-design-review-2.md +54 -50
- package/.bkit/core/prompts/bkit-design-spike.md +54 -47
- package/.bkit/core/prompts/bkit-design-update.md +42 -31
- package/.bkit/core/prompts/bkit-plan-generate.md +76 -58
- package/.bkit/core/prompts/bkit-plan-review-1.md +63 -49
- package/.bkit/core/prompts/bkit-plan-review-2.md +60 -48
- package/.bkit/core/prompts/bkit-plan-scope-check.md +53 -46
- package/.bkit/core/prompts/bkit-plan-update.md +70 -52
- package/.bkit/core/prompts/bkit-ship-conflict-resolve.md +82 -50
- package/.bkit/core/prompts/bkit-ship-deferred-sweep.md +80 -45
- package/.bkit/core/prompts/bkit-ship-update-docs.md +35 -29
- package/.bkit/core/prompts/bkit-utility-compress-markdown.md +55 -49
- package/.bkit/core/prompts/bkit-utility-update-decisions.md +76 -49
- package/.bkit/core/prompts/bkit-utility-update-deferrals.md +70 -41
- package/.bkit/core/prompts/bkit-utility-update-documentation.md +33 -30
- package/.bkit/core/prompts/bkit-utility-update-failures.md +73 -43
- package/.bkit/core/prompts/bkit-utility-update-knowledge.md +77 -50
- package/.bkit/core/prompts/bkit-utility-update-roadmap.md +77 -45
- package/.bkit/core/prompts/bkit-utility-update-tracker.md +144 -68
- package/.bkit/core/workflows/bkit-auto.md +53 -30
- package/.bkit/core/workflows/bkit-build.md +635 -304
- package/.bkit/core/workflows/bkit-debug.md +301 -148
- package/.bkit/core/workflows/bkit-design.md +167 -95
- package/.bkit/core/workflows/bkit-plan.md +172 -84
- package/.bkit/core/workflows/bkit-ship.md +299 -152
- package/.bkit/shared/.agents/plugins/bkit/hooks.json +10 -0
- package/.bkit/shared/.claude/bkit-cloud.md +12 -10
- package/.bkit/shared/.claude/settings.json +3 -0
- package/.bkit/shared/.codex/bkit-cloud.md +98 -0
- package/.bkit/shared/.codex/hooks.json +20 -0
- package/.bkit/shared/.cursor/bkit-cloud.md +3 -3
- package/.bkit/shared/.opencode/opencode.json +1 -1
- package/.bkit/shared/CLAUDE.md +5 -1
- package/.bkit/shared/GEMINI.md +4 -1
- package/.bkit/shared/docs/architecture.md +4 -7
- package/.bkit/shared/docs/data-schema.md +4 -7
- package/.bkit/shared/docs/deployments.md +239 -166
- package/.bkit/shared/docs/design.md +11 -12
- package/.bkit/shared/docs/noise.md +8 -7
- package/.bkit/shared/docs/observability.md +5 -8
- package/.bkit/shared/docs/security.md +35 -17
- package/.bkit/shared/docs/setup.md +29 -18
- package/.bkit/shared/docs/technology.md +3 -6
- package/.bkit/shared/docs/testing.md +282 -176
- package/.bkit/shared/gitignore +6 -2
- package/.bkit/templates/.claude/hooks/bkit-cloud-bootstrap.sh +15 -16
- package/.bkit/templates/.cursor/Dockerfile +12 -8
- package/.bkit/templates/.cursor/environment.json +1 -1
- package/.bkit/templates/.github/ISSUE_TEMPLATE/bkit-bug.yml +10 -8
- package/.bkit/templates/.github/ISSUE_TEMPLATE/bkit-change.yml +24 -12
- package/.bkit/templates/.github/ISSUE_TEMPLATE/bkit-idea.yml +3 -3
- package/.bkit/templates/.github/renovate.json5 +34 -6
- package/.bkit/templates/.github/workflows/bkit-ci.yml +53 -50
- package/.bkit/templates/.github/workflows/bkit-cloud.yml +13 -14
- package/.bkit/templates/.github/workflows/bkit-health.yml +97 -0
- package/.bkit/templates/.github/workflows/bkit-renovate.yml +5 -4
- package/.bkit/templates/.github/workflows/bkit-trivy.yml +5 -4
- package/.bkit/templates/.husky/pre-commit +2 -2
- package/.bkit/templates/.husky/pre-push +95 -35
- package/.bkit/templates/.prettierignore +6 -7
- package/.bkit/templates/.vale.ini +27 -27
- package/.bkit/templates/context/bkit-cloudrun.md +23 -15
- package/.bkit/templates/context/bkit-expo.md +70 -52
- package/.bkit/templates/context/bkit-github.md +93 -56
- package/.bkit/templates/context/bkit-inngest.md +21 -15
- package/.bkit/templates/context/bkit-maestro.md +22 -16
- package/.bkit/templates/context/bkit-playwright.md +23 -17
- package/.bkit/templates/context/bkit-resend.md +12 -10
- package/.bkit/templates/context/bkit-sentry.md +30 -20
- package/.bkit/templates/context/bkit-serena.md +8 -7
- package/.bkit/templates/context/bkit-stripe.md +14 -13
- package/.bkit/templates/context/bkit-supabase.md +16 -13
- package/.bkit/templates/context/bkit-tavily.md +14 -11
- package/.bkit/templates/context/bkit-vercel.md +27 -18
- package/.bkit/templates/docs/capabilities.md +15 -14
- package/.bkit/templates/scripts/ci/{check-accepted-divergences.mjs → bkit-check-accepted-divergences.mjs} +6 -3
- package/.bkit/templates/scripts/ci/{check-accepted-divergences.test.mjs → bkit-check-accepted-divergences.test.mjs} +3 -3
- package/.bkit/templates/scripts/ci/{check-capstone.mjs → bkit-check-capstone.mjs} +2 -2
- package/.bkit/templates/scripts/ci/{check-capstone.test.mjs → bkit-check-capstone.test.mjs} +4 -4
- package/.bkit/templates/scripts/ci/{check-dependency-audit.mjs → bkit-check-dependency-audit.mjs} +103 -18
- package/.bkit/templates/scripts/ci/{check-dependency-audit.test.mjs → bkit-check-dependency-audit.test.mjs} +31 -3
- package/.bkit/templates/scripts/ci/bkit-machine-lock.sh +387 -0
- package/.bkit/templates/scripts/ci/bkit-test-awake.mjs +75 -0
- package/.bkit/templates/scripts/ci/bkit-test-awake.test.mjs +160 -0
- package/.bkit/templates/scripts/ci/lanes/{resolve-push-base.mjs → bkit-resolve-push-base.mjs} +3 -3
- package/.bkit/templates/scripts/ci/lanes/{resolve-push-base.test.mjs → bkit-resolve-push-base.test.mjs} +4 -4
- package/.bkit/templates/scripts/cleanup/bkit-disk-prune.mjs +9 -1
- package/.bkit/templates/scripts/graphify/bkit-graph-drift.py +1 -1
- package/.bkit/templates/scripts/graphify/bkit-graph-eager.py +3 -3
- package/.bkit/templates/scripts/graphify/bkit-graph-embed.py +63 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-imports.py +2 -2
- package/.bkit/templates/scripts/graphify/bkit-graph-pre-push.sh +69 -18
- package/.bkit/templates/scripts/graphify/bkit-graph-repair.py +3 -3
- package/.bkit/templates/scripts/graphify/bkit-graph-surface.py +1 -1
- package/.bkit/templates/scripts/graphify/bkit-graphify-graphml.py +1 -1
- package/.bkit/templates/scripts/graphify/bkit-graphify-rollup.py +197 -126
- package/.bkit/templates/scripts/graphify/bkit-graphify.sh +64 -41
- package/.bkit/templates/scripts/slop/bkit-slop-type-suppression.mjs +23 -7
- package/.bkit/templates/slop-scan.config.json +9 -2
- package/CHANGELOG.md +119 -0
- package/README.md +250 -76
- package/dist/checks/after/auth.js +36 -33
- package/dist/checks/after/ci-yml.js +52 -2
- package/dist/checks/after/index.js +12 -4
- package/dist/checks/after/tools.js +73 -33
- package/dist/checks/before/context-fetch.js +218 -33
- package/dist/checks/before/env.js +1 -1
- package/dist/checks/before/index.js +6 -2
- package/dist/checks/before/repo.js +35 -1
- package/dist/checks/status-holes.js +739 -114
- package/dist/checks/tips/catalogue.js +59 -17
- package/dist/checks/tips/detect.js +30 -0
- package/dist/checks/tips/index.js +48 -6
- package/dist/cli.js +222 -84
- package/dist/commands/analysis.js +77 -53
- package/dist/commands/ci/ci.js +302 -25
- package/dist/commands/ci/pins.js +142 -0
- package/dist/commands/ci/push-gate.js +194 -0
- package/dist/commands/install/uninstall.js +23 -27
- package/dist/commands/install/upgrade.js +21 -11
- package/dist/commands/land.js +126 -10
- package/dist/commands/lib.js +244 -5
- package/dist/commands/registry.js +6 -2
- package/dist/commands/setup/setup.js +1 -0
- package/dist/commands/stats.js +69 -30
- package/dist/commands/workflow/branches.js +1232 -111
- package/dist/commands/workflow/challenge.js +90 -37
- package/dist/commands/workflow/completeness.js +97 -0
- package/dist/commands/workflow/context.js +371 -51
- package/dist/commands/workflow/counters.js +206 -40
- package/dist/commands/workflow/decisions.js +60 -17
- package/dist/commands/workflow/disk.js +213 -55
- package/dist/commands/workflow/fids.js +18 -1
- package/dist/commands/workflow/issues.js +6 -0
- package/dist/commands/workflow/ledgers.js +372 -21
- package/dist/commands/workflow/locks.js +2 -0
- package/dist/commands/workflow/plan-blocks.js +78 -14
- package/dist/commands/workflow/plans.js +205 -0
- package/dist/commands/workflow/prs.js +12 -3
- package/dist/commands/workflow/repo.js +6 -0
- package/dist/commands/workflow/roadmap.js +50 -17
- package/dist/commands/workflow/run-facts.js +23 -28
- package/dist/commands/workflow/runs.js +530 -33
- package/dist/commands/workflow/runtime.js +3 -0
- package/dist/commands/workflow/skills.js +1 -0
- package/dist/commands/workflow/status.js +166 -19
- package/dist/commands/workflow/step-table.js +61 -29
- package/dist/commands/workflow/steps.js +542 -26
- package/dist/commands/workflow/summary-findings.js +117 -0
- package/dist/commands/workflow/summary.js +154 -41
- package/dist/commands/workflow/tasks.js +378 -0
- package/dist/commands/workflow/test-blocks.js +231 -0
- package/dist/commands/workflow/tests-changed.js +172 -0
- package/dist/commands/workflow/tests.js +1013 -321
- package/dist/commands/workflow/workflows.js +191 -38
- package/dist/commands/workflow/worktrees.js +310 -42
- package/dist/install/cloud-env.js +233 -99
- package/dist/install/context-ci-workflow.js +85 -0
- package/dist/install/manifest.js +57 -12
- package/dist/install/modules/antigravity.js +3 -2
- package/dist/install/modules/cloud.js +3 -3
- package/dist/install/modules/codex.js +12 -2
- package/dist/install/modules/core.js +851 -53
- package/dist/install/modules/cursor.js +6 -6
- package/dist/install/modules/opencode.js +11 -5
- package/dist/install/template-notes.js +116 -0
- package/dist/install/version-file.js +3 -2
- package/dist/ledgers/compact.js +87 -0
- package/dist/ledgers/journal.js +233 -0
- package/dist/ledgers/status.js +115 -5
- package/dist/ledgers/telemetry.js +121 -17
- package/dist/render/hosts.js +100 -14
- package/dist/shared/bkit-latest.js +26 -4
- package/dist/shared/dep-updater.js +49 -0
- package/dist/shared/egress.js +1 -1
- package/dist/shared/package-manager.js +6 -0
- package/dist/shared/settings.js +59 -10
- package/dist/shared/timeouts.js +2 -0
- package/dist/tools/cli-doc.js +97 -0
- package/dist/tools/grammar-density.js +1 -1
- package/dist/tools/instructions-sources.js +15 -16
- package/dist/tools/instructions.js +83 -39
- package/package.json +58 -42
- package/.bkit/core/.bkit/lite.md +0 -73
- package/.bkit/core/engine/commands/workflow/workstreams.ts +0 -172
- package/.bkit/core/prompts/bkit-build-plan-execute.md +0 -124
- package/.bkit/templates/scripts/ci/bkit-local-stack-lock.sh +0 -194
- package/dist/commands/workflow/workstreams.js +0 -149
- /package/.bkit/templates/.vale/styles/{House → Bkit}/Filler.yml +0 -0
- /package/.bkit/templates/.vale/styles/{House → Bkit}/Hedging.yml +0 -0
- /package/.bkit/templates/.vale/styles/{House → Bkit}/LLMSlop.yml +0 -0
- /package/.bkit/templates/.vale/styles/{House → Bkit}/Verbose.yml +0 -0
- /package/.bkit/templates/scripts/ci/{accepted-advisories.json → bkit-accepted-advisories.json} +0 -0
- /package/.bkit/templates/scripts/ci/{accepted-divergences.json → bkit-accepted-divergences.json} +0 -0
- /package/.bkit/templates/scripts/launchd/{launchd.env.example → bkit-launchd.env.example} +0 -0
- /package/.bkit/templates/scripts/launchd/{ai.bkit.launchd.plist → bkit-launchd.plist} +0 -0
|
@@ -1,47 +1,50 @@
|
|
|
1
|
-
<!-- Note: Reports live at `docs/audits/{YYYYMM}/{slug}.md`. `{YYYYMM}` = UTC month of this run. `{slug}` = template basename without `bkit-audit-` and `.md`. **If** that month already has `{slug}.md` or `{slug}-{TIMESTAMP}.md` → write `{slug}-{TIMESTAMP}.md` (`{TIMESTAMP}` = `date -u +%Y%m%dT%H%M%SZ`). Never overwrite. The report is stamped with a `bkit:anchor` block recording the audited commit (`baseSha`) and branch (`baseRef`); never hand-author or edit it. `@bkit-audit-generate` fills this template. -->
|
|
2
|
-
|
|
3
1
|
<!-- bkit:start -->
|
|
4
2
|
|
|
5
3
|
{{BKIT_MANAGED_MARKER}}
|
|
6
4
|
|
|
5
|
+
<!-- Note: @bkit-audit-generate fills this template. The report lives at `docs/audits/{YYYYMM}/{slug}.md`, where `{YYYYMM}` is the UTC month of the run and `{slug}` is this file's name without `bkit-audit-` and `.md`. **If** that month already has `{slug}.md` or `{slug}-{TIMESTAMP}.md` → write `{slug}-{TIMESTAMP}.md`, where `{TIMESTAMP}` is the output of `date -u +%Y%m%dT%H%M%SZ`. NEVER overwrite an earlier report. The report is stamped with a `bkit:anchor` block that records the audited commit (`baseSha`) and branch (`baseRef`). NEVER write or edit that block by hand. -->
|
|
6
|
+
|
|
7
7
|
# Model Audit
|
|
8
8
|
|
|
9
9
|
> [!CAUTION]
|
|
10
|
-
> **Purpose:**
|
|
10
|
+
> **Purpose:** For each call site: the latest capable model for the job, a live model with live fallbacks, and the choice kept in one registry.
|
|
11
11
|
>
|
|
12
12
|
> **Rules:**
|
|
13
13
|
>
|
|
14
|
-
> -
|
|
15
|
-
> -
|
|
16
|
-
> -
|
|
14
|
+
> - Never edit the model registry, call wrappers, routing config or call sites.
|
|
15
|
+
> - The report proposes the replacement.
|
|
16
|
+
> - Run fallback probes with a synthetic fixture.
|
|
17
|
+
> - NEVER send production user content.
|
|
18
|
+
> - Never write the spend ledger.
|
|
19
|
+
> - Never publish a number with no recorded source.
|
|
17
20
|
|
|
18
21
|
## Universal Instructions
|
|
19
22
|
|
|
20
23
|
### Context & Goals
|
|
21
24
|
|
|
22
|
-
|
|
25
|
+
A config id looks the same on the day it is delisted as on the day it was chosen. The failure this audit targets is a stale entry that looks the same as a working one until a fallback fires, which is the moment it has to work. Examples: a text-only model in a file chain, two chains that share one fallback that then disappears, a floating alias that now names a different model. Pull the live catalogue; do not remember ids, or infer them from version numbers.
|
|
23
26
|
|
|
24
|
-
**Applies when:** code calls hosted model (chat, tools, vision, embeddings, any modality).
|
|
27
|
+
**Applies when:** code calls a hosted model (chat, tools, vision, embeddings, any modality). **If** it does not → write one `N/A` row with its evidence, and never report the surface as "clean".
|
|
25
28
|
|
|
26
|
-
**Cadence:**
|
|
29
|
+
**Cadence:** Run once a month. Run an extra pass when a listed id is delisted, a capability the call sends is lost, an expiration or deprecation is added, an alias resolves to a different canonical id, or a new task or call site routes through the fallback wrapper.
|
|
27
30
|
|
|
28
31
|
**Anchor Standards:**
|
|
29
32
|
|
|
30
|
-
- Provider model-list APIs, including lifecycle and per-endpoint fields (e.g
|
|
31
|
-
- Provider routing controls (e.g
|
|
32
|
-
- Maker deprecation pages (e.g
|
|
33
|
+
- Provider model-list APIs, including lifecycle and per-endpoint fields (e.g., OpenRouter models and endpoints APIs: `expiration_date`, `canonical_slug`, `knowledge_cutoff`; Anthropic, OpenAI, and Google model lists).
|
|
34
|
+
- Provider routing controls (e.g., OpenRouter `require_parameters`, `quantizations`, `max_price`, `allow_fallbacks`, zero-retention).
|
|
35
|
+
- Maker deprecation pages (e.g., Anthropic, OpenAI, Google), plus the equivalent for every other maker in a chain.
|
|
33
36
|
- Model cards published by each model's maker.
|
|
34
37
|
- NIST AI 600-1, Generative AI Profile, MEASURE, and MANAGE for third-party models.
|
|
35
|
-
- OWASP Top 10 for LLM Applications, LLM03 Supply Chain; record the edition (e.g
|
|
38
|
+
- OWASP Top 10 for LLM Applications, LLM03 Supply Chain; record the edition (e.g., 2025).
|
|
36
39
|
|
|
37
40
|
### Scope
|
|
38
41
|
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
42
|
+
- Judge every listed and proposed id against the live provider catalogue.
|
|
43
|
+
- Check each call site's fitness: capability, cost (catalogue price, not spend), latency, context and modality.
|
|
44
|
+
- Check deprecation, retirement, supersession and expiration.
|
|
45
|
+
- Check that endpoints and fallbacks are live, not only claimed in the model summary.
|
|
46
|
+
- Check whether ids live in one registry or are scattered.
|
|
47
|
+
- Propose a registry and per-task routing. This run does not apply them.
|
|
45
48
|
|
|
46
49
|
### Out of Scope
|
|
47
50
|
|
|
@@ -60,43 +63,81 @@ Config ids look identical delisted vs choice day. Target failure: **a stale entr
|
|
|
60
63
|
|
|
61
64
|
#### Core
|
|
62
65
|
|
|
63
|
-
- [ ] **Permissions:** blocked
|
|
64
|
-
- [ ] **Catalogue Read:** Steps 3, 5, 6 — live model list
|
|
65
|
-
- [ ] **Web:** Steps 5, 10 — maker deprecation pages, model cards, anchor standards. Fallback: versions
|
|
66
|
+
- [ ] **Permissions:** every blocked call is recorded.
|
|
67
|
+
- [ ] **Catalogue Read:** Steps 3, 5, 6 — the live model list for each provider the call sites use (e.g., OpenRouter `/api/v1/models`, Anthropic models API, OpenAI models API, Google models API). Fallback: read maker docs only, and treat live-endpoint claims as hypotheses.
|
|
68
|
+
- [ ] **Web:** Steps 5, 10 — maker deprecation pages, model cards, anchor standards. Fallback: record the versions as unread.
|
|
66
69
|
|
|
67
70
|
#### Conditional
|
|
68
71
|
|
|
69
|
-
- [ ] **Language Server:**
|
|
70
|
-
- [ ] **Endpoint API:**
|
|
71
|
-
- [ ] **Usage Ledger:**
|
|
72
|
-
- [ ] **Live Call:**
|
|
72
|
+
- [ ] **Language Server:** **If** call sites are typed → Step 4 — references (e.g., Serena, `tsserver`). Fallback: text search, and name the tool for each claim.
|
|
73
|
+
- [ ] **Endpoint API:** **If** the provider exposes per-model endpoints → Step 6 — the endpoint list (e.g., OpenRouter endpoints API). Fallback: read model-summary fields only, and say so.
|
|
74
|
+
- [ ] **Usage Ledger:** **If** a usage ledger exists → Step 6 — the largest measured input per task. Fallback: use catalogue context only, and mark measured input `Not Checked`.
|
|
75
|
+
- [ ] **Live Call:** **If** there is a credential for a fixture call → Step 7. Fallback: read endpoint metadata only, and mark liveness `Not Checked`.
|
|
73
76
|
|
|
74
77
|
### 🔒 Gate 1: Prerequisites Check
|
|
75
78
|
|
|
76
|
-
- [ ] **Gaps named:** every missing item names its fallback and `Not Checked` entry.
|
|
77
|
-
- [ ] **Gate 1 — Verified:**
|
|
79
|
+
- [ ] **Gaps named:** every missing item names its fallback and its `Not Checked` entry.
|
|
80
|
+
- [ ] **Gate 1 — Verified:** every item above, every Core item and every applicable Conditional item is checked.
|
|
78
81
|
|
|
79
82
|
### Probe Steps
|
|
80
83
|
|
|
81
|
-
- [ ] **Step 1 — Previous Run:** **Done when:**
|
|
82
|
-
- [ ] **Step 2 — Detect:** Find every model call site (SDK calls, HTTP to a model API, config lists) and whether choice lives in one registry or literals at sites. Embeddings and other modalities count.
|
|
83
|
-
- [ ] **Step 3 — Catalogue:** Pull live catalogue for each provider Step 2 found. Record date, URL
|
|
84
|
-
- [ ] **Step 4 — Call Sites:** Derive each call site's requirements from code this run: modality, tools
|
|
85
|
-
- [ ] **Step 5 — Lifecycle:**
|
|
86
|
-
- [ ] **Step 6 — Endpoints:**
|
|
87
|
-
-
|
|
88
|
-
-
|
|
89
|
-
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
84
|
+
- [ ] **Step 1 — Previous Run:** **Done when:** `Previous Run` holds the closure rate, or the run is marked baseline.
|
|
85
|
+
- [ ] **Step 2 — Detect:** Find every model call site (SDK calls, HTTP to a model API, config lists), and whether the choice lives in one registry or as literals at the sites. Embeddings and other modalities count. **If** there is no registry **and** ids are inline → the scatter is the finding; still audit the ids. **Done when:** `Checked` holds evidence, or `N/A` is recorded → **STOP**.
|
|
86
|
+
- [ ] **Step 3 — Catalogue:** Pull the live catalogue for each provider Step 2 found. Record the date, the URL and the counts (the full list, and any constrained subset the calls require, e.g., zero-retention). Every id proposed later must exist in this pull. **Done when:** the date, source and counts are in `Catalogue`.
|
|
87
|
+
- [ ] **Step 4 — Call Sites:** Derive each call site's requirements from the code on this run: modality, tools and tool choice, structured output, reasoning, output cap, timeout. Do not copy a requirements table forward. Run language-server references on each wrapper and each exported chain to find every task that routes through it. Re-run empty results, and corroborate them with text search, because an empty result is inconclusive. A task added since the previous report shows up only through this step. **Done when:** `Call Sites` has a row per site: task · wrapper · requirements · chain · `file:line` · how derived.
|
|
88
|
+
- [ ] **Step 5 — Lifecycle:** Apply hard filters to every listed id and candidate, against the Step 3 pull and the maker page. (a) Retention the call sends (e.g., zero-retention). **If** no endpoint matches → reject the id, because it does not route. (b) `expiration_date` and the maker deprecation page. Reject an id that expires before the next refresh. Reject preview, experimental and free-tier variants. (c) **If** a tool-calling candidate's reasoning cannot be switched off → reject it. Reasoning tokens exhaust the output budget, the model returns no tool call, and the wrapper surfaces a truncation error. (d) Alias or dated snapshot, and which canonical id it resolved to on the pull date. Prefer dated snapshots. An alias whose canonical id differs from the previous report is a model change: name `bkit-audit-llm`, and do not run the eval here. (e) The model card URL, knowledge cutoff, open-weight licence, training-on-data policy, maker terms for products that serve minors, and the hosting region for retention-satisfying endpoints. Children's data crossing borders goes to `bkit-audit-privacy`. **Done when:** `Lifecycle` has a row per id: filters · canonical id · card · verdict.
|
|
89
|
+
- [ ] **Step 6 — Endpoints:** A model-level summary can pass Step 5 while no single endpoint does, so query the endpoints, not the summary. Require >=1 endpoint, ideally 2, that satisfies the retention constraint and every parameter the call site sends (tools, tool choice including the required value, file, structured output — as Step 4's table requires).
|
|
90
|
+
- Record whether the call sets the flag that stops the router sending a parameter to a provider that ignores it (e.g., `require_parameters`).
|
|
91
|
+
- **If** the flag is absent → propose it in `Proposal`.
|
|
92
|
+
- For open weights, record the quantization per endpoint, and propose a pin or an order where quality differs.
|
|
93
|
+
- Compare each endpoint's context length and max completion with the largest measured input for that task, taken from the ledger.
|
|
94
|
+
- **If** the ledger does not have the task → say so.
|
|
95
|
+
- No output cap on a tool-calling path is a defect in the current list; propose a value per task.
|
|
96
|
+
- Compare latency and throughput per endpoint with the call timeout.
|
|
97
|
+
- The catalogue price is a fitness comment on the proposed row. Blended spend and fallback-rate dollars belong to `bkit-audit-cost`.
|
|
98
|
+
- Propose a per-task price ceiling as routing config, not as a spend figure.
|
|
99
|
+
|
|
100
|
+
**Done when:** `Endpoints` has a row per id: qualifying endpoints · parameters · context vs input · latency vs timeout · verdict.
|
|
101
|
+
|
|
102
|
+
- [ ] **Step 7 — Fallbacks:** (a) Check that the chain positions come from different makers, so one delisting or outage cannot collapse the retry. Record the router as a single point of failure, and whether any call constructs a direct maker client. A diagram that names maker SDKs is not that client. (b) Run one synthetic fixture per chain position, under the routing parameters production sends. A pass means the position accepted the call shape. A fail is a finding. This proves the fallback answers; it does not score quality. Extraction accuracy, tool-call validity rate and the hostile fixture belong to `bkit-audit-llm`. (c) Record whether anything counts how often a position fires. **If** nothing does:
|
|
103
|
+
- Record it as a finding.
|
|
104
|
+
- Propose a counter in `Process Improvements`.
|
|
105
|
+
- Send the spend consequence to `bkit-audit-cost`.
|
|
106
|
+
|
|
107
|
+
**Done when:** `Fallbacks` has a row per position: maker · fixture result or skip · fire-rate measured · verdict.
|
|
108
|
+
|
|
109
|
+
- [ ] **Step 8 — Registry:** Re-check the current list, not only the candidates. (1) Modality: every model in the chain accepts the input the call site sends (image support does not satisfy a file part). (2) Reasoning that cannot be switched off on a tool-calling path. (3) A task group or list with no call site. Run references on the export plus text search, including docs, because text search sees planning docs that the language server does not. Recommend deleting it unless a plan is in progress, because carrying lists for an unbuilt feature is how a registry goes stale. (4) Model ids outside the registry. **Done when:** every hit is a finding with `file:line`, or `Registry` states that it is clean.
|
|
110
|
+
- [ ] **Step 9 — Proposal:** Write the proposed list and per-task config (retention, required-parameters, quantization pin, price ceiling, output cap), with the catalogue price and context window as row comments.
|
|
111
|
+
- Label the chain order as a judgement, or cite the `bkit-audit-llm` scorecard it comes from.
|
|
112
|
+
- Never invent a score.
|
|
113
|
+
- Give the apply order; the report does not apply it.
|
|
114
|
+
- (1) Wrappers must pass per-task settings, or nothing else applies.
|
|
115
|
+
- (2) Pin retention routing at the shared boundary before the model switch, so new models are validated under the routing they will run.
|
|
116
|
+
- (3) Import the registry, delete hardcoded lists, and apply the list and per-task config.
|
|
117
|
+
- (4) Run the eval audit's check before the list is treated as mergeable; do not change model, sampling and fallback behaviour in one unmeasured step.
|
|
118
|
+
- (5) Watch with a named revert (the current lists, by commit) and per-signal thresholds (format-error rate, fallback-fire count, task success). Cost per job belongs to `bkit-audit-cost`.
|
|
119
|
+
- **If** a decision is open → write one `Proposal` question with `Options: A) … / B) …` and a `Recommended: A) … — {reason}` naming the chosen letter, plus what would settle it.
|
|
120
|
+
- Route each finding:
|
|
121
|
+
- a defect or filter-fail id → the proposed list
|
|
122
|
+
- a missing routing param → per-task config
|
|
123
|
+
- a wrapper that cannot pass settings → apply-order (1)
|
|
124
|
+
- a model change (including an alias move) → `bkit-audit-llm`
|
|
125
|
+
- children's-data borders → `bkit-audit-privacy`
|
|
126
|
+
- an unwired group → a delete recommendation
|
|
127
|
+
|
|
128
|
+
**Done when:** `Proposal` holds the list, apply order, watch plan and any open question.
|
|
129
|
+
|
|
130
|
+
- [ ] **Step 10 — Standards:** Confirm the current version of each anchor standard, and read what changed since the previous report's version. Give `Standards Coverage` one row per catalogue field, routing parameter, maker lifecycle rule and third-party-model control this procedure relies on, each marked checked (naming the step), not applicable (saying why) or finding. Mark each recommended practice the project does not apply as adopt (with a proposed step), reject (saying why) or not applicable. **Done when:** no row is empty.
|
|
131
|
+
- [ ] **Step 11 — Anything Else:** (a) Give a one-line verdict on each change since the previous report's commit that touches model choice: the registry, wrappers, call sites, routing parameters and embedding model id. Read the provider and maker changelogs since the previous report for a changed meaning of retention routing, reasoning, tool choice or pricing. Flag catalogue anomalies on current ids: a price jump, a context cut, an endpoint count fallen to one. (b) In a bounded pass of about 30 minutes, note what a senior ML platform engineer would flag that no step asks about. Read what happened since the previous run (incidents, `bkit-audit-logs` reports, new `docs/failures.jsonl` rows, vendor status incidents), and ask what no step would catch. Include the catalogue and changelog items that surfaced unchecked, with a query for the next run. **Done when:** `Beyond the Steps` holds both passes, or says `none`. **If** one class of issue is seen on 2 runs → propose a step for it in `Process Improvements`.
|
|
92
132
|
|
|
93
133
|
### 🔒 Gate 2: Probes Check
|
|
94
134
|
|
|
95
|
-
- [ ] **Steps complete:** every step `[x]`, or
|
|
96
|
-
- [ ] **Evidence:** every finding cites
|
|
97
|
-
- [ ] **IDs sourced:** every proposed id exists in this run's catalogue pull
|
|
98
|
-
- [ ] **
|
|
99
|
-
- [ ] **
|
|
135
|
+
- [ ] **Steps complete:** every step is `[x]`, or skipped with evidence that its surface is absent.
|
|
136
|
+
- [ ] **Evidence:** every finding cites evidence someone can check again, and the tool that produced it.
|
|
137
|
+
- [ ] **IDs sourced:** every proposed id exists in this run's catalogue pull.
|
|
138
|
+
- [ ] **Numbers sourced:** every number has a recorded source.
|
|
139
|
+
- [ ] **Registry untouched:** no edit was made to the registry, wrappers, routing config or call sites.
|
|
140
|
+
- [ ] **Gate 2 — Verified:** every item above holds.
|
|
100
141
|
|
|
101
142
|
## Findings
|
|
102
143
|
|
|
@@ -108,14 +149,14 @@ Config ids look identical delisted vs choice day. Target failure: **a stale entr
|
|
|
108
149
|
| `MEDIUM` | Floating alias, or alias whose canonical id moved; context or output cap below measured input; only one qualifying endpoint; unwired model list still maintained; open-weight quantization not pinned; nothing records fallback fires |
|
|
109
150
|
| `LOW` | Proposed row missing an inline lifecycle or price comment; doc names a model the registry does not, with no call site |
|
|
110
151
|
|
|
111
|
-
Within a severity
|
|
152
|
+
Within a severity, list a call that cannot be served first.
|
|
112
153
|
|
|
113
154
|
<!-- prettier-ignore -->
|
|
114
155
|
| ID | Severity | Location | Evidence | Expected |
|
|
115
156
|
| --- | --- | --- | --- | --- |
|
|
116
157
|
| PENDING | PENDING | PENDING | PENDING | PENDING |
|
|
117
158
|
|
|
118
|
-
|
|
159
|
+
**If** the run finds nothing → write one row: `None`.
|
|
119
160
|
|
|
120
161
|
## Report
|
|
121
162
|
|
|
@@ -184,13 +225,17 @@ PENDING
|
|
|
184
225
|
|
|
185
226
|
### 🔒 Gate 3: Report Check
|
|
186
227
|
|
|
187
|
-
- [ ] **No placeholders:** no `PENDING` left
|
|
188
|
-
- [ ] **Summary:**
|
|
189
|
-
- [ ] **
|
|
190
|
-
- [ ] **
|
|
191
|
-
- [ ] **
|
|
192
|
-
- [ ] **
|
|
193
|
-
- [ ] **
|
|
228
|
+
- [ ] **No placeholders:** no `PENDING` is left.
|
|
229
|
+
- [ ] **Summary:** `Summary` gives the count per severity.
|
|
230
|
+
- [ ] **Catalogue date:** `Summary` gives the catalogue date.
|
|
231
|
+
- [ ] **Counts:** `Summary` gives the counts.
|
|
232
|
+
- [ ] **Series:** the report shows every series beside the previous report's numbers, or marks the run as baseline.
|
|
233
|
+
- [ ] **Writes:** this run changed only this report, the template's `Project Instructions` and its own `docs/failures.jsonl` rows.
|
|
234
|
+
- [ ] **Throwaways removed:** every throwaway worktree or remote target is removed.
|
|
235
|
+
- [ ] **Process Improvements:** `Universal` and `Project` are both filled.
|
|
236
|
+
- [ ] **Suggested Issues:** every `MEDIUM`+ finding ID is in exactly one `Suggested Issues` row.
|
|
237
|
+
- [ ] **Next Step:** every `Suggested Issues` row has a `Next Step`.
|
|
238
|
+
- [ ] **Gate 3 — Verified:** every item above holds.
|
|
194
239
|
|
|
195
240
|
<!-- bkit:end -->
|
|
196
241
|
|
|
@@ -1,46 +1,47 @@
|
|
|
1
|
-
<!-- Note: Reports live at `docs/audits/{YYYYMM}/{slug}.md`. `{YYYYMM}` = UTC month of this run. `{slug}` = template basename without `bkit-audit-` and `.md`. **If** that month already has `{slug}.md` or `{slug}-{TIMESTAMP}.md` → write `{slug}-{TIMESTAMP}.md` (`{TIMESTAMP}` = `date -u +%Y%m%dT%H%M%SZ`). Never overwrite. The report is stamped with a `bkit:anchor` block recording the audited commit (`baseSha`) and branch (`baseRef`); never hand-author or edit it. `@bkit-audit-generate` fills this template. -->
|
|
2
|
-
|
|
3
1
|
<!-- bkit:start -->
|
|
4
2
|
|
|
5
3
|
{{BKIT_MANAGED_MARKER}}
|
|
6
4
|
|
|
5
|
+
<!-- Note: @bkit-audit-generate fills this template. The report lives at `docs/audits/{YYYYMM}/{slug}.md`, where `{YYYYMM}` is the UTC month of the run and `{slug}` is this file's name without `bkit-audit-` and `.md`. **If** that month already has `{slug}.md` or `{slug}-{TIMESTAMP}.md` → write `{slug}-{TIMESTAMP}.md`, where `{TIMESTAMP}` is the output of `date -u +%Y%m%dT%H%M%SZ`. NEVER overwrite an earlier report. The report is stamped with a `bkit:anchor` block that records the audited commit (`baseSha`) and branch (`baseRef`). NEVER write or edit that block by hand. -->
|
|
6
|
+
|
|
7
7
|
# Privacy Audit
|
|
8
8
|
|
|
9
9
|
> [!CAUTION]
|
|
10
|
-
> **Purpose:**
|
|
10
|
+
> **Purpose:** The lifecycle of personal data — what is held, where it goes, how long it stays, whether deletion removes the person, and whether what people are told matches the code.
|
|
11
11
|
>
|
|
12
12
|
> **Rules:**
|
|
13
13
|
>
|
|
14
|
-
> - Name each field and where it lives
|
|
14
|
+
> - Name each field and where it lives.
|
|
15
|
+
> - NEVER copy a personal-data value into the report.
|
|
15
16
|
|
|
16
17
|
## Universal Instructions
|
|
17
18
|
|
|
18
19
|
### Context & Goals
|
|
19
20
|
|
|
20
|
-
Privacy rules land with features
|
|
21
|
+
Privacy rules land with features, and nothing re-reads them together. The failure this audit targets is the drift that follows. Examples: a new table without retention, a processor missing from the list, a deletion that cascades only through the tables that existed when it was written, a privacy policy that describes an older app. None of these fails a test. Most findings are owner decisions (keep / prune / anonymise), not code changes.
|
|
21
22
|
|
|
22
|
-
**Applies when:** system holds personal data (accounts, contact details, content about people).
|
|
23
|
+
**Applies when:** the system holds personal data (accounts, contact details, content about people). **If** it does not → write one `N/A` row with its evidence, and never report the surface as "clean".
|
|
23
24
|
|
|
24
|
-
**Cadence:** once before launch, then
|
|
25
|
+
**Cadence:** Run once before launch, then at least once a year; a run can serve as the annual privacy review. Run an extra pass when a migration adds personal-data tables / columns, or a new processor lands.
|
|
25
26
|
|
|
26
|
-
**Anchor Standards:**
|
|
27
|
+
**Anchor Standards:** The standards are the regimes that `Regimes` finds apply, and the guidance they rely on. For statutes, also record the compilation.
|
|
27
28
|
|
|
28
29
|
- GDPR and UK GDPR.
|
|
29
30
|
- ePrivacy Art 5(3) and EDPB Guidelines 2/2023.
|
|
30
31
|
- EDPB DPIA criteria (WP248 rev.01).
|
|
31
|
-
- Children's rules (e.g
|
|
32
|
-
- National / state laws (e.g
|
|
32
|
+
- Children's rules (e.g., COPPA, ICO Age Appropriate Design Code).
|
|
33
|
+
- National / state laws (e.g., Australian Privacy Act, CCPA).
|
|
33
34
|
|
|
34
35
|
### Scope
|
|
35
36
|
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
37
|
+
- Find the applicable regimes and their changes.
|
|
38
|
+
- Map every personal-data store: DB rows, file storage, derived data (embeddings), logs and device storage.
|
|
39
|
+
- Check children's data: age knowledge, consent and defaults.
|
|
40
|
+
- Check impact assessments.
|
|
41
|
+
- List every recipient system, and its contract / transfer basis.
|
|
42
|
+
- Check retention, deletion and the other rights.
|
|
43
|
+
- Compare the privacy policy, in-app copy and store declarations with the code.
|
|
44
|
+
- Check breach readiness.
|
|
44
45
|
|
|
45
46
|
### Out of Scope
|
|
46
47
|
|
|
@@ -57,43 +58,43 @@ Privacy rules land with features; nothing re-reads them together. Drift: new tab
|
|
|
57
58
|
|
|
58
59
|
#### Core
|
|
59
60
|
|
|
60
|
-
- [ ] **Permissions:** blocked
|
|
61
|
-
- [ ] **Published Policy:** Step 10 — privacy policy and in-app privacy copy readable
|
|
62
|
-
- [ ] **Web:** Steps 2, 6, 12 — regulator and law sources, vendor sub-processor pages, anchor standards. Fallback: regime changes and versions
|
|
61
|
+
- [ ] **Permissions:** every blocked call is recorded.
|
|
62
|
+
- [ ] **Published Policy:** Step 10 — the privacy policy and in-app privacy copy, readable from a repo file or a live URL. Fallback: **If** they are unreadable → mark them `Not Checked`. **If** there is no policy → it is a finding.
|
|
63
|
+
- [ ] **Web:** Steps 2, 6, 12 — regulator and law sources, vendor sub-processor pages, anchor standards. Fallback: record regime changes and versions as unread.
|
|
63
64
|
|
|
64
65
|
#### Conditional
|
|
65
66
|
|
|
66
|
-
- [ ] **Live Catalogue:**
|
|
67
|
-
- [ ] **Vendor Settings:**
|
|
68
|
-
- [ ] **Agreements:**
|
|
67
|
+
- [ ] **Live Catalogue:** **If** there is a hosted DB → Steps 3, 7 — a read-only listing of non-row stores and purge jobs (e.g., platform MCP `execute_sql`). Fallback: read migrations only, and treat live state as a hypothesis.
|
|
68
|
+
- [ ] **Vendor Settings:** **If** there are third-party processors → Steps 6, 7 — retention, scrubbing and region (e.g., vendor dashboard, API, MCP). Fallback: read code and docs only, and mark vendor settings `Not Checked`.
|
|
69
|
+
- [ ] **Agreements:** **If** there are processors → Steps 6, 11 — signed processing agreements and breach-notice terms (e.g., repo copies, contract store). Fallback: read public vendor terms, and mark signed status `Not Checked`.
|
|
69
70
|
|
|
70
71
|
### 🔒 Gate 1: Prerequisites Check
|
|
71
72
|
|
|
72
|
-
- [ ] **Gaps named:** every missing item names its fallback and `Not Checked` entry.
|
|
73
|
-
- [ ] **Gate 1 — Verified:**
|
|
73
|
+
- [ ] **Gaps named:** every missing item names its fallback and its `Not Checked` entry.
|
|
74
|
+
- [ ] **Gate 1 — Verified:** every item above, every Core item and every applicable Conditional item is checked.
|
|
74
75
|
|
|
75
76
|
### Probe Steps
|
|
76
77
|
|
|
77
|
-
- [ ] **Step 1 — Previous Run:** **Done when:**
|
|
78
|
-
- [ ] **Step 2 — Regimes:**
|
|
79
|
-
- [ ] **Step 3 — Inventory:**
|
|
80
|
-
- [ ] **Step 4 — Children:**
|
|
81
|
-
- [ ] **Step 5 — Assessments:**
|
|
82
|
-
- [ ] **Step 6 — Recipients:** Find in code (SDK imports, outbound hosts), not docs: hosting, DB, error tracking, background jobs, email, payments, maps, model providers, anything new.
|
|
83
|
-
- [ ] **Step 7 — Retention:**
|
|
84
|
-
- [ ] **Step 8 — Deletion:** Read account and tenant deletion code against inventory.
|
|
85
|
-
- [ ] **Step 9 — Rights:**
|
|
86
|
-
- [ ] **Step 10 — Claims:** Read the privacy policy linked from sign-up and in-app privacy copy
|
|
87
|
-
- [ ] **Step 11 — Breaches:**
|
|
88
|
-
- [ ] **Step 12 — Standards:** Confirm current version
|
|
89
|
-
- [ ] **Step 13 — Anything Else:** (a)
|
|
78
|
+
- [ ] **Step 1 — Previous Run:** **Done when:** `Previous Run` holds the closure rate, or the run is marked baseline.
|
|
79
|
+
- [ ] **Step 2 — Regimes:** For each candidate regime, decide whether it applies, and why: user locations, turnover / volume thresholds, exemptions and their exceptions, a child-directed service or actual knowledge. **If** a regime is not binding → mark which checks run as good practice. List the law / regulator / code changes since the previous report's date, with source links. **Done when:** `Regimes` has a row per regime: applies · why · changes.
|
|
80
|
+
- [ ] **Step 3 — Inventory:** Read the schema and code. For each table / column / payload, record what it holds, whose data it is (user / non-user member / third party named in content), why it is held, where it is documented, whether it is strictly necessary, and its default. Optional data that is on by default, or model-prompt data beyond the task's need, is a finding. Group the rows by purpose into a record of processing: lawful basis, subjects, recipients, transfer destination and mechanism, and security measure. **If** a purpose rests on consent → record the consent record and the withdrawal path. **If** content names third parties → record the legitimate-interests assessment and the notify decision. Cover non-row stores: file storage, device caches and derived data (embeddings are as personal as their source text). Classify device storage (cookies, local storage, native caches, SDK identifiers) as strictly necessary or as needing consent. **Done when:** `Inventory` lists every store, and a store no doc mentions is a finding.
|
|
81
|
+
- [ ] **Step 4 — Children:** **If** the product can hold children's data → state on every run: how a child is known (field / role / parent statement / not at all) and where; the consent path per age band, and the rule that sets it; the child defaults (visibility, location, sharing, automated processing); what happens when a child crosses an age threshold (re-consent / role change / nothing); and parent monitoring of a child (most children's rules require telling the child). **Done when:** the answers are in `Inventory`, or evidence that the product cannot hold children's data is in `Checked`.
|
|
82
|
+
- [ ] **Step 5 — Assessments:** Find the current impact assessment (DPIA / PIA) for each inventory purpose, and list the purposes none covers. Children, new technology (language models) and third-party data in content usually meet the threshold. Compare the features added since the previous report's commit with the assessment register; an unassessed feature is a finding. **Done when:** every purpose has an assessment or a finding.
|
|
83
|
+
- [ ] **Step 6 — Recipients:** Find recipients in code (SDK imports, outbound hosts), not docs: hosting, DB, error tracking, background jobs, email, payments, maps, model providers, and anything new. For each recipient, record what it receives, why, and how long it keeps it. Verify in code and tests every vendor-side control the docs claim (e.g., zero-retention model calls, an error-tracker scrub list). For each processor, record whether a processing agreement is signed (with a children's-data assurance if required); the sub-processor list URL, when it was last checked, and the change notice; the region and transfer mechanism; the processor chain (routers fan out); and the exit plan (export, deletion on exit, replacement). **Done when:** `Recipients` has a row per system, and an undocumented one is a finding.
|
|
84
|
+
- [ ] **Step 7 — Retention:** For each inventory row, record what deletes or anonymises it (scheduled job / worker / cascade / nothing), and compare the stated period with the enforcing mechanism. A good answer gives the period, the enforcing job and the lawful basis. "Nothing removes it" is a finding only when there is no recorded decision in `docs/decisions.jsonl`. The exception: children's data needs a deletion timeframe regardless, because most children's rules forbid keeping it indefinitely. **If** a published retention policy is required → check the inventory against the published text. **Done when:** `Retention` has a row per store: period · mechanism, or "no decision".
|
|
85
|
+
- [ ] **Step 8 — Deletion:** Read the account and tenant deletion code against the inventory. Record the stores reached and missed: email- / name-keyed rows, file objects, and rows in other tenants that name the person. For the external systems in `Recipients`, check whether deleting our row deletes theirs (payment customers, error-tracker user context, job payloads, backups). On every run, ask what still maps a deleted user's id back to a person. A deletion test must go red on a missed store; "user can no longer sign in" is not a deletion test. **Done when:** `Deletion` lists every store reached / missed.
|
|
86
|
+
- [ ] **Step 9 — Rights:** For each right, record how it works today, or that it does not: access and export (machine-readable where required); correction; partial erasure that keeps the account (including by a parent for a child); a request from a third party named in content; objection and restriction; requester verification (including a parent for a child); the response deadline per applicable regime; and the request log and complaints route. **If** an automated action has a real effect (e.g., a model creating / changing / deleting user data) → record "significant effect: yes / no" and the reasoning. A right with no exercise path is an owner decision, not a defect. **Done when:** `Rights` has a line per right.
|
|
87
|
+
- [ ] **Step 10 — Claims:** Read the privacy policy linked from sign-up and the in-app privacy copy, and compare each claim with `Inventory`, `Recipients`, `Retention`, `Deletion` and `Rights`. An unnamed processor, a wrong retention period, an unkept promise or an unmentioned significant automated decision is a finding. Check the store privacy declarations the same way once listings exist. **If** child members are possible → check for a child-readable policy and collection notices, and for a notice to the child when a parent can monitor. Check the terms, refund wording and accessibility statement the same way. **Done when:** `Claims` has a row per claim: matches / finding.
|
|
88
|
+
- [ ] **Step 11 — Breaches:** Check for a written breach plan per applicable regime: the regulator clock and when affected people are told; an internal log of every breach, notifiable or not; and each processor's notice duty and speed from its agreement. **If** a children's regime requires a written security programme → check for a named coordinator, a risk assessment at least yearly, and tested safeguards. **Done when:** every requirement is met or has a finding.
|
|
89
|
+
- [ ] **Step 12 — Standards:** Confirm the current version of each anchor standard, and read what changed since the previous report's version. Give `Standards Coverage` one row per standard and per obligation this procedure relies on, each marked checked (naming the step), not applicable (saying why) or finding. Mark each recommended practice the project does not apply as adopt (with a proposed step), reject (saying why) or not applicable. **Done when:** no row is empty.
|
|
90
|
+
- [ ] **Step 13 — Anything Else:** (a) Give a one-line verdict on each change since the previous report's commit that touches personal data: migrations, tables / columns, routes and server actions, SDKs and outbound hosts, buckets, consent screens and privacy copy. (b) In a bounded pass of about 30 minutes, note what a senior privacy counsel would flag that no step asks about. Read what happened since the previous run (incidents, new `docs/failures.jsonl` rows), and ask what no step would catch. End with what a regulator would ask that this run cannot answer, and the legal questions for the owner / counsel. **Done when:** `Beyond the Steps` holds both passes and the regulator questions, or says `none`. **If** one class of issue is seen on 2 runs → propose a step for it in `Process Improvements`.
|
|
90
91
|
|
|
91
92
|
### 🔒 Gate 2: Probes Check
|
|
92
93
|
|
|
93
|
-
- [ ] **Steps complete:** every step `[x]`, or
|
|
94
|
-
- [ ] **Evidence:** every finding cites
|
|
95
|
-
- [ ] **No values:** no personal-data value anywhere in the report.
|
|
96
|
-
- [ ] **Gate 2 — Verified:**
|
|
94
|
+
- [ ] **Steps complete:** every step is `[x]`, or skipped with evidence that its surface is absent.
|
|
95
|
+
- [ ] **Evidence:** every finding cites evidence someone can check again, and the tool that produced it.
|
|
96
|
+
- [ ] **No values:** no personal-data value appears anywhere in the report.
|
|
97
|
+
- [ ] **Gate 2 — Verified:** every item above holds.
|
|
97
98
|
|
|
98
99
|
## Findings
|
|
99
100
|
|
|
@@ -105,14 +106,14 @@ Privacy rules land with features; nothing re-reads them together. Drift: new tab
|
|
|
105
106
|
| `MEDIUM` | Doc describes a store / processor wrongly; purpose without impact assessment; right without exercise path; missing breach-plan element |
|
|
106
107
|
| `LOW` | Undocumented field already covered by deletion, retention, and processor list; wording drift changing no obligation |
|
|
107
108
|
|
|
108
|
-
Within a severity
|
|
109
|
+
Within a severity, list children's data first. **If** there are no users yet → do not lower the severity for empty production tables.
|
|
109
110
|
|
|
110
111
|
<!-- prettier-ignore -->
|
|
111
112
|
| ID | Severity | Location | Evidence | Expected |
|
|
112
113
|
| --- | --- | --- | --- | --- |
|
|
113
114
|
| PENDING | PENDING | PENDING | PENDING | PENDING |
|
|
114
115
|
|
|
115
|
-
|
|
116
|
+
**If** the run finds nothing → write one row: `None`.
|
|
116
117
|
|
|
117
118
|
## Report
|
|
118
119
|
|
|
@@ -185,13 +186,16 @@ PENDING
|
|
|
185
186
|
|
|
186
187
|
### 🔒 Gate 3: Report Check
|
|
187
188
|
|
|
188
|
-
- [ ] **No placeholders:** no `PENDING` left
|
|
189
|
-
- [ ] **Summary:**
|
|
190
|
-
- [ ] **Annual Review:** states whether this run serves as the annual privacy review
|
|
191
|
-
- [ ] **
|
|
192
|
-
- [ ] **
|
|
193
|
-
- [ ] **
|
|
194
|
-
- [ ] **
|
|
189
|
+
- [ ] **No placeholders:** no `PENDING` is left.
|
|
190
|
+
- [ ] **Summary:** `Summary` gives the count per severity.
|
|
191
|
+
- [ ] **Annual Review:** `Annual Review` states whether this run serves as the annual privacy review.
|
|
192
|
+
- [ ] **Training:** `Annual Review` states whether everyone with children's-data access completed privacy training.
|
|
193
|
+
- [ ] **Writes:** this run changed only this report, the template's `Project Instructions` and its own `docs/failures.jsonl` rows.
|
|
194
|
+
- [ ] **Throwaways removed:** every throwaway worktree or remote target is removed.
|
|
195
|
+
- [ ] **Process Improvements:** `Universal` and `Project` are both filled.
|
|
196
|
+
- [ ] **Suggested Issues:** every `MEDIUM`+ finding ID is in exactly one `Suggested Issues` row.
|
|
197
|
+
- [ ] **Next Step:** every `Suggested Issues` row has a `Next Step`.
|
|
198
|
+
- [ ] **Gate 3 — Verified:** every item above holds.
|
|
195
199
|
|
|
196
200
|
<!-- bkit:end -->
|
|
197
201
|
|