@williambeto/ai-workflow 2.9.3 โ†’ 2.9.5

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 CHANGED
@@ -1,5 +1,41 @@
1
1
  ## [unreleased]
2
2
 
3
+ ## [2.9.5] - 2026-07-17
4
+
5
+ ### ๐Ÿ›ก๏ธ Hardening
6
+
7
+ - Declare the 17 required command-to-policy relationships through a
8
+ runtime-neutral canonical policy section
9
+ - Fail validation when required command policy references are missing,
10
+ duplicated, unknown, or unexpected
11
+
12
+ ### ๐Ÿงช Testing
13
+
14
+ - Add data-driven contract coverage for the complete policy reference map
15
+ - Verify referenced policies remain available in OpenCode installations and
16
+ Codex command skills
17
+
18
+ ## [2.9.4] - 2026-07-16
19
+
20
+ ### ๐Ÿ›ก๏ธ Hardening
21
+
22
+ - Add an opt-in repository-local pre-push hook that rejects direct updates to
23
+ `main` and `master` without changing the published consumer payload
24
+ - Refresh development-only lockfile dependencies to remove known production,
25
+ moderate, high, and critical audit findings
26
+
27
+ ### ๐Ÿงช Testing
28
+
29
+ - Add stable contract coverage for documentation integrity, protected-branch
30
+ pushes, finalizer change detection, and validation-result precedence
31
+ - Verify that the public tarball excludes contributor hooks, internal
32
+ validators, tests, and generated evidence
33
+
34
+ ### ๐Ÿ“š Documentation
35
+
36
+ - Align the README with the canonical AI Workflow Kit product promise,
37
+ installed paths, agent roles, and the actual CLI enforcement boundary
38
+
3
39
  ## [2.9.3] - 2026-07-16
4
40
 
5
41
  ### ๐Ÿ› Bug Fixes
package/README.md CHANGED
@@ -15,20 +15,22 @@
15
15
 
16
16
  ## What is AI Workflow Kit?
17
17
 
18
- AI Workflow Kit (AIWK) is an **npm CLI** you install in your project that makes AI-assisted software delivery **safe, structured, and verifiable**.
18
+ AI Workflow is an npm CLI that installs agents, commands, skills, policies and templates into your repository. It guides coding agents from request to implementation, validation and evidence.
19
19
 
