@williambeto/ai-workflow 2.3.1 → 2.3.2

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,3 +1,13 @@
1
+ ## [2.3.2] - 2026-06-19
2
+
3
+ ### Documentation
4
+ - Clarified first-time usage with `npx @williambeto/ai-workflow init`.
5
+ - Clarified local installed-package alias usage with `npx aw init`, `npx aw doctor`, and `npx aw run`.
6
+
7
+ ### Notes
8
+ - No CLI behavior changed.
9
+ - No runtime behavior changed.
10
+
1
11
  ## [2.3.1] - 2026-06-18
2
12
 
3
13
  ### Fixed
package/README.md CHANGED
@@ -21,26 +21,30 @@ The workflow the product guarantees is:
21
21
 
22
22
  In practice, the kit is neither a frontend framework nor a UI library. It is an operational layer for software agents: it installs instructions and guardrails so that the agent can work more effectively inside the user's repository.
23
23
 
24
- ## Installation
24
+ ## Installation and Usage
25
25
 
26
- ### Current public release
26
+ ### First-time usage
27
+
28
+ Use the full package command when running the kit before it is installed in a project:
27
29
 
28
30
  ```bash
29
- npm install -g @williambeto/ai-workflow@latest
31
+ npx @williambeto/ai-workflow init
30
32
  ```
31
33
 
32
- Use `latest` for the supported public release. Release notes record exact historical versions when needed.
34
+ ### Short alias after installation
33
35
 
34
- ## Quick start
36
+ After installing AI Workflow Kit in a project, the shorter `aw` binary is available through `node_modules/.bin`:
35
37
 
36
38
  ```bash
37
- mkdir workflow-test && cd workflow-test
38
- npm init -y
39
- ai-workflow init --yes
40
- ai-workflow doctor
41
- ai-workflow execute "Atlas, list all agents, subagents, skills, and commands in the project. Present them in a table with their name, description, and usage examples."
39
+ npm install -D @williambeto/ai-workflow
40
+
41
+ npx aw init
42
+ npx aw doctor
43
+ npx aw run "Atlas, list all agents, subagents, skills, and commands in the project. Present them in a table with their name, description, and usage examples."
42
44
  ```
43
45
 
46
+ The `aw` binary is an alias for the same CLI entrypoint as `ai-workflow`.
47
+
44
48
  The CLI receives the natural request, classifies the intent, plans the workflow, switch/creates branch safely, delegates coding tasks to the OpenCode runtime adapter, validates changes, and runs bounded remediation if necessary before outputting the handoff summary.
45
49
 
46
50
  ## Modes and profiles
@@ -19,10 +19,17 @@ Version `2.x` is a breaking public line from the previous `1.x` line. Test upgra
19
19
 
20
20
  4. Inspect initialization before applying it:
21
21
 
22
+ For first-time or pre-installation usage:
22
23
  ```bash
23
- ai-workflow init --dry-run
24
- ai-workflow init --yes
25
- ai-workflow doctor
24
+ npx @williambeto/ai-workflow init --dry-run
25
+ npx @williambeto/ai-workflow init --yes
26
+ ```
27
+
28
+ After installing AI Workflow Kit locally in your project:
29
+ ```bash
30
+ npx aw init --dry-run
31
+ npx aw init --yes
32
+ npx aw doctor
26
33
  ```
27
34
 
28
35
  ## Main changes in version 2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@williambeto/ai-workflow",
3
- "version": "2.3.1",
3
+ "version": "2.3.2",
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",
@@ -29,7 +29,8 @@
29
29
  "url": "https://github.com/williambeto/ai-workflow/issues"
30
30
  },
31
31
  "bin": {
32
- "ai-workflow": "bin/ai-workflow.js"
32
+ "ai-workflow": "bin/ai-workflow.js",
33
+ "aw": "bin/ai-workflow.js"
33
34
  },
34
35
  "files": [
35
36
  "bin",