akm-cli 0.9.0-beta.5 → 0.9.0-beta.51
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/CHANGELOG.md +711 -0
- package/README.md +12 -4
- package/dist/akm +38 -0
- package/dist/akm-migrate-storage +38 -0
- package/dist/assets/profiles/default.json +9 -4
- package/dist/assets/profiles/frequent.json +1 -1
- package/dist/assets/profiles/memory-focus.json +1 -1
- package/dist/assets/profiles/quick.json +1 -1
- package/dist/assets/profiles/synthesize.json +15 -0
- package/dist/assets/profiles/thorough.json +1 -1
- package/dist/assets/prompts/consolidate-system.md +23 -0
- package/dist/assets/prompts/contradiction-judge.md +33 -0
- package/dist/assets/prompts/distill-knowledge-system.md +22 -0
- package/dist/assets/prompts/distill-lesson-system.md +36 -0
- package/dist/assets/prompts/extract-session.md +6 -2
- package/dist/assets/prompts/graph-extract-system.md +1 -0
- package/dist/assets/prompts/graph-extract-user-prompt.md +1 -1
- package/dist/assets/prompts/memory-infer-system.md +1 -0
- package/dist/assets/prompts/memory-infer-user.md +5 -0
- package/dist/assets/prompts/metadata-enhance-system.md +1 -0
- package/dist/assets/prompts/procedural-system.md +44 -0
- package/dist/assets/prompts/recombine-system.md +40 -0
- package/dist/assets/prompts/staleness-detect-system.md +6 -0
- package/dist/assets/prompts/validate-summary-judge.md +1 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/agent.md +38 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/command.md +38 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/fact.md +39 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/knowledge.md +40 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/lesson.md +43 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/memory.md +38 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/script.md +43 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/skill.md +40 -0
- package/dist/assets/stash-skeleton/facts/conventions/assets/workflow.md +43 -0
- package/dist/assets/templates/html/health.html +281 -111
- package/dist/assets/wiki/ingest-workflow-template.md +38 -10
- package/dist/cli/parse-args.js +46 -1
- package/dist/cli/shared.js +28 -0
- package/dist/cli.js +27 -11
- package/dist/commands/agent/agent-dispatch.js +2 -2
- package/dist/commands/agent/agent-support.js +0 -7
- package/dist/commands/agent/contribute-cli.js +17 -4
- package/dist/commands/config-cli.js +18 -2
- package/dist/commands/env/child-env.js +47 -0
- package/dist/commands/env/env-cli.js +33 -26
- package/dist/commands/env/secret-cli.js +36 -22
- package/dist/commands/feedback-cli.js +15 -6
- package/dist/commands/graph/graph-cli.js +5 -13
- package/dist/commands/graph/graph.js +76 -72
- package/dist/commands/health/checks.js +49 -1
- package/dist/commands/health/html-report.js +422 -80
- package/dist/commands/health.js +386 -9
- package/dist/commands/improve/calibration.js +161 -0
- package/dist/commands/improve/consolidate/chunking.js +141 -0
- package/dist/commands/improve/consolidate/eligibility.js +81 -0
- package/dist/commands/improve/consolidate/merge.js +145 -0
- package/dist/commands/improve/consolidate/sanitize.js +231 -0
- package/dist/commands/{lint.js → improve/consolidate/types.js} +1 -1
- package/dist/commands/improve/consolidate.js +635 -660
- package/dist/commands/improve/dedup.js +482 -0
- package/dist/commands/improve/distill.js +159 -69
- package/dist/commands/improve/eligibility.js +434 -0
- package/dist/commands/improve/encoding-salience.js +205 -0
- package/dist/commands/improve/extract-cli.js +124 -2
- package/dist/commands/improve/extract-prompt.js +39 -2
- package/dist/commands/improve/extract-watch.js +140 -0
- package/dist/commands/improve/extract.js +389 -40
- package/dist/commands/improve/feedback-valence.js +54 -0
- package/dist/commands/improve/homeostatic.js +467 -0
- package/dist/commands/improve/improve-auto-accept.js +138 -7
- package/dist/commands/improve/improve-cli.js +36 -61
- package/dist/commands/improve/improve-profiles.js +14 -0
- package/dist/commands/improve/improve-result-file.js +14 -25
- package/dist/commands/improve/improve-session.js +58 -0
- package/dist/commands/improve/improve.js +485 -2498
- package/dist/commands/improve/locks.js +154 -0
- package/dist/commands/improve/loop-stages.js +1083 -0
- package/dist/commands/improve/memory/memory-contradiction-detect.js +23 -28
- package/dist/commands/improve/outcome-loop.js +256 -0
- package/dist/commands/improve/preparation.js +1966 -0
- package/dist/commands/improve/proactive-maintenance.js +115 -0
- package/dist/commands/improve/procedural.js +418 -0
- package/dist/commands/improve/recombine.js +850 -0
- package/dist/commands/improve/reflect-noise.js +0 -0
- package/dist/commands/improve/reflect.js +183 -40
- package/dist/commands/improve/salience.js +438 -0
- package/dist/commands/improve/triage.js +93 -0
- package/dist/commands/lint/agent-linter.js +19 -24
- package/dist/commands/lint/base-linter.js +173 -60
- package/dist/commands/lint/command-linter.js +19 -24
- package/dist/commands/lint/env-key-rules.js +38 -1
- package/dist/commands/lint/fact-linter.js +39 -0
- package/dist/commands/lint/index.js +31 -13
- package/dist/commands/lint/memory-linter.js +1 -1
- package/dist/commands/lint/registry.js +7 -2
- package/dist/commands/lint/task-linter.js +3 -3
- package/dist/commands/lint/workflow-linter.js +26 -1
- package/dist/commands/proposal/drain-policies.js +5 -0
- package/dist/commands/proposal/drain.js +43 -50
- package/dist/commands/proposal/proposal-cli.js +21 -31
- package/dist/commands/proposal/proposal.js +5 -0
- package/dist/commands/proposal/propose.js +7 -2
- package/dist/commands/proposal/validators/proposal-quality-validators.js +9 -8
- package/dist/commands/proposal/validators/proposals.js +189 -63
- package/dist/commands/read/curate.js +414 -94
- package/dist/commands/read/knowledge.js +6 -3
- package/dist/commands/read/search-cli.js +9 -4
- package/dist/commands/read/search.js +10 -6
- package/dist/commands/read/show.js +86 -7
- package/dist/commands/sources/init.js +49 -17
- package/dist/commands/sources/installed-stashes.js +11 -3
- package/dist/commands/sources/schema-repair.js +43 -45
- package/dist/commands/sources/self-update.js +2 -2
- package/dist/commands/sources/source-add.js +7 -3
- package/dist/commands/sources/stash-cli.js +28 -40
- package/dist/commands/sources/stash-skeleton.js +23 -8
- package/dist/commands/tasks/tasks-cli.js +19 -27
- package/dist/commands/tasks/tasks.js +39 -11
- package/dist/commands/wiki-cli.js +21 -35
- package/dist/core/asset/asset-registry.js +3 -1
- package/dist/core/asset/asset-spec.js +18 -2
- package/dist/core/asset/frontmatter.js +166 -167
- package/dist/core/asset/markdown.js +8 -0
- package/dist/core/authoring-rules.js +92 -0
- package/dist/core/common.js +0 -5
- package/dist/core/config/config-migration.js +12 -11
- package/dist/core/config/config-schema.js +340 -56
- package/dist/core/config/config-types.js +3 -3
- package/dist/core/config/config.js +28 -7
- package/dist/core/events.js +3 -7
- package/dist/core/improve-types.js +11 -8
- package/dist/core/logs-db.js +10 -66
- package/dist/core/parse.js +36 -16
- package/dist/core/paths.js +3 -0
- package/dist/core/standards/resolve-standards-context.js +87 -0
- package/dist/core/standards/resolve-stash-standards.js +99 -0
- package/dist/core/standards/resolve-type-conventions.js +66 -0
- package/dist/core/state/migrations.js +714 -0
- package/dist/core/state-db.js +525 -474
- package/dist/indexer/db/db.js +439 -247
- package/dist/indexer/db/graph-db.js +129 -86
- package/dist/indexer/ensure-index.js +152 -17
- package/dist/indexer/graph/graph-boost.js +51 -41
- package/dist/indexer/graph/graph-extraction.js +218 -4
- package/dist/indexer/index-writer-lock.js +99 -0
- package/dist/indexer/indexer.js +123 -221
- package/dist/indexer/passes/dir-staleness.js +114 -0
- package/dist/indexer/passes/memory-inference.js +13 -5
- package/dist/indexer/passes/staleness-detect.js +2 -5
- package/dist/indexer/search/db-search.js +19 -6
- package/dist/indexer/search/ranking-contributors.js +22 -0
- package/dist/indexer/search/ranking.js +4 -0
- package/dist/indexer/search/search-source.js +17 -18
- package/dist/indexer/search/semantic-status.js +4 -0
- package/dist/indexer/walk/matchers.js +9 -0
- package/dist/integrations/agent/config.js +6 -53
- package/dist/integrations/agent/index.js +2 -18
- package/dist/integrations/agent/prompts.js +75 -9
- package/dist/integrations/agent/runner-dispatch.js +59 -0
- package/dist/integrations/harnesses/claude/session-log.js +11 -1
- package/dist/integrations/harnesses/index.js +2 -3
- package/dist/integrations/harnesses/opencode/session-log.js +173 -3
- package/dist/integrations/harnesses/opencode-sdk/index.js +2 -2
- package/dist/integrations/harnesses/opencode-sdk/sdk-runner.js +0 -2
- package/dist/integrations/session-logs/index.js +16 -0
- package/dist/llm/client.js +45 -15
- package/dist/llm/embedder.js +42 -3
- package/dist/llm/embedders/deterministic.js +66 -0
- package/dist/llm/embedders/local.js +66 -2
- package/dist/llm/feature-gate.js +8 -4
- package/dist/llm/graph-extract.js +67 -44
- package/dist/llm/memory-infer-impl.js +138 -0
- package/dist/llm/memory-infer.js +1 -127
- package/dist/llm/metadata-enhance.js +44 -31
- package/dist/llm/structured-call.js +49 -0
- package/dist/migrate-storage-node.mjs +8 -0
- package/dist/output/context.js +5 -5
- package/dist/output/renderers.js +74 -2
- package/dist/output/shapes/curate.js +14 -2
- package/dist/output/shapes/passthrough.js +0 -1
- package/dist/output/text/helpers.js +16 -1
- package/dist/registry/providers/skills-sh.js +21 -147
- package/dist/registry/providers/static-index.js +15 -157
- package/dist/registry/resolve.js +22 -9
- package/dist/runtime.js +25 -1
- package/dist/scripts/migrate-storage.js +2617 -1961
- package/dist/scripts/migrations/import-fs-improve-runs-to-db.js +759 -510
- package/dist/setup/setup.js +29 -8
- package/dist/sources/include.js +6 -2
- package/dist/sources/providers/filesystem.js +0 -1
- package/dist/sources/providers/git-install.js +210 -0
- package/dist/sources/providers/git-provider.js +234 -0
- package/dist/sources/providers/git-stash.js +248 -0
- package/dist/sources/providers/git.js +10 -661
- package/dist/sources/providers/npm.js +2 -6
- package/dist/sources/providers/provider-utils.js +13 -7
- package/dist/sources/providers/sync-from-ref.js +9 -1
- package/dist/sources/providers/tar-utils.js +16 -8
- package/dist/sources/providers/website.js +9 -5
- package/dist/sources/website-ingest.js +187 -29
- package/dist/sources/wiki-fetchers/registry.js +53 -0
- package/dist/sources/wiki-fetchers/youtube.js +239 -0
- package/dist/storage/database.js +45 -10
- package/dist/storage/managed-db.js +82 -0
- package/dist/storage/repositories/registry-cache.js +92 -0
- package/dist/storage/sqlite-pragmas.js +146 -0
- package/dist/tasks/backends/cron.js +1 -1
- package/dist/tasks/backends/launchd.js +1 -1
- package/dist/tasks/backends/schtasks.js +1 -1
- package/dist/tasks/{resolveAkmBin.js → resolve-akm-bin.js} +2 -2
- package/dist/tasks/runner.js +5 -13
- package/dist/text-import-hook.mjs +0 -0
- package/dist/wiki/wiki.js +37 -0
- package/dist/workflows/db.js +3 -4
- package/dist/workflows/runtime/runs.js +1 -117
- package/dist/workflows/runtime/workflow-asset-loader.js +125 -0
- package/dist/workflows/validate-summary.js +2 -7
- package/docs/data-and-telemetry.md +3 -2
- package/docs/migration/release-notes/0.9.0.md +39 -0
- package/package.json +13 -11
- package/dist/commands/db-cli.js +0 -23
- package/dist/indexer/db/db-backup.js +0 -376
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
category: convention
|
|
3
|
+
description: Soft authoring conventions for lesson assets that capture compounding, hard-won judgment.
|
|
4
|
+
when_to_use: Surfaced to authoring agents when they write or revise a lesson asset.
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<!--
|
|
8
|
+
SOFT guidance only — advice, not a contract. Nothing here is enforced by the
|
|
9
|
+
proposal gate; validator-rejecting HARD rules live in src/core/authoring-rules.ts
|
|
10
|
+
and remain the sole enforced source. Editing or deleting this file cannot weaken
|
|
11
|
+
the gate. Tune the guidance below to match how your stash wants this asset type
|
|
12
|
+
maintained.
|
|
13
|
+
-->
|
|
14
|
+
|
|
15
|
+
# Lesson authoring conventions
|
|
16
|
+
|
|
17
|
+
A lesson captures durable, hard-won judgment that should compound across future agent sessions. Treat it as distilled judgment about how to act: it should preserve the extracted meaning of what real use revealed, not merely recount an incident or summarize another asset.
|
|
18
|
+
|
|
19
|
+
## Purpose
|
|
20
|
+
|
|
21
|
+
Use a lesson to record:
|
|
22
|
+
|
|
23
|
+
- when to reach for a pattern, asset, or decision;
|
|
24
|
+
- what tends to go wrong without it;
|
|
25
|
+
- what evidence, feedback, or repeated experience made the lesson worth keeping;
|
|
26
|
+
- how a future agent should act differently because this lesson exists.
|
|
27
|
+
|
|
28
|
+
## Authoring strategy
|
|
29
|
+
|
|
30
|
+
- Lead with the trigger: the concrete situation where this lesson should be loaded.
|
|
31
|
+
- Follow with the failure mode: what mistake, omission, or confusion this prevents.
|
|
32
|
+
- End with the reusable judgment: the practical rule a future agent can apply.
|
|
33
|
+
- Keep the scope narrow. A lesson should teach one durable behavior.
|
|
34
|
+
- Prefer observed evidence over generic advice. Mention the kind of signal that produced the lesson, such as rejected proposals, repeated lint findings, user feedback, or session outcomes.
|
|
35
|
+
- Do not restate the source asset. Lessons are compiled judgment, not copied documentation.
|
|
36
|
+
- Write for a future agent mid-task: direct, practical, and easy to apply.
|
|
37
|
+
|
|
38
|
+
## Maintenance strategy
|
|
39
|
+
|
|
40
|
+
- Update an existing lesson when new feedback sharpens the same judgment.
|
|
41
|
+
- Create a new lesson only when the trigger or failure mode is meaningfully different.
|
|
42
|
+
- Deprecate or revise stale lessons instead of allowing contradictory guidance to accumulate.
|
|
43
|
+
- When a lesson becomes broadly normative, consider promoting the stable rule into a `fact:conventions/...` asset.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
category: convention
|
|
3
|
+
description: Soft authoring conventions for memory assets using durable-context and provenance discipline.
|
|
4
|
+
when_to_use: Surfaced to authoring agents when they write or revise a memory asset.
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<!--
|
|
8
|
+
SOFT guidance only — advice, not a contract. Nothing here is enforced by the
|
|
9
|
+
proposal gate; validator-rejecting HARD rules live in src/core/authoring-rules.ts
|
|
10
|
+
and remain the sole enforced source. Editing or deleting this file cannot weaken
|
|
11
|
+
the gate. Tune the guidance below to match how your stash wants this asset type
|
|
12
|
+
maintained.
|
|
13
|
+
-->
|
|
14
|
+
|
|
15
|
+
# Memory authoring conventions
|
|
16
|
+
|
|
17
|
+
A memory is a short, durable note that should survive beyond the current session. Treat it as a small compiled fact or decision, not a transcript fragment.
|
|
18
|
+
|
|
19
|
+
## Purpose
|
|
20
|
+
|
|
21
|
+
Use a memory when a future agent would make a better decision by knowing a specific user preference, project decision, environmental fact, constraint, or observed outcome.
|
|
22
|
+
|
|
23
|
+
## Authoring strategy
|
|
24
|
+
|
|
25
|
+
- Record one durable fact, decision, or constraint per memory.
|
|
26
|
+
- Write it so it stands alone without the original conversation.
|
|
27
|
+
- Include enough context to prevent misapplication: subject, scope, and when it matters.
|
|
28
|
+
- Prefer stable, reusable information over step-by-step session play-by-play.
|
|
29
|
+
- Mark uncertainty or subjectivity clearly when the memory is not a settled fact.
|
|
30
|
+
- Preserve source/provenance in frontmatter or body when the memory came from a session, log, user statement, or derived inference.
|
|
31
|
+
- Avoid storing secrets, private tokens, or volatile temporary state as memory.
|
|
32
|
+
|
|
33
|
+
## Maintenance strategy
|
|
34
|
+
|
|
35
|
+
- Update or supersede memories when newer evidence changes the truth.
|
|
36
|
+
- Consolidate repeated memories into a clearer fact or knowledge asset.
|
|
37
|
+
- Convert broad, stable conventions into `fact` assets.
|
|
38
|
+
- Archive memories that are no longer current rather than letting stale context keep influencing agents.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
category: convention
|
|
3
|
+
description: Soft authoring conventions for script assets using agent-safe CLI helper principles.
|
|
4
|
+
when_to_use: Surfaced to authoring agents when they write or revise a script asset.
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<!--
|
|
8
|
+
SOFT guidance only — advice, not a contract. Nothing here is enforced by the
|
|
9
|
+
proposal gate; validator-rejecting HARD rules live in src/core/authoring-rules.ts
|
|
10
|
+
and remain the sole enforced source. Editing or deleting this file cannot weaken
|
|
11
|
+
the gate. Tune the guidance below to match how your stash wants this asset type
|
|
12
|
+
maintained.
|
|
13
|
+
-->
|
|
14
|
+
|
|
15
|
+
# Script authoring conventions
|
|
16
|
+
|
|
17
|
+
A script is an executable helper that an agent or human can run on demand. Treat it like a small, deterministic tool that reduces manual bookkeeping and makes repeatable operations safer.
|
|
18
|
+
|
|
19
|
+
## Purpose
|
|
20
|
+
|
|
21
|
+
Use a script when a task is mechanical, repeatable, and better handled by a deterministic program than by free-form agent edits.
|
|
22
|
+
|
|
23
|
+
## Authoring strategy
|
|
24
|
+
|
|
25
|
+
- Start with the appropriate interpreter line and a short usage comment.
|
|
26
|
+
- State what the script does, expected inputs, outputs, side effects, and failure behavior.
|
|
27
|
+
- Keep one script focused on one job.
|
|
28
|
+
- Validate inputs before mutation.
|
|
29
|
+
- Fail loudly and early on unsafe or ambiguous input.
|
|
30
|
+
- Declare required dependencies and assumptions explicitly rather than assuming a tool is installed.
|
|
31
|
+
- Justify any non-obvious constant (timeout, retry count, limit) in a comment so a future reader can adjust it safely.
|
|
32
|
+
- Prefer idempotent behavior where practical.
|
|
33
|
+
- Avoid hidden network calls, destructive defaults, or silent writes.
|
|
34
|
+
- Never print secrets or sensitive values.
|
|
35
|
+
- Write output that is easy for both humans and agents to parse.
|
|
36
|
+
- Favor clear names, straightforward control flow, and comments at decision points.
|
|
37
|
+
|
|
38
|
+
## Maintenance strategy
|
|
39
|
+
|
|
40
|
+
- Add examples when agents or users repeatedly invoke the script incorrectly.
|
|
41
|
+
- Keep dangerous actions behind explicit flags.
|
|
42
|
+
- When a script becomes a core operation, add or update a workflow that explains when to run it.
|
|
43
|
+
- If the script encodes a convention, also document that convention in a fact or knowledge asset.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
category: convention
|
|
3
|
+
description: Soft authoring conventions for skill assets as reusable, just-in-time procedural rulebooks.
|
|
4
|
+
when_to_use: Surfaced to authoring agents when they write or revise a skill asset.
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<!--
|
|
8
|
+
SOFT guidance only — advice, not a contract. Nothing here is enforced by the
|
|
9
|
+
proposal gate; validator-rejecting HARD rules live in src/core/authoring-rules.ts
|
|
10
|
+
and remain the sole enforced source. Editing or deleting this file cannot weaken
|
|
11
|
+
the gate. Tune the guidance below to match how your stash wants this asset type
|
|
12
|
+
maintained.
|
|
13
|
+
-->
|
|
14
|
+
|
|
15
|
+
# Skill authoring conventions
|
|
16
|
+
|
|
17
|
+
A skill is a reusable, self-contained capability stored as `skills/<name>/SKILL.md`. Treat it like a compact operating manual that an agent can load just-in-time, follow without rediscovering the process, and improve when repeated use exposes gaps.
|
|
18
|
+
|
|
19
|
+
## Purpose
|
|
20
|
+
|
|
21
|
+
Use a skill when the stash needs reusable procedural guidance for a recurring class of work. A good skill reduces repeated reasoning cost: future agents should not have to reconstruct the same method from raw context.
|
|
22
|
+
|
|
23
|
+
## Authoring strategy
|
|
24
|
+
|
|
25
|
+
- Make the dispatch signal clear. The description should let a dispatcher decide whether to load the skill without reading the whole body.
|
|
26
|
+
- Open with the outcome the skill helps produce.
|
|
27
|
+
- State when to use it, when not to use it, and what inputs the agent should gather before acting.
|
|
28
|
+
- Structure the body as a rulebook: principles first, then procedure, then checks.
|
|
29
|
+
- Use short sections and ordered steps where sequence matters.
|
|
30
|
+
- Match the level of detail to how fragile the task is: open-ended work gets high-level heuristics and room to reason, while fragile or consistency-critical steps get exact, unambiguous instructions.
|
|
31
|
+
- Keep the body lean and move bulky background into companion knowledge docs referenced one level deep, so the skill loads cheaply and stays scannable.
|
|
32
|
+
- Include failure modes and verification steps. A skill should tell the agent how to know the work is complete.
|
|
33
|
+
- Keep one skill focused on one capability. Split unrelated concerns into separate skills and cross-reference them.
|
|
34
|
+
|
|
35
|
+
## Maintenance strategy
|
|
36
|
+
|
|
37
|
+
- Update the skill when session logs, feedback, or rejected proposals reveal repeatable confusion.
|
|
38
|
+
- Add companion knowledge docs when the skill needs background material that would bloat the main procedure.
|
|
39
|
+
- Promote durable recurring corrections into the skill; leave one-off observations in memories or lessons.
|
|
40
|
+
- Prefer small edits that preserve the skill’s operational shape over broad rewrites that erase tested guidance.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
category: convention
|
|
3
|
+
description: Soft authoring conventions for workflow assets using explicit operations, logging, and lintable steps.
|
|
4
|
+
when_to_use: Surfaced to authoring agents when they write or revise a workflow asset.
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<!--
|
|
8
|
+
SOFT guidance only — advice, not a contract. Nothing here is enforced by the
|
|
9
|
+
proposal gate; validator-rejecting HARD rules live in src/core/authoring-rules.ts
|
|
10
|
+
and remain the sole enforced source. Editing or deleting this file cannot weaken
|
|
11
|
+
the gate. Tune the guidance below to match how your stash wants this asset type
|
|
12
|
+
maintained.
|
|
13
|
+
-->
|
|
14
|
+
|
|
15
|
+
# Workflow authoring conventions
|
|
16
|
+
|
|
17
|
+
A workflow describes an ordered process an agent or human can follow. Treat it as the operation layer of a maintained stash: clear steps, clear state, clear completion criteria, and enough bookkeeping to resume safely.
|
|
18
|
+
|
|
19
|
+
## Purpose
|
|
20
|
+
|
|
21
|
+
Use a workflow when the task requires multiple steps, branching decisions, repeated checks, or durable progress tracking.
|
|
22
|
+
|
|
23
|
+
## Authoring strategy
|
|
24
|
+
|
|
25
|
+
- Open with the outcome the workflow produces.
|
|
26
|
+
- State prerequisites, required inputs, and tools before the steps.
|
|
27
|
+
- Use ordered step sections when sequence matters.
|
|
28
|
+
- For each step, specify:
|
|
29
|
+
- what to do;
|
|
30
|
+
- what evidence or input it depends on;
|
|
31
|
+
- what output it produces;
|
|
32
|
+
- how to know the step is done.
|
|
33
|
+
- Make branch points explicit. Do not bury conditional behavior in prose.
|
|
34
|
+
- Include validation, lint, or review steps near the end.
|
|
35
|
+
- Include rollback or recovery notes when the workflow mutates files, state, repos, or external systems.
|
|
36
|
+
- Keep steps atomic and resumable so an interrupted run can continue without guessing.
|
|
37
|
+
|
|
38
|
+
## Maintenance strategy
|
|
39
|
+
|
|
40
|
+
- Update the workflow when repeated execution reveals missing checks or unclear handoffs.
|
|
41
|
+
- Add logging expectations when the workflow creates durable state.
|
|
42
|
+
- Extract reusable sub-procedures into skills or scripts when the workflow grows too broad.
|
|
43
|
+
- Record recurring mistakes as lessons, then fold stable corrections back into the workflow.
|