20
- It works with [OpenCode](https://opencode.ai) to turn a natural language request into a full delivery โ€” with branch protection, specialist agent delegation, automated validation, and a persisted evidence log.
20
+ AI Workflow Kit preserves workflow integrity so coding agents cannot skip from request to code to success without an explicit implementation path, proportional validation, and final evidence.
21
+
22
+ It works with [OpenCode](https://opencode.ai) to turn a natural language request into a proportionate delivery โ€” with branch isolation, optional specialist analysis, observed validation, and evidence appropriate to the task risk.
21
23
 
22
24
  **Without AIWK**, a coding agent receives a request, writes code, and reports success. There is no proof, no branch isolation, and no guarantee that tests passed.
23
25
 
24
26
  **With AIWK**, the same request travels through a mandatory workflow:
25
27
 
26
28
  ```
27
- Your request โ†’ Classification โ†’ Branch Gate โ†’ Specialist Agent
28
- โ†’ Automated Validation โ†’ Evidence โ†’ Handoff
29
+ Your request โ†’ Classification โ†’ Branch Gate โ†’ Workflow Owner
30
+ โ†’ Observed Validation โ†’ Evidence โ†’ Handoff
29
31
  ```
30
32
 
31
- No step can be skipped. No claim of success is made without proof.
33
+ Within the `ai-workflow execute` control plane, every stage is evaluated and a successful final state requires observed validation. Direct model chat remains subject to runtime capabilities; see the [runtime compatibility matrix](dist-assets/docs/compatibility/runtime-matrix.md).
32
34
 
33
35
  ---
34
36
 
@@ -47,7 +49,7 @@ AI Workflow Kit enforces a contract: **the agent must earn the right to deliver.
47
49
 
48
50
  ## How it works
49
51
 
50
- AIWK installs a structured team of 6 specialist agents into your repository. Each agent has a defined role, a permission boundary, and cannot claim work that belongs to another.
52
+ AIWK installs a structured team of 6 core workflow agents into your repository. Each agent has a defined role and ownership boundary. Any core agent may request bounded analysis from a registered specialist when that improves the result, while retaining ownership of its workflow stage.
51
53
 
52
54
  When you run `npx aw execute "your task"`, Atlas (the coordinator) takes over:
53
55
 
@@ -59,7 +61,7 @@ When you run `npx aw execute "your task"`, Atlas (the coordinator) takes over:
59
61
  | **4. Implement** | Astra | Implements the change on the feature branch |
60
62
  | **5. Validate** | Sage | Runs tests, accessibility checks, visual regression โ€” writes evidence |
61
63
  | **6. Remediate** | Phoenix | If validation fails, Phoenix heals within a bounded attempt limit |
62
- | **7. Evidence** | Atlas | Saves `EVIDENCE.json` + `HANDOFF-<task>.md` to `.ai-workflow/` |
64
+ | **7. Evidence** | Atlas | Saves the handoff and ledger; persists `EVIDENCE.json` when the evidence policy requires it |
63
65
 
64
66
  > **Proportional by design.** A typo fix in a README gets 1 remediation attempt and no spec. A payment integration gets 3 attempts, a required SDD, and mandatory persisted evidence. The kit calibrates automatically.
65
67
 
@@ -100,7 +102,7 @@ This creates the `.ai-workflow/` directory and installs 6 agents, 25 skills, and
100
102
  npx aw execute "Add a health check endpoint returning HTTP 200"
101
103
  ```
102
104
 
103
- Atlas classifies the request, creates a branch, delegates to Astra, validates with Sage, and writes evidence โ€” all automatically.
105
+ Atlas classifies the request, the branch gate establishes a safe branch, Astra owns requested changes, and validation and evidence run proportionally.
104
106
 
105
107
  ### 4. Check the evidence
106
108
 
@@ -134,7 +136,7 @@ Each agent has a fixed role and cannot exceed its operational boundary.
134
136
  | ๐Ÿงช **Sage** | Validator | Audits changes, runs quality gates, writes verifiable evidence |
135
137
  | ๐Ÿ”ง **Phoenix** | Recovery | Heals broken states within a bounded remediation limit |
136
138
 
137
- Agents are installed as prompts in your `.ai-workflow/agents/` directory. You can read, audit, or customise them.
139
+ Agents are installed as prompts in your `.ai-workflow/opencode/agents/` directory. You can read, audit, or customise them.
138
140
 
139
141
  ---
140
142
 
@@ -170,15 +172,22 @@ You don't configure this. The kit reads your request and calibrates automaticall
170
172
 
171
173
  Running `npx aw init` writes the following into your repository:
172
174
 
175
+ The canonical OpenCode runtime paths are `.ai-workflow/opencode/agents/`, `.ai-workflow/opencode/commands/`, `.ai-workflow/opencode/skills/`, and `.ai-workflow/opencode/docs/`.
176
+
173
177
  ```
174
178
  .ai-workflow/
175
- โ”œโ”€โ”€ agents/ # Atlas, Nexus, Orion, Astra, Sage, Phoenix prompts
176
- โ”œโ”€โ”€ commands/ # Slash commands for your AI IDE
177
- โ”œโ”€โ”€ skills/ # 25 domain skills (architecture, security, database, ...)
179
+ โ”œโ”€โ”€ opencode/
180
+ โ”‚ โ”œโ”€โ”€ agents/ # Atlas, Nexus, Orion, Astra, Sage, Phoenix prompts
181
+ โ”‚ โ”œโ”€โ”€ commands/ # Slash commands for OpenCode
182
+ โ”‚ โ”œโ”€โ”€ skills/ # Domain skills (architecture, security, database, ...)
183
+ โ”‚ โ””โ”€โ”€ docs/ # Runtime policies, profiles, references, and guides
184
+ โ”œโ”€โ”€ harness/ # Workflow and handoff harness
185
+ โ”œโ”€โ”€ schemas/ # Evidence and workflow schemas
178
186
  โ”œโ”€โ”€ templates/ # Specification and handoff templates
179
- โ”œโ”€โ”€ policies/ # Branch gate, quality gate, merge gate policies
180
- โ”œโ”€โ”€ history/ # Ledger of every workflow execution
181
- โ””โ”€โ”€ handoffs/ # HANDOFF-<task>.md for every completed delivery
187
+ โ”œโ”€โ”€ history/ # Runtime-generated workflow ledgers
188
+ โ””โ”€โ”€ handoffs/ # Runtime-generated delivery handoffs
189
+ AGENTS.md # Project-local contributor contract
190
+ QUICKSTART.md # Installed quickstart
182
191
  opencode.jsonc # OpenCode runtime configuration
183
192
  ```
184
193
 
@@ -188,8 +197,8 @@ Everything is plain text โ€” readable, auditable, and version-controlled.
188
197
 
189
198
  ## Safety Guarantees
190
199
 
191
- - **Branch protection**: execution is always blocked on `main`/`master`. A feature branch is created automatically.
192
- - **Read-only confinement**: tasks classified as read-only are cryptographically verified โ€” any file mutation blocks the execution.
200
+ - **Branch gate**: write-mode execution is blocked on `main`/`master`. A feature branch is created automatically when the worktree is clean.
201
+ - **Read-only confinement**: tasks classified as read-only compare SHA-256 workspace snapshots before and after execution; any observed mutation blocks completion.
193
202
  - **Bounded remediation**: Phoenix is limited to N attempts. The kit never loops indefinitely.
194
203
  - **Mandatory handoff**: every write-mode execution produces a `HANDOFF-<task>.md` with evidence, diff, and status โ€” regardless of risk level.
195
204
  - **Schema-validated evidence**: `EVIDENCE.json` is validated against a strict Ajv schema. Path traversal and shell injection are blocked.
@@ -231,12 +240,12 @@ Beyond the 6 core agents, AIWK ships 25 domain skills that agents activate as co
231
240
 
232
241
  ## Contributing
233
242
 
234
- AIWK uses itself to manage its own development. To contribute:
243
+ This development repository follows the AIWK contributor contract directly without installing consumer runtime assets into itself. To contribute:
235
244
 
236
245
  ```
237
246
  src/ TypeScript source (CLI + Core)
238
247
  dist-assets/ Templates, agents, skills, schemas installed into consumer repos
239
- tests/ Unit (296 tests) and E2E (19 tests) suites
248
+ tests/ Unit, contract, linting, and E2E suites
240
249
  internal/ Validation pipelines and release scripts
241
250
  docs/ Guides, ADRs, specs, and release notes
242
251
  ```
@@ -249,6 +258,14 @@ npm run validate
249
258
 
250
259
  All 23 quality gates must pass.
251
260
 
261
+ Contributors without server-side branch protection can enable the repository's local push safeguard explicitly:
262
+
263
+ ```bash
264
+ npm run setup:hooks
265
+ ```
266
+
267
+ The hook blocks pushes targeting `main` or `master` and allows maintenance or feature branches. It prevents accidents but is not a server-side security boundary and can be bypassed with Git's `--no-verify` option.
268
+
252
269
  ---
253
270
 
254
271
  ## License
@@ -31,6 +31,13 @@ Route user requests safely, proportionately, and securely according to the permi
31
31
  - Route workspace implementation to Astra, never directly to a skill-backed specialist.
32
32
  - Printed code is not a substitute for a requested repository change.
33
33
 
34
+ ## Canonical policies
35
+ Resolve these policy files from the policies directory declared in `.ai-workflow/config.json`:
36
+ - `01-BRANCH_GATE.md`
37
+ - `03-QUALITY_GATE.md`
38
+ - `05-AGENT_CONTRACT.md`
39
+ - `06-FINAL_EVIDENCE_CONTRACT.md`
40
+
34
41
  ## Allowed tools
35
42
  - classify request
36
43
  - evaluate routing permissions
@@ -32,6 +32,12 @@ Execute package publication or deployment securely after passing validation chec
32
32
  - Do not deploy if any validation check fails.
33
33
  - Do not claim deploy execution without verified deploy logs.
34
34
 
35
+ ## Canonical policies
36
+ Resolve these policy files from the policies directory declared in `.ai-workflow/config.json`:
37
+ - `01-BRANCH_GATE.md`
38
+ - `06-FINAL_EVIDENCE_CONTRACT.md`
39
+ - `07-RELEASE_GATE.md`
40
+
35
41
  ## Allowed tools
36
42
  - execute deployment scripts
37
43
  - run environment smoke tests
@@ -31,6 +31,13 @@ Implement a small task with defined scope, verifying changes incrementally.
31
31
  - Do not claim implementation without validation evidence.
32
32
  - Treat the finalizer exit code and public status as authoritative.
33
33
 
34
+ ## Canonical policies
35
+ Resolve these policy files from the policies directory declared in `.ai-workflow/config.json`:
36
+ - `01-BRANCH_GATE.md`
37
+ - `03-QUALITY_GATE.md`
38
+ - `06-FINAL_EVIDENCE_CONTRACT.md`
39
+ - `PROCEDURE_UI_CHECKLIST.md`
40
+
34
41
  ## Allowed tools
35
42
  - read files
36
43
  - edit source files
@@ -32,6 +32,12 @@ Coordinate the release process, verifying package status and generating release
32
32
  - Do not push to remote, publish to npm, or create git tags without user approval.
33
33
  - Do not claim release readiness without release evidence document.
34
34
 
35
+ ## Canonical policies
36
+ Resolve these policy files from the policies directory declared in `.ai-workflow/config.json`:
37
+ - `01-BRANCH_GATE.md`
38
+ - `06-FINAL_EVIDENCE_CONTRACT.md`
39
+ - `07-RELEASE_GATE.md`
40
+
35
41
  ## Allowed tools
36
42
  - read version configuration
37
43
  - update changelog
@@ -29,6 +29,12 @@ Execute validation checks and compile an evidence report showing quality status.
29
29
  - All validation commands must exit 0.
30
30
  - Do not claim validation success without evidence log.
31
31
 
32
+ ## Canonical policies
33
+ Resolve these policy files from the policies directory declared in `.ai-workflow/config.json`:
34
+ - `03-QUALITY_GATE.md`
35
+ - `06-FINAL_EVIDENCE_CONTRACT.md`
36
+ - `PROCEDURE_UI_CHECKLIST.md`
37
+
32
38
  ## Allowed tools
33
39
  - execute test commands
34
40
  - run code linters
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@williambeto/ai-workflow",
3
- "version": "2.9.3",
3
+ "version": "2.9.5",
4
4
  "description": "AI Workflow Kit โ€” OpenCode-first software delivery workflow with agents, commands, skills, validation, and evidence",
5
5
  "license": "MIT",
6
6
  "author": "Josรฉ Willams",