@hassangameryt/freeflow 0.8.0 → 0.9.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/plugins/marketplace.json +2 -2
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +2 -2
- package/.codex-plugin/plugin.json +3 -3
- package/.cursor-plugin/plugin.json +1 -1
- package/README.md +96 -149
- package/capabilities/cognitive-routing/SKILL.md +21 -129
- package/capabilities/cognitive-routing/references/coordinator.md +163 -0
- package/capabilities/cognitive-routing/references/worker.md +38 -0
- package/capabilities/compaction/SKILL.md +3 -3
- package/capabilities/compaction/references/summary-format.md +26 -15
- package/capabilities/messaging/SKILL.md +49 -0
- package/capabilities/task-memory/SKILL.md +87 -0
- package/command-surface.json +6 -54
- package/gemini-extension.json +1 -1
- package/hooks/claude/hooks.json +13 -3
- package/hooks/codex/hooks.json +2 -1
- package/hooks/shared/runtime-context.mjs +69 -77
- package/package.json +25 -8
- package/pi-extension/dist/ask-user/ask.js +108 -0
- package/pi-extension/dist/ask-user/form.js +250 -0
- package/pi-extension/dist/ask-user/questions.js +66 -0
- package/pi-extension/dist/ask-user/tool.js +124 -0
- package/pi-extension/dist/cognitive-routing/assembler.js +35 -11
- package/pi-extension/dist/cognitive-routing/bootstrap.js +90 -0
- package/pi-extension/dist/cognitive-routing/config.js +3 -4
- package/pi-extension/dist/cognitive-routing/event-store.js +4 -1
- package/pi-extension/dist/cognitive-routing/gate.js +20 -5
- package/pi-extension/dist/cognitive-routing/handlers.js +15 -13
- package/pi-extension/dist/cognitive-routing/model-control.js +17 -8
- package/pi-extension/dist/cognitive-routing/projection.js +23 -6
- package/pi-extension/dist/cognitive-routing/provenance.js +3 -1
- package/pi-extension/dist/cognitive-routing/render.js +15 -15
- package/pi-extension/dist/cognitive-routing/runtime.js +4 -2
- package/pi-extension/dist/cognitive-routing/schemas.js +4 -4
- package/pi-extension/dist/cognitive-routing/session.js +3 -1
- package/pi-extension/dist/cognitive-routing/sources.js +29 -4
- package/pi-extension/dist/cognitive-routing/state.js +18 -8
- package/pi-extension/dist/cognitive-routing/status.js +4 -3
- package/pi-extension/dist/cognitive-routing/tools.js +29 -15
- package/pi-extension/dist/cognitive-routing/types.js +10 -1
- package/pi-extension/dist/compaction/carry.js +36 -22
- package/pi-extension/dist/compaction/config.js +4 -2
- package/pi-extension/dist/compaction/controller.js +52 -29
- package/pi-extension/dist/compaction/harness.js +19 -3
- package/pi-extension/dist/compaction/results.js +14 -13
- package/pi-extension/dist/compaction/tool.js +6 -6
- package/pi-extension/dist/host/catalog.js +20 -35
- package/pi-extension/dist/host/config-validation.js +233 -0
- package/pi-extension/dist/host/config.js +78 -91
- package/pi-extension/dist/host/inbound.js +142 -0
- package/pi-extension/dist/host/projection-tags.js +1 -1
- package/pi-extension/dist/host/prompts.js +24 -13
- package/pi-extension/dist/host/read-only-session.js +6 -1
- package/pi-extension/dist/host/request-history.js +7 -3
- package/pi-extension/dist/host/rows.js +25 -0
- package/pi-extension/dist/host/runtime-state.js +17 -2
- package/pi-extension/dist/host/section-keeper.js +85 -0
- package/pi-extension/dist/host/settings/freeflow-command.js +846 -93
- package/pi-extension/dist/host/settings/settings-view.js +27 -8
- package/pi-extension/dist/host/status.js +19 -5
- package/pi-extension/dist/index.js +638 -72
- package/pi-extension/dist/messaging/config.js +27 -0
- package/pi-extension/dist/messaging/messaging.js +398 -0
- package/pi-extension/dist/messaging/registry.js +57 -0
- package/pi-extension/dist/messaging/render.js +90 -0
- package/pi-extension/dist/messaging/tools.js +109 -0
- package/pi-extension/dist/messaging/transport.js +101 -0
- package/pi-extension/dist/provider-support/cache/keepalive.js +16 -4
- package/pi-extension/dist/task-memory/config.js +49 -0
- package/pi-extension/dist/task-memory/registry.js +119 -0
- package/pi-extension/dist/task-memory/render.js +107 -0
- package/pi-extension/dist/task-memory/runtime.js +994 -0
- package/pi-extension/dist/task-memory/tool.js +233 -0
- package/pi-extension/dist/tool-execution/apply-patch/tool.js +1 -1
- package/pi-extension/dist/tool-execution/background.js +220 -28
- package/pi-extension/dist/tool-execution/config.js +14 -3
- package/pi-extension/dist/tool-execution/file-tracking.js +24 -4
- package/pi-extension/dist/tool-execution/guidance-notices.js +124 -0
- package/pi-extension/dist/tool-execution/skill-reads.js +143 -0
- package/pi-extension/dist/tool-execution/tools.js +2 -2
- package/runtime/prompts/cognitive-routing.md +4 -4
- package/runtime/prompts/core.md +24 -14
- package/runtime/prompts/interaction-contract.md +7 -4
- package/runtime/prompts/tool-execution.md +3 -16
- package/runtime/prompts/working-method.md +16 -99
- package/skills/deliver-work/SKILL.md +76 -0
- package/skills/deliver-work/references/branch-closeout.md +134 -0
- package/skills/deliver-work/references/commit.md +83 -0
- package/skills/deliver-work/references/launch.md +94 -0
- package/skills/deliver-work/references/release.md +85 -0
- package/skills/deliver-work/scripts/commit-state.mjs +139 -0
- package/skills/deliver-work/scripts/delivery-state.mjs +107 -0
- package/skills/deliver-work/scripts/lib/git-state.mjs +178 -0
- package/skills/deliver-work/scripts/push-route.mjs +122 -0
- package/skills/deliver-work/scripts/release-preflight.mjs +177 -0
- package/skills/discuss-work/SKILL.md +148 -0
- package/skills/{discuss → discuss-work}/references/discussion-continuity.md +10 -27
- package/skills/discuss-work/references/learning-action.md +36 -0
- package/skills/discuss-work/scripts/choices.mjs +101 -0
- package/skills/discuss-work/scripts/lib/choices.mjs +159 -0
- package/skills/evaluate-behavior/SKILL.md +107 -0
- package/skills/evaluate-behavior/references/authoring.md +381 -0
- package/skills/evaluate-behavior/references/coding-tasks.md +145 -0
- package/skills/evaluate-behavior/references/conversations-pipelines-judges.md +177 -0
- package/skills/evaluate-behavior/references/design-and-measurement.md +273 -0
- package/skills/evaluate-behavior/references/running-and-evidence.md +245 -0
- package/skills/evaluate-behavior/scripts/claude-guard.mjs +76 -0
- package/skills/evaluate-behavior/scripts/guard-rules.mjs +309 -0
- package/skills/evaluate-behavior/scripts/lib/agreement.mjs +90 -0
- package/skills/evaluate-behavior/scripts/lib/arms.mjs +55 -0
- package/skills/evaluate-behavior/scripts/lib/budget.mjs +87 -0
- package/skills/evaluate-behavior/scripts/lib/build-source.mjs +287 -0
- package/skills/evaluate-behavior/scripts/lib/clear.mjs +74 -0
- package/skills/evaluate-behavior/scripts/lib/container.mjs +395 -0
- package/skills/evaluate-behavior/scripts/lib/decision.mjs +418 -0
- package/skills/evaluate-behavior/scripts/lib/definitions.mjs +1072 -0
- package/skills/evaluate-behavior/scripts/lib/freeflow.mjs +103 -0
- package/skills/evaluate-behavior/scripts/lib/grade-command.mjs +591 -0
- package/skills/evaluate-behavior/scripts/lib/grade-comparison.mjs +90 -0
- package/skills/{evaluate-skill → evaluate-behavior}/scripts/lib/grade-interaction.mjs +19 -18
- package/skills/{evaluate-skill → evaluate-behavior}/scripts/lib/grade-support.mjs +32 -5
- package/skills/{evaluate-skill → evaluate-behavior}/scripts/lib/grade-workspace.mjs +28 -12
- package/skills/evaluate-behavior/scripts/lib/grade.mjs +101 -0
- package/skills/evaluate-behavior/scripts/lib/hooks.mjs +98 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/confinement.mjs +196 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/constraints.mjs +111 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/index.mjs +48 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/isolation.mjs +74 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/launch.mjs +123 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/model-call.mjs +73 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/recorder.mjs +178 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/session.mjs +494 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/claude-code/skills.mjs +81 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/index.mjs +31 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/names.mjs +3 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/pi/confinement.mjs +173 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/pi/host.mjs +148 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/pi/index.mjs +70 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/pi/isolation.mjs +81 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/pi/model-call.mjs +79 -0
- package/skills/evaluate-behavior/scripts/lib/hosts/pi/process.mjs +241 -0
- package/skills/{evaluate-skill/scripts/lib → evaluate-behavior/scripts/lib/hosts/pi}/rpc.mjs +144 -26
- package/skills/evaluate-behavior/scripts/lib/identity.mjs +82 -0
- package/skills/evaluate-behavior/scripts/lib/judge.mjs +688 -0
- package/skills/evaluate-behavior/scripts/lib/metrics.mjs +332 -0
- package/skills/evaluate-behavior/scripts/lib/model-call.mjs +17 -0
- package/skills/evaluate-behavior/scripts/lib/participants.mjs +616 -0
- package/skills/{evaluate-skill → evaluate-behavior}/scripts/lib/process.mjs +22 -0
- package/skills/evaluate-behavior/scripts/lib/queue.mjs +54 -0
- package/skills/evaluate-behavior/scripts/lib/reference.mjs +343 -0
- package/skills/evaluate-behavior/scripts/lib/reuse.mjs +277 -0
- package/skills/evaluate-behavior/scripts/lib/review.mjs +933 -0
- package/skills/evaluate-behavior/scripts/lib/runner.mjs +732 -0
- package/skills/{evaluate-skill → evaluate-behavior}/scripts/lib/sandbox.mjs +119 -14
- package/skills/evaluate-behavior/scripts/lib/scan-shell.mjs +457 -0
- package/skills/evaluate-behavior/scripts/lib/scan.mjs +479 -0
- package/skills/evaluate-behavior/scripts/lib/seal.mjs +91 -0
- package/skills/evaluate-behavior/scripts/lib/shell.mjs +560 -0
- package/skills/evaluate-behavior/scripts/lib/source-override.mjs +64 -0
- package/skills/evaluate-behavior/scripts/lib/subject-file.mjs +88 -0
- package/skills/{evaluate-skill/scripts/lib/pi.mjs → evaluate-behavior/scripts/lib/subject.mjs} +235 -265
- package/skills/evaluate-behavior/scripts/lib/task-copy.mjs +124 -0
- package/skills/evaluate-behavior/scripts/lib/trials.mjs +524 -0
- package/skills/evaluate-behavior/scripts/lib/validity.mjs +68 -0
- package/skills/evaluate-behavior/scripts/lib/view-html.mjs +454 -0
- package/skills/{evaluate-skill → evaluate-behavior}/scripts/lib/view.mjs +159 -18
- package/skills/{evaluate-skill → evaluate-behavior}/scripts/pi-command-tool.mjs +21 -6
- package/skills/evaluate-behavior/scripts/pi-container-route.mjs +23 -0
- package/skills/evaluate-behavior/scripts/pi-guard.mjs +77 -0
- package/skills/evaluate-behavior/scripts/pi-login-refresh.mjs +31 -0
- package/skills/evaluate-behavior/scripts/skill-eval.mjs +586 -0
- package/skills/execute-work/SKILL.md +96 -104
- package/skills/execute-work/references/code-practices.md +27 -51
- package/skills/execute-work/references/design.md +271 -0
- package/skills/execute-work/references/diagnose.md +117 -0
- package/skills/execute-work/references/migration.md +108 -0
- package/skills/execute-work/references/simplify.md +65 -0
- package/skills/execute-work/scripts/self-review.mjs +422 -0
- package/skills/execute-work/scripts/touch-map.mjs +290 -0
- package/skills/review-work/SKILL.md +89 -65
- package/skills/review-work/references/adjudication.md +94 -0
- package/skills/review-work/references/artifact.md +198 -0
- package/skills/review-work/references/evals-and-judges.md +66 -0
- package/skills/review-work/references/work.md +177 -0
- package/skills/review-work/scripts/check-brief.mjs +128 -0
- package/skills/review-work/scripts/review-packet.mjs +233 -0
- package/skills/setup-freeflow/SKILL.md +68 -17
- package/skills/track-work/SKILL.md +52 -20
- package/skills/track-work/references/handoff.md +190 -0
- package/skills/track-work/references/projects.md +51 -0
- package/skills/track-work/references/working-record-format.md +36 -18
- package/skills/track-work/scripts/lib/document.mjs +17 -13
- package/skills/track-work/scripts/lib/format.mjs +2 -0
- package/skills/track-work/scripts/lib/recover.mjs +254 -0
- package/skills/track-work/scripts/lib/registry.mjs +656 -0
- package/skills/track-work/scripts/lib/search.mjs +40 -0
- package/skills/track-work/scripts/lib/store.mjs +46 -15
- package/skills/track-work/scripts/lib/views.mjs +50 -1
- package/skills/track-work/scripts/working-record.mjs +232 -13
- package/skills/verify-work/SKILL.md +45 -37
- package/skills/verify-work/references/feature-map.md +120 -0
- package/skills/verify-work/references/runtime-evidence.md +203 -0
- package/skills/verify-work/references/test-design.md +25 -6
- package/skills/verify-work/scripts/test-changes.mjs +246 -0
- package/skills/write-docs/SKILL.md +113 -25
- package/skills/write-docs/references/documentation-shapes.md +68 -3
- package/skills/write-docs/references/spec-and-plan-shapes.md +308 -0
- package/skills/write-docs/scripts/artifact-check.mjs +148 -0
- package/skills/write-docs/scripts/docs-check.mjs +96 -6
- package/skills/write-docs/scripts/plan-lint.mjs +123 -0
- package/skills/write-skill/SKILL.md +92 -52
- package/skills/write-skill/references/activation-and-wording.md +143 -0
- package/skills/write-skill/references/placement-and-dependencies.md +154 -0
- package/skills/write-skill/scripts/lib/compare.mjs +701 -0
- package/skills/write-skill/scripts/lib/skill-author.mjs +197 -3
- package/skills/write-skill/scripts/skill-author.mjs +51 -8
- package/capabilities/cognitive-routing/references/both-mode.md +0 -36
- package/capabilities/cognitive-routing/references/executor-mode.md +0 -48
- package/capabilities/cognitive-routing/references/helper-mode.md +0 -47
- package/plugin.json +0 -33
- package/skills/action-selection/SKILL.md +0 -92
- package/skills/action-selection/references/trajectory-stalls.md +0 -73
- package/skills/bypass/SKILL.md +0 -153
- package/skills/commit-work/SKILL.md +0 -93
- package/skills/commit-work/references/git-state-edges.md +0 -94
- package/skills/commit-work/references/simple-push.md +0 -94
- package/skills/commit-work/references/staging-decisions.md +0 -106
- package/skills/decision-gate/SKILL.md +0 -87
- package/skills/design-for-depth/SKILL.md +0 -108
- package/skills/design-for-depth/references/design-pressure-signals.md +0 -84
- package/skills/design-for-depth/references/implementation-decisions.md +0 -76
- package/skills/design-for-depth/references/interface-design-loop.md +0 -105
- package/skills/design-for-depth/references/module-and-dependency-design.md +0 -117
- package/skills/design-for-depth/references/state-and-failure-boundaries.md +0 -125
- package/skills/diagnose-failure/SKILL.md +0 -140
- package/skills/diagnose-failure/references/diagnostic-loop-catalog.md +0 -50
- package/skills/diagnose-failure/references/flaky-and-performance-diagnosis.md +0 -51
- package/skills/discuss/SKILL.md +0 -140
- package/skills/evaluate-skill/SKILL.md +0 -188
- package/skills/evaluate-skill/references/evaluation-definition-schema.md +0 -415
- package/skills/evaluate-skill/references/evaluation-design.md +0 -112
- package/skills/evaluate-skill/references/execution-and-evidence.md +0 -111
- package/skills/evaluate-skill/references/review-and-revision.md +0 -94
- package/skills/evaluate-skill/scripts/lib/definitions.mjs +0 -448
- package/skills/evaluate-skill/scripts/lib/grade-comparison.mjs +0 -60
- package/skills/evaluate-skill/scripts/lib/grade.mjs +0 -64
- package/skills/evaluate-skill/scripts/lib/review.mjs +0 -196
- package/skills/evaluate-skill/scripts/lib/runner.mjs +0 -405
- package/skills/evaluate-skill/scripts/lib/trials.mjs +0 -103
- package/skills/evaluate-skill/scripts/pi-guard.mjs +0 -181
- package/skills/evaluate-skill/scripts/skill-eval.mjs +0 -182
- package/skills/execute-work/references/execute-work-edges.md +0 -78
- package/skills/finish-branch/SKILL.md +0 -117
- package/skills/finish-branch/references/integration-options.md +0 -80
- package/skills/handoff/SKILL.md +0 -82
- package/skills/handoff/references/handoff-templates.md +0 -150
- package/skills/launch-work/SKILL.md +0 -116
- package/skills/launch-work/references/launch-readiness.md +0 -85
- package/skills/migration-work/SKILL.md +0 -115
- package/skills/migration-work/references/migration-lifecycle.md +0 -82
- package/skills/release-work/SKILL.md +0 -118
- package/skills/release-work/references/release-evidence.md +0 -78
- package/skills/review-artifact/SKILL.md +0 -143
- package/skills/review-artifact/references/adjudicate-artifact-review.md +0 -101
- package/skills/review-artifact/references/independent-artifact-reviewer-contract.md +0 -159
- package/skills/review-work/references/adjudicate-work-review.md +0 -97
- package/skills/review-work/references/independent-work-reviewer-contract.md +0 -139
- package/skills/review-work/references/security-risk-lens.md +0 -67
- package/skills/setup-freeflow/references/activation-contract.md +0 -103
- package/skills/setup-freeflow/references/host-setup.md +0 -67
- package/skills/simplify-code/SKILL.md +0 -85
- package/skills/simplify-code/references/simplification-patterns.md +0 -70
- package/skills/verify-work/references/browser-runtime-evidence.md +0 -51
- package/skills/verify-work/references/integration-evidence.md +0 -49
- package/skills/verify-work/references/performance-evidence.md +0 -59
- package/skills/workflow/SKILL.md +0 -171
- package/skills/workflow/references/domain-skill-composition.md +0 -45
- package/skills/write-plan/SKILL.md +0 -92
- package/skills/write-plan/references/plan-shapes.md +0 -156
- package/skills/write-skill/references/activation-boundaries.md +0 -106
- package/skills/write-skill/references/agent-first-instructions.md +0 -133
- package/skills/write-skill/references/progressive-disclosure.md +0 -129
- package/skills/write-skill/references/skill-dependency-graphs.md +0 -192
- package/skills/write-spec/SKILL.md +0 -85
- package/skills/write-spec/references/artifact-standards.md +0 -86
- package/skills/write-spec/references/decision-records.md +0 -80
- package/skills/write-spec/references/spec-shapes.md +0 -143
- /package/skills/{evaluate-skill → evaluate-behavior}/scripts/lib/evidence.mjs +0 -0
- /package/skills/{evaluate-skill → evaluate-behavior}/scripts/pi-observer.mjs +0 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// Checks that every step of a Plan names the check that will show it worked (references/spec-and-plan-shapes.md).
|
|
3
|
+
// A step is a "### Slice" or "### Step" block, or an item of the list under "Ordered actions or slices", "Steps" or
|
|
4
|
+
// another heading that holds the Plan's ordered work. A block names its check in a filled field such as "Tests or
|
|
5
|
+
// observations:", "Check:" or "Verification claim...:"; a list item names it inline ("check: ...", "verify ...",
|
|
6
|
+
// "test ...", "observe ..."). It checks presence only; whether the check could catch a wrong result is the author's
|
|
7
|
+
// and the reviewer's judgment.
|
|
8
|
+
// Usage: plan-lint.mjs <plan.md>... [--json]
|
|
9
|
+
// Exit code 0 when every step names a check, 1 when a step does not or no step was found, 2 on a usage error.
|
|
10
|
+
import { existsSync, readFileSync } from "node:fs";
|
|
11
|
+
import { resolve } from "node:path";
|
|
12
|
+
import { parseArgs } from "node:util";
|
|
13
|
+
|
|
14
|
+
const USAGE = "Usage: plan-lint.mjs <plan.md>... [--json]";
|
|
15
|
+
let parsed;
|
|
16
|
+
try {
|
|
17
|
+
parsed = parseArgs({ allowPositionals: true, options: { json: { type: "boolean", default: false } } });
|
|
18
|
+
} catch (error) {
|
|
19
|
+
console.error(`${error.message}\n${USAGE}`);
|
|
20
|
+
process.exit(2);
|
|
21
|
+
}
|
|
22
|
+
const { values, positionals } = parsed;
|
|
23
|
+
if (!positionals.length) {
|
|
24
|
+
console.error(USAGE);
|
|
25
|
+
process.exit(2);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
const STEP_HEADING = /^#{2,4}\s+(Slice|Step|Phase step|Task)\b/i;
|
|
29
|
+
const LIST_HEADING = /^(#{2,4}\s+)?(Ordered actions( or slices)?|Steps|Ordered steps|Actions|Slices|Work)\s*:?\s*$/i;
|
|
30
|
+
const CHECK_FIELD =
|
|
31
|
+
/^\s*(?:[-*]\s+)?(?:\*\*)?(?:[A-Za-z]+ and )?(Tests?( or observations)?|Checks?|Verification( claims?)?( and required boundar(y|ies))?|Verify|Observations?|Acceptance|Evidence|Final tests or observations)(?:\*\*)?\s*:(?:\*\*)?\s*(.*)$/i;
|
|
32
|
+
const INLINE_CHECK =
|
|
33
|
+
/\b(check(ed|s)?|verif(y|ied|ies)|tests?|observe[ds]?|assert|confirm(ed|s)?|run `|passes|fails?)\b/i;
|
|
34
|
+
const EMPTY = /^\s*(|-|—|none|n\/a|tbd|todo|\[.*\])\s*$/i;
|
|
35
|
+
|
|
36
|
+
function lint(file) {
|
|
37
|
+
const lines = readFileSync(file, "utf8")
|
|
38
|
+
.replace(/```[\s\S]*?```/g, (block) => block.replace(/[^\n]/g, ""))
|
|
39
|
+
.split("\n");
|
|
40
|
+
const steps = [];
|
|
41
|
+
for (let index = 0; index < lines.length; index += 1) {
|
|
42
|
+
const line = lines[index];
|
|
43
|
+
if (STEP_HEADING.test(line)) {
|
|
44
|
+
const level = /^(#+)/.exec(line)[1].length;
|
|
45
|
+
let end = index + 1;
|
|
46
|
+
while (end < lines.length && !(/^#{1,4}\s/.test(lines[end]) && /^(#+)/.exec(lines[end])[1].length <= level))
|
|
47
|
+
end += 1;
|
|
48
|
+
const body = lines.slice(index + 1, end);
|
|
49
|
+
// A field is filled on its own line, or by the list under it ("**Checks:**" then bullets).
|
|
50
|
+
const fields = body
|
|
51
|
+
.map((each, at) => {
|
|
52
|
+
const field = CHECK_FIELD.exec(each);
|
|
53
|
+
if (!field || !EMPTY.test(field.at(-1))) return field;
|
|
54
|
+
for (
|
|
55
|
+
let next = at + 1;
|
|
56
|
+
next < body.length && !/^\s*(\*\*)?[A-Z][^:]{0,60}:(\*\*)?\s*/.test(body[next]);
|
|
57
|
+
next += 1
|
|
58
|
+
) {
|
|
59
|
+
const item = /^\s*(?:[-*]|\d+[.)])\s+(\S.*)$/.exec(body[next]);
|
|
60
|
+
if (item) return [...field.slice(0, -1), item[1]];
|
|
61
|
+
}
|
|
62
|
+
return field;
|
|
63
|
+
})
|
|
64
|
+
.filter(Boolean);
|
|
65
|
+
const filled = fields.find((field) => !EMPTY.test(field.at(-1)));
|
|
66
|
+
steps.push({
|
|
67
|
+
line: index + 1,
|
|
68
|
+
step: line.replace(/^#+\s+/, "").trim(),
|
|
69
|
+
check: filled ? `${filled[1]}: ${filled.at(-1)}`.trim() : null,
|
|
70
|
+
problem: filled ? null : fields.length ? "its check field is empty" : "names no check",
|
|
71
|
+
});
|
|
72
|
+
continue;
|
|
73
|
+
}
|
|
74
|
+
if (LIST_HEADING.test(line.trim())) {
|
|
75
|
+
for (let at = index + 1; at < lines.length && !/^#{1,4}\s/.test(lines[at]); at += 1) {
|
|
76
|
+
const item = /^(\s*)(?:\d+[.)]|[-*])\s+(.*)$/.exec(lines[at]);
|
|
77
|
+
if (!item || item[1].length > 1) {
|
|
78
|
+
if (lines[at].trim() && !item && /^[A-Z][^:]{0,40}:\s*/.test(lines[at].trim())) break;
|
|
79
|
+
continue;
|
|
80
|
+
}
|
|
81
|
+
// A step's check may sit on its own nested lines.
|
|
82
|
+
const nested = [];
|
|
83
|
+
for (let next = at + 1; next < lines.length && /^\s{2,}\S/.test(lines[next]); next += 1)
|
|
84
|
+
nested.push(lines[next]);
|
|
85
|
+
const text = [item[2], ...nested].join(" ");
|
|
86
|
+
steps.push({
|
|
87
|
+
line: at + 1,
|
|
88
|
+
step: item[2].trim().slice(0, 120),
|
|
89
|
+
check: INLINE_CHECK.test(text) ? text.match(INLINE_CHECK)[0] : null,
|
|
90
|
+
problem: INLINE_CHECK.test(text) ? null : "names no check",
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
return { path: file, steps, problems: steps.filter((step) => step.problem) };
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
const results = [];
|
|
99
|
+
const inputErrors = [];
|
|
100
|
+
for (const input of positionals) {
|
|
101
|
+
const file = resolve(input);
|
|
102
|
+
if (!existsSync(file)) inputErrors.push(`no such file: ${input}`);
|
|
103
|
+
else results.push(lint(file));
|
|
104
|
+
}
|
|
105
|
+
const failed = inputErrors.length > 0 || results.some((result) => !result.steps.length || result.problems.length);
|
|
106
|
+
if (values.json)
|
|
107
|
+
console.log(
|
|
108
|
+
JSON.stringify({ command: "plan-lint", status: failed ? "fail" : "pass", inputErrors, results }, null, 2),
|
|
109
|
+
);
|
|
110
|
+
else {
|
|
111
|
+
for (const error of inputErrors) console.log(`error: ${error}`);
|
|
112
|
+
for (const result of results) {
|
|
113
|
+
if (!result.steps.length) {
|
|
114
|
+
console.log(
|
|
115
|
+
`${result.path}: no steps found (### Slice or ### Step blocks, or a list under "Ordered actions or slices" or "Steps")`,
|
|
116
|
+
);
|
|
117
|
+
continue;
|
|
118
|
+
}
|
|
119
|
+
console.log(`${result.path}: ${result.steps.length} step(s), ${result.problems.length} without a check`);
|
|
120
|
+
for (const step of result.problems) console.log(` line ${step.line}: ${step.step} — ${step.problem}`);
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
process.exit(failed ? 1 : 0);
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: write-skill
|
|
3
|
-
description: Use when creating or
|
|
3
|
+
description: "Use when creating, revising, merging or splitting a skill or any other text an agent acts on: a SKILL.md and its description, the references and scripts in a skill, AGENTS.md, CLAUDE.md, system or runtime prompts, tool descriptions, subagent briefs or judge prompts. Also use when deciding where an instruction should live, and when a skill is read at the wrong time, not read at all, or read but not followed."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Write Skill
|
|
7
7
|
|
|
8
|
-
Write the smallest agent-first skill package that changes one coherent behavioral policy.
|
|
8
|
+
Write the smallest agent-first skill package that changes one coherent behavioral policy, or the smallest change to other instruction text an agent acts on.
|
|
9
|
+
|
|
10
|
+
**Other instruction text** is anything an agent reads and acts on that is not a skill package: an instruction file such as AGENTS.md or CLAUDE.md, a system or runtime prompt, a tool description, a subagent brief, or a judge prompt. For it, everything below applies except what concerns the package itself: the skill's frontmatter description, resource files and their read conditions, the dependency graph, and `validate`. A tool description is a routing interface too, so Write The Description For Recall applies to it. Read "the skill" as "the text", and its first read as the point the agent receives it: every request for an always-loaded file or prompt, the tool call for a tool description, dispatch for a brief or a judge prompt.
|
|
9
11
|
|
|
10
12
|
A skill is a prompt intervention, not merely a document. A host may read its body once and retain it across later messages and tool interactions until context projection or loss. Design the first useful read, retained influence, dependencies, and recovery paths; do not assume the body will be reread before every use.
|
|
11
13
|
|
|
@@ -13,16 +15,61 @@ Smallest means behaviorally minimal, not shortest. A detailed skill is justified
|
|
|
13
15
|
|
|
14
16
|
The **Rules** below are binding; if one cannot be met, stop and say why. Everything else is **judgment**: follow its stated goal, and adapt when a different choice serves that goal better.
|
|
15
17
|
|
|
18
|
+
## Routes
|
|
19
|
+
|
|
20
|
+
This body covers the common case: writing or revising one skill or one piece of instruction text. Open a reference only when its condition holds.
|
|
21
|
+
|
|
22
|
+
| Situation | Go to |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| Deciding where an instruction lives (always-loaded text, a description, a body, a reference, a script, a tool's own text) or moving it between them; adding, merging, splitting or removing a reference, script or skill; changing links, shared terms, entry paths, capability cues or context-loss recovery cues between skills | [Placement And Dependencies](references/placement-and-dependencies.md) |
|
|
25
|
+
| Writing a description whose missed read could cause an irreversible or costly action, or whose neighbour matches similar requests; evidence that a skill was read late, early, not at all, or on a neighbour's request, or that two descriptions match the same request; or evidence that a read skill was misread, ignored, or kept steering later work | [Activation And Wording](references/activation-and-wording.md) |
|
|
26
|
+
| Measuring what a revision changes in behavior | Evaluate In One Loop, below |
|
|
27
|
+
| Checking structure, copied passages, or what a revision lost | Check The Package, below |
|
|
28
|
+
|
|
16
29
|
## Rules
|
|
17
30
|
|
|
18
|
-
- Before
|
|
19
|
-
- If accepted behavior, public dependencies,
|
|
31
|
+
- The baseline of a revision is the committed state before it. Before committing a substantial revision, such as a merge, a split, a move between files or a rewrite, run `skill-author compare --all-units` and settle every unit it reports unmatched: restore it, name the file and line that now owns it, or record why it is removed, in a verdicts file kept with the evidence outside the package. Then someone, you or a reviewer, reads every reworded and unmatched unit for meaning, since a rewording can keep the words and change what they ask. Outside Git only, copy the package to the task's scratch folder before editing and pass `--base <folder>`. A clean comparison shows that text survived, not that behavior did.
|
|
32
|
+
- If accepted behavior, public dependencies, or another user-owned choice is unsettled, stop and resolve it before encoding it.
|
|
20
33
|
- Never rely on an unread skill or reference to cause its own read. The first read must come from context the agent already has: a description, guaranteed base guidance, an already-loaded skill, a capability cue, or another declared route.
|
|
21
34
|
- Rely only on context guaranteed on every valid activation path, never on an optional sibling, a common but unguaranteed route, or an accidental earlier read.
|
|
22
|
-
-
|
|
23
|
-
-
|
|
35
|
+
- In a skill package, link every agent-facing reference, asset, script, and package dependency from the body, with the condition that requires it. State the condition once, at the link; the resource opens with its content, not a restatement of its read condition.
|
|
36
|
+
- When a skill is removed or merged into another, add no alias, shim or redirect under the old name: the description of the skill that now owns the job routes the work, every link and command naming the old skill is updated, and the removed name is reported as a breaking change.
|
|
37
|
+
- Keep authoring status, evaluation summaries, evidence gaps, changelog notes, readiness claims, and author debate out of the executing package or text; they belong in the evaluation artifact, task record, or delivery report.
|
|
24
38
|
- Claim only what the evidence observed. Structural checks prove structure. Explicit body delivery does not prove activation, one turn does not prove retained use, ambient context does not prove dependency behavior, prose review does not prove unchanged behavior, and one favorable example does not prove readiness.
|
|
25
|
-
-
|
|
39
|
+
- For a skill package, run `validate` after any structural or dependency change and before claiming the package is valid. Never use deprecated authoring tooling.
|
|
40
|
+
|
|
41
|
+
## Choose What To Change
|
|
42
|
+
|
|
43
|
+
Goal: change a skill only for behavior that will recur, and only where prose is the right fix.
|
|
44
|
+
|
|
45
|
+
When revising from evidence, such as observed failures, transcripts, review findings or eval results, list each candidate change with the evidence behind it. Drop a candidate that is:
|
|
46
|
+
|
|
47
|
+
- **not durable:** a one-off slip that the situation, not the guidance, explains;
|
|
48
|
+
- **too specific:** it fits one task or fixture, not the class of situations the skill serves;
|
|
49
|
+
- **a duplicate:** another candidate, or another skill, already owns it;
|
|
50
|
+
- **already covered:** the skill says it, and the failure lies elsewhere, such as activation or placement; fix that boundary instead;
|
|
51
|
+
- **structural:** a tool, script, check or runtime change prevents it more reliably than an instruction.
|
|
52
|
+
|
|
53
|
+
Keep dropped candidates and their reasons with the evidence, outside the package.
|
|
54
|
+
|
|
55
|
+
## Prefer A Capability To Prose
|
|
56
|
+
|
|
57
|
+
Goal: the fact or check the agent needs is in front of it at the decision.
|
|
58
|
+
|
|
59
|
+
Prose changes behavior only when it is in context at the decision, and a skill body often is not: in 30 of Freeflow's own evaluation runs, 3 read any skill file. A script, a tool's output or a structured artifact reaches the decision whether or not a body was read. Before writing an instruction, ask whether a capability can do its job:
|
|
60
|
+
|
|
61
|
+
- **Replace mechanical prose:** a format, command list or check followed by hand becomes a script that does or checks it, such as `skill-author validate` for frontmatter and links.
|
|
62
|
+
- **Enable the main work:** a script puts the decision's facts in front of the agent, such as Verify Work's `test-changes.mjs`, which lists every changed existing test so the agent and its reviewer judge each one.
|
|
63
|
+
|
|
64
|
+
The prose then names the capability where it is used and keeps only the judgment a script cannot make. Add a script only for work the skill owns, never to make a package look complete.
|
|
65
|
+
|
|
66
|
+
## Choose Skill Boundaries
|
|
67
|
+
|
|
68
|
+
Goal: few skills, each owning one job in depth.
|
|
69
|
+
|
|
70
|
+
Every skill's description is loaded on every request, and neighbours whose descriptions overlap confuse the choice between them. Prefer depth to width: when several skills do one job split by type, such as commit, push and release, merge them into one skill whose body routes to a reference per type. Keep a skill separate when its reader, trigger or job differs: another person or agent reads it, another request or situation calls for it, or it produces a different result.
|
|
71
|
+
|
|
72
|
+
When the same workflow is rebuilt by hand across several tasks and no skill owns it, first check whether it is a branch of an existing skill; otherwise propose a new skill to the user, naming the tasks it recurred in.
|
|
26
73
|
|
|
27
74
|
## Establish The Behavioral Claim
|
|
28
75
|
|
|
@@ -41,13 +88,24 @@ Before writing, identify:
|
|
|
41
88
|
|
|
42
89
|
Begin with the behavioral intervention, not with sections, wording, examples, or file layout.
|
|
43
90
|
|
|
91
|
+
## Shape The Package
|
|
92
|
+
|
|
93
|
+
Goal: the common case runs from `SKILL.md` alone, and the depth one situation needs sits in one place.
|
|
94
|
+
|
|
95
|
+
- `SKILL.md` is enough to act correctly in the common case without opening a reference.
|
|
96
|
+
- When the skill has references, a routing table comes first in the body: each row names a concrete, observable condition and the reference or section that serves it. "When unclear" is not a condition.
|
|
97
|
+
- A reference holds one situation's method. Add one only when its condition is narrow, so that many activations never reach it, and its content is large, so that inlining it would bury the common route; otherwise keep it inline.
|
|
98
|
+
- Merge references that are read together.
|
|
99
|
+
- Give each rule one owner; everywhere else, point to it rather than restate it (Repeat Instructions Deliberately).
|
|
100
|
+
- Declare only the dependencies the skill's normal and conditional routes need.
|
|
101
|
+
|
|
102
|
+
Start with one `SKILL.md` and remove accidental complexity before splitting files. There is no universal body template, line limit, or reference count.
|
|
103
|
+
|
|
44
104
|
## Design The First Read
|
|
45
105
|
|
|
46
106
|
Goal: the skill is read at the earliest decision it can improve, and reading it on a nearby case does no harm.
|
|
47
107
|
|
|
48
|
-
Missing that decision is usually far more harmful than an unnecessary early read. A nearby case can pass by not loading the skill, or by loading it, recognizing that its method does not apply, and exiting without distorting later work. An early read is cheap only when the retained body stays safe; a skill that exits on the first turn but keeps distorting later work is not a safe read.
|
|
49
|
-
|
|
50
|
-
Read [Activation Boundaries](references/activation-boundaries.md) when activation is unclear or evidence shows missed, late, early, task-hijacking, or retained-interference behavior.
|
|
108
|
+
Missing that decision is usually far more harmful than an unnecessary early read. A nearby case can pass by not loading the skill, or by loading it, recognizing that its method does not apply, and exiting without distorting later work. An early read is cheap only when the retained body stays safe; a skill that exits on the first turn but keeps distorting later work is not a safe read. When a missed read is costly, give the skill an upstream activation or recovery edge, as Placement And Dependencies describes.
|
|
51
109
|
|
|
52
110
|
## Write The Description For Recall
|
|
53
111
|
|
|
@@ -55,10 +113,12 @@ The description is a routing interface, not a summary of the body.
|
|
|
55
113
|
|
|
56
114
|
- State the broad core job in plain language, with natural user verbs or task conditions visible before activation.
|
|
57
115
|
- Avoid terminology or classifications introduced only inside the skill or an optional dependency.
|
|
58
|
-
-
|
|
116
|
+
- Name the situations each reference and script serves, in the words a request would use. A reference is reached only through its skill, so when skills merge, the owner's description keeps the triggers of every job it absorbed.
|
|
117
|
+
- Make it as long as recall needs, up to the host's limit (1,024 characters in the Agent Skills format). Every description is loaded on every request, but a missed read costs the decision the skill exists to change.
|
|
118
|
+
- Avoid future-duration guesses, named internal phases, marketing claims, and compressed copies of the body.
|
|
59
119
|
- "Use when…" is useful wording, not mandatory grammar.
|
|
60
120
|
|
|
61
|
-
Favor recall when
|
|
121
|
+
Favor recall: an unneeded read is cheap when the body exits safely, and a missed read is not. Add a "not for" exclusion only when reading the skill on that request would do harm, such as retained guidance that routinely overrides another owner or method, never merely to prevent harmless reads.
|
|
62
122
|
|
|
63
123
|
## Write For The Executing Agent
|
|
64
124
|
|
|
@@ -76,8 +136,6 @@ Write for an agent seeing the skill for the first time with only guaranteed cont
|
|
|
76
136
|
|
|
77
137
|
Use discussion, research, and author reasoning to understand the behavior, then compile that understanding into runtime instructions. The conversation, rejected drafts, fixture narration, and any explanation whose only reader is the author stay out.
|
|
78
138
|
|
|
79
|
-
Read [Agent-First Instructions](references/agent-first-instructions.md) when a concrete first-read or retained-use failure involves wording, placement, undeclared context, author explanation, or competing instructions.
|
|
80
|
-
|
|
81
139
|
## Separate Rules From Judgment
|
|
82
140
|
|
|
83
141
|
A skill gives two kinds of instruction, and agents need to tell them apart.
|
|
@@ -113,7 +171,7 @@ goal
|
|
|
113
171
|
|
|
114
172
|
Examples inside judgment are illustrations, not triggers:
|
|
115
173
|
|
|
116
|
-
> Delegate
|
|
174
|
+
> Delegate work when a cheaper profile can do it without significant quality loss and the handoff costs less than it saves. A separate record update across several entries often qualifies; a one-line update in the middle of your own work does not.
|
|
117
175
|
|
|
118
176
|
When a skill contains both kinds, say so once near the top: which instructions are binding, and that everything else is judgment the agent may adapt to its goal. A skill may be mostly Rules, like a release protocol, or mostly judgment, like work placement; the label keeps each one from being read as the other.
|
|
119
177
|
|
|
@@ -125,19 +183,6 @@ Add a compact example when prose alone leaves a likely misclassification. Show t
|
|
|
125
183
|
|
|
126
184
|
Keep examples transferable; the body is not a transcript, fixture library, or scenario catalog. Inline examples teach the subject and are part of the candidate intervention, not independent evidence that the skill works.
|
|
127
185
|
|
|
128
|
-
## Plan Terminology And Dependencies
|
|
129
|
-
|
|
130
|
-
Goal: every term and dependency is available on every path that reaches the skill.
|
|
131
|
-
|
|
132
|
-
For one self-contained skill, declare only the dependencies its normal and conditional routes need. Before creating or revising several related skills, shared terminology, cross-skill links, capability activation, direct or routed entry paths, or context-loss recovery, read [Skill Dependency Graphs](references/skill-dependency-graphs.md).
|
|
133
|
-
|
|
134
|
-
- Identify every valid direct and routed activation path.
|
|
135
|
-
- Place shared vocabulary in the nearest upstream context guaranteed before every consumer; keep leaf-specific terms local.
|
|
136
|
-
- Distinguish owner routes, method composition, environment interactions, references, capability cues, and retained context.
|
|
137
|
-
- Give critical skills an upstream activation or recovery edge.
|
|
138
|
-
|
|
139
|
-
A Markdown link declares a package dependency. It does not select the target owner or execute the linked skill.
|
|
140
|
-
|
|
141
186
|
## Compact Without Erasing Behavior
|
|
142
187
|
|
|
143
188
|
Goal: remove what does not change behavior, and nothing that does.
|
|
@@ -150,6 +195,8 @@ If yes, remove or merge it.
|
|
|
150
195
|
|
|
151
196
|
Keep an instruction because it protects measured behavior or prevents a specific failure you can name, not because it might help. An instruction with neither is a candidate for removal: remove it, or test whether it changes behavior, rather than keeping it by default. Skills otherwise only grow, as each incident adds instructions and none is ever shown safe to remove.
|
|
152
197
|
|
|
198
|
+
Remove an instruction once the mistake it guards against can no longer happen, for example because a tool now refuses the action or the capability it guarded is gone. Keep a local guard only for a path that still bypasses the enforcement.
|
|
199
|
+
|
|
153
200
|
Compaction goes wrong when it:
|
|
154
201
|
|
|
155
202
|
- deletes the positive route while keeping only prohibitions;
|
|
@@ -166,37 +213,28 @@ Length is a diagnostic fact, not a quality verdict. A long skill may be minimal;
|
|
|
166
213
|
|
|
167
214
|
Goal: each behavior has one owner, with a local guard wherever an agent could otherwise act without it.
|
|
168
215
|
|
|
169
|
-
Repetition earns its place when local presence protects an independently activated skill, a distinct decision point, a context-loss or host path, a dangerous literal reading, a previously observed failure, or a required read condition. Keep the full definition or method with one canonical owner and repeat only the compact guard at the affected choice.
|
|
216
|
+
Repetition earns its place when local presence protects an independently activated skill, a distinct decision point, a context-loss or host path, a dangerous literal reading, retained use after the method ends, a previously observed failure, or a required read condition. Keep the full definition or method with one canonical owner and repeat only the compact guard at the affected choice.
|
|
170
217
|
|
|
171
218
|
> Repeat the behavioral invariant, not the owning skill's entire explanation.
|
|
172
219
|
|
|
173
220
|
Repetition for emphasis, author reassurance, or stylistic consistency does not earn its place. Check that repeated wording keeps the same meaning and route. Removing, merging, moving, or rewording an instruction that protects measured behavior is a behavioral change; evaluate the affected boundary.
|
|
174
221
|
|
|
175
|
-
##
|
|
176
|
-
|
|
177
|
-
Before adding or reorganizing references, assets, or scripts, read [Progressive Disclosure](references/progressive-disclosure.md).
|
|
222
|
+
## Evaluate In One Loop
|
|
178
223
|
|
|
179
|
-
|
|
224
|
+
Goal: every revision answers observed evidence and is checked against it.
|
|
180
225
|
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
226
|
+
1. Start from the source: the evidence a change answers (Choose What To Change), or for a new skill, its behavioral claim.
|
|
227
|
+
2. Name the exact claim: description activation, first-read body behavior, nearby behavior, dependency composition, retained use, artifact outcome, or cross-host behavior.
|
|
228
|
+
3. Fix the cases before the draft is final: one that should use the guidance, a near miss that should not, and for judgment, one where following the default literally is the worse choice.
|
|
229
|
+
4. Run the arms with [Evaluate Behavior](../evaluate-behavior/SKILL.md) under fixed declared inputs; when the claim is that the revision is better, declare the decision rule before the run.
|
|
230
|
+
5. Read the transcripts and results, with the user when they review, before trusting a count.
|
|
231
|
+
6. Revise one measured pressure point.
|
|
232
|
+
7. Rerun the complete fixed group with every arm.
|
|
187
233
|
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
## Evaluate The Behavioral Claim
|
|
191
|
-
|
|
192
|
-
Goal: evidence that the skill changes behavior as intended, at the boundary being claimed.
|
|
193
|
-
|
|
194
|
-
Name the exact claim: description activation, first-read body behavior, nearby behavior, dependency composition, retained use, artifact outcome, or cross-host behavior. Use [Evaluate Skill](../evaluate-skill/SKILL.md) to compare exact baseline and candidate environments under fixed declared inputs.
|
|
234
|
+
Stop when the evidence supports the claim, or when the next revision would only tune against the same cases; judge it on held-out cases instead. Preserve adequate existing evidence rather than rerunning it.
|
|
195
235
|
|
|
196
236
|
Evaluate the two kinds differently. A Rule passes when it is never broken, including under pressure to break it. Judgment passes on outcome, and its evidence should include a case where following the default literally is the worse choice, so a candidate that only obeys cannot pass.
|
|
197
237
|
|
|
198
|
-
Preserve adequate existing evidence. Revise one measured pressure point at a time, and after a behavior-sensitive change rerun the complete fixed group with both variants.
|
|
199
|
-
|
|
200
238
|
Small wording, ordering, vocabulary, repetition, and structural changes can alter model behavior. Human review establishes intended meaning; behavioral evidence establishes observed effect.
|
|
201
239
|
|
|
202
240
|
## Check The Package
|
|
@@ -205,15 +243,17 @@ Use the bundled [skill author](scripts/skill-author.mjs) for deterministic packa
|
|
|
205
243
|
|
|
206
244
|
```text
|
|
207
245
|
node <write-skill-directory>/scripts/skill-author.mjs init <directory> --name <name> --description <text>
|
|
208
|
-
node <write-skill-directory>/scripts/skill-author.mjs validate <directory> [--package-root <directory>]
|
|
246
|
+
node <write-skill-directory>/scripts/skill-author.mjs validate <directory> [--package-root <directory>] [--routing-map <file>]
|
|
209
247
|
node <write-skill-directory>/scripts/skill-author.mjs inspect <directory> [--package-root <directory>]
|
|
210
248
|
node <write-skill-directory>/scripts/skill-author.mjs similarity <directory> [--threshold <0-1>]
|
|
249
|
+
node <write-skill-directory>/scripts/skill-author.mjs compare [<base-ref> [<new-ref>] | --base <folder> [<folder>]] [--all-units] [--verdicts <file>]
|
|
211
250
|
```
|
|
212
251
|
|
|
213
252
|
- `init`: create a new minimal package; it never overwrites an existing one.
|
|
214
|
-
- `validate`: check frontmatter, heading shape, recursive links, declared package dependencies, and containment.
|
|
253
|
+
- `validate`: check frontmatter, heading shape, recursive links, declared package dependencies, and containment. It also lists link cycles among the Markdown files the skill reaches, leaving out links to any `SKILL.md`; Placement And Dependencies says what to do with one. With `--routing-map`, it checks that the map's row for the skill names the same sibling skills and resources that `SKILL.md` links.
|
|
215
254
|
- `inspect`: report body sizes, resource classes, scripts, unlinked files, and validation findings, when factual inventory matters.
|
|
216
255
|
- `similarity`: report Markdown files under a directory that share copied or lightly edited passages. Run it across related skills before keeping repetition; it cannot detect paraphrase, so a clean report does not prove an instruction is stated once.
|
|
256
|
+
- `compare`: with no arguments, compare the model-facing Markdown changed since the branch left the default branch with the working tree, uncommitted edits included, and list each rule-like unit (under a Rules heading, a numbered step, or containing never, always, must, only, do not or stop, or a reason: because, so that, otherwise, why) that no longer appears; `--all-units`, for a substantial revision, lists every unmatched unit. It exits nonzero while one has no verdict in `--verdicts <file>`, a JSON object of `"file:line": "verdict"` that carries across runs. Read every reworded rule it lists as well: a rewording can keep the words and change the meaning. `--help` gives the other options.
|
|
217
257
|
|
|
218
258
|
Commands emit JSON. Invalid structure still emits a report and exits nonzero; command errors emit structured error JSON. Package root defaults to the nearest `package.json` ancestor, then the skill directory's parent; use `--package-root` for a candidate in an overlay or another package context.
|
|
219
259
|
|
|
@@ -231,6 +271,6 @@ Stop when the requested package:
|
|
|
231
271
|
- keeps its normal route executable on first read;
|
|
232
272
|
- declares dependencies and resource conditions honestly;
|
|
233
273
|
- contains no author-facing residue;
|
|
234
|
-
- passes required structural checks.
|
|
274
|
+
- passes required structural checks, and after a substantial revision has a verdict for every rule-like unit it no longer states.
|
|
235
275
|
|
|
236
|
-
Stop and ask when accepted behavior, activation, dependencies,
|
|
276
|
+
Stop and ask when accepted behavior, activation, dependencies, or another user-owned choice cannot be settled from evidence. Do not add sections, references, examples, scripts, or procedure merely to make the package look complete.
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# Activation And Wording
|
|
2
|
+
|
|
3
|
+
This reference is judgment: adapt it to the skill's goal. Its binding statements restate [Write Skill](../SKILL.md) Rules.
|
|
4
|
+
|
|
5
|
+
Two failures look alike from outside: the skill is not read at the decision it should change, or it is read and its text does not steer the agent as written. Find which one the evidence shows before rewriting anything; a better body cannot fix a missed read, and a sharper description cannot fix a misleading body.
|
|
6
|
+
|
|
7
|
+
## Activation
|
|
8
|
+
|
|
9
|
+
A description should make the skill available at the earliest useful decision without requiring language introduced by the skill itself.
|
|
10
|
+
|
|
11
|
+
### Diagnose The First Read
|
|
12
|
+
|
|
13
|
+
Beyond the behavioral claim in Write Skill, identify:
|
|
14
|
+
|
|
15
|
+
- the earliest natural prompt or task state where the skill can change behavior;
|
|
16
|
+
- the consequence of missing or delaying the read;
|
|
17
|
+
- the consequence if a nearby prompt also loads the skill;
|
|
18
|
+
- how retained guidance should behave after the immediate method ends.
|
|
19
|
+
|
|
20
|
+
### Compare Activation Costs
|
|
21
|
+
|
|
22
|
+
False-positive and false-negative activation have different costs.
|
|
23
|
+
|
|
24
|
+
A false-positive read may be acceptable when:
|
|
25
|
+
|
|
26
|
+
- loading cost is proportionate;
|
|
27
|
+
- the body identifies that its method does not apply;
|
|
28
|
+
- it exits without changing ownership or route;
|
|
29
|
+
- retained instructions do not hijack later work.
|
|
30
|
+
|
|
31
|
+
A false negative is material when missing the first useful read causes:
|
|
32
|
+
|
|
33
|
+
- an irreversible or expensive action;
|
|
34
|
+
- a wrong owner or method;
|
|
35
|
+
- repeated low-value environment interactions;
|
|
36
|
+
- missing safety or evidence boundaries;
|
|
37
|
+
- later work that the skill cannot reliably undo.
|
|
38
|
+
|
|
39
|
+
Prefer recall when nearby reads are demonstrably safe and missed activation is materially worse. Tighten activation when early or retained guidance can distort ordinary work.
|
|
40
|
+
|
|
41
|
+
### Check The Cues
|
|
42
|
+
|
|
43
|
+
Beyond Write The Description For Recall, a cue names an observable distinction from neighboring jobs, and never rests on generic "help with" or "improve" language. Guaranteed base context may define a term; otherwise use plain observable language.
|
|
44
|
+
|
|
45
|
+
### Test Nearby And Retained Behavior
|
|
46
|
+
|
|
47
|
+
A nearby case can pass through:
|
|
48
|
+
|
|
49
|
+
- **Non-trigger:** the skill is not read.
|
|
50
|
+
- **Safe read:** the body loads, exits or defers correctly, and does not interfere later.
|
|
51
|
+
|
|
52
|
+
Test both the immediate response and later declared turns when retained influence matters.
|
|
53
|
+
|
|
54
|
+
Broad useful trigger:
|
|
55
|
+
|
|
56
|
+
> Use when committing work.
|
|
57
|
+
|
|
58
|
+
Over-specified trigger that hides the job:
|
|
59
|
+
|
|
60
|
+
> Use after final verification when a planned checkpoint requires a locally reviewable commit.
|
|
61
|
+
|
|
62
|
+
Broad safe-read trigger:
|
|
63
|
+
|
|
64
|
+
> Use when working with software design—especially boundaries, interfaces, ownership, state, and failure behavior.
|
|
65
|
+
|
|
66
|
+
The body must exit when the local interface remains sound and avoid turning later local choices into architecture work.
|
|
67
|
+
|
|
68
|
+
### Preserve The Evidence Boundary
|
|
69
|
+
|
|
70
|
+
Natural activation proves the host read the exact skill snapshot from a natural prompt. Explicit body delivery tests first-read instructions, not activation. Dependency composition tests exact declared skill and context order. Multi-turn evidence tests retained use. Artifact and transcript evidence show whether activation helped, exited safely, or hijacked behavior.
|
|
71
|
+
|
|
72
|
+
Preserve:
|
|
73
|
+
|
|
74
|
+
- the earliest useful positive prompt;
|
|
75
|
+
- at least one close nearby case;
|
|
76
|
+
- later-turn evidence when retained influence is part of the claim.
|
|
77
|
+
|
|
78
|
+
Do not infer one evidence class from another.
|
|
79
|
+
|
|
80
|
+
## Wording
|
|
81
|
+
|
|
82
|
+
### Translate Author Context
|
|
83
|
+
|
|
84
|
+
Keep a sentence only when it:
|
|
85
|
+
|
|
86
|
+
- changes an action or judgment;
|
|
87
|
+
- defines required language;
|
|
88
|
+
- protects a likely or observed failure boundary;
|
|
89
|
+
- states an evidence, return, or stop condition;
|
|
90
|
+
- makes a dependency executable;
|
|
91
|
+
- provides a compact example resolving likely misclassification.
|
|
92
|
+
|
|
93
|
+
Translate rationale into a direct instruction plus only the why needed to generalize. Translate debate into the selected boundary and stop condition. Translate a measured failure into the smallest transferable guard that prevents it. Omit rejected drafts, conversation history, fixture narration, evaluation status, and explanation whose only audience is the author.
|
|
94
|
+
|
|
95
|
+
### Make Instructions Concrete
|
|
96
|
+
|
|
97
|
+
A Rule gets concrete by naming its trigger, its action, and its stop. Prefer:
|
|
98
|
+
|
|
99
|
+
> If saved evidence already answers the fixed question, inspect it before proposing a rerun.
|
|
100
|
+
|
|
101
|
+
Over:
|
|
102
|
+
|
|
103
|
+
> Keep evaluation efficient and aligned with best practices.
|
|
104
|
+
|
|
105
|
+
Concrete Rules reduce the judgment the agent must reconstruct.
|
|
106
|
+
|
|
107
|
+
Judgment gets concrete differently: a sharper goal, clearer signals for deviating, and a realistic example on each side of the line. Turning judgment into an absolute makes it easier to follow and worse to follow. Prefer:
|
|
108
|
+
|
|
109
|
+
> Start a Slice for work that would leave partial state to reconcile if interrupted. An investigation across many sources can qualify; a discussion whose results land directly in the record usually does not.
|
|
110
|
+
|
|
111
|
+
Over:
|
|
112
|
+
|
|
113
|
+
> Start a Slice for every activity.
|
|
114
|
+
|
|
115
|
+
### Pair Negative Instructions With The Route
|
|
116
|
+
|
|
117
|
+
Bad:
|
|
118
|
+
|
|
119
|
+
> Do not recreate the old worker/verifier architecture.
|
|
120
|
+
|
|
121
|
+
Better:
|
|
122
|
+
|
|
123
|
+
> The producing activity handles implementation and verification. The surrounding workflow may select independent review.
|
|
124
|
+
|
|
125
|
+
Bad:
|
|
126
|
+
|
|
127
|
+
> Do not implement the recommendation.
|
|
128
|
+
|
|
129
|
+
Better:
|
|
130
|
+
|
|
131
|
+
> Return the recommendation to the owning workflow. Implementation requires separate authorization.
|
|
132
|
+
|
|
133
|
+
A negative instruction may preserve an invariant directly when the positive route is already clear:
|
|
134
|
+
|
|
135
|
+
> Preserve the accepted scope. Do not split it into MVP or roadmap phases without approval.
|
|
136
|
+
|
|
137
|
+
### Fix Placement Before Adding Prose
|
|
138
|
+
|
|
139
|
+
A late caveat rarely defeats an early command. Move or sharpen the controlling sentence before adding another section. When an early instruction and a later exception conflict, restructure the route rather than adding another disclaimer.
|
|
140
|
+
|
|
141
|
+
### End The Skill's Influence
|
|
142
|
+
|
|
143
|
+
A skill body may remain in context after its immediate method ends. State stop, return, or exit conditions clearly enough that retained instructions do not continue claiming ownership or broadening later work. A first-turn exit is insufficient when later turns still show method hijacking. After editing, rerun the same first-read and retained-use pressure while keeping unrelated instructions stable.
|