soturail 0.4.1 → 0.7.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.
Files changed (165) hide show
  1. package/LICENSE +15 -21
  2. package/README.md +292 -157
  3. package/dist/cli.js +12 -0
  4. package/dist/cli.js.map +1 -1
  5. package/dist/commands/agents.js +39 -5
  6. package/dist/commands/agents.js.map +1 -1
  7. package/dist/commands/context.js +66 -2
  8. package/dist/commands/context.js.map +1 -1
  9. package/dist/commands/diagram.d.ts +2 -0
  10. package/dist/commands/diagram.js +24 -0
  11. package/dist/commands/diagram.js.map +1 -0
  12. package/dist/commands/eval.d.ts +2 -0
  13. package/dist/commands/eval.js +25 -0
  14. package/dist/commands/eval.js.map +1 -0
  15. package/dist/commands/format.js +14 -4
  16. package/dist/commands/format.js.map +1 -1
  17. package/dist/commands/fs.d.ts +2 -0
  18. package/dist/commands/fs.js +19 -0
  19. package/dist/commands/fs.js.map +1 -0
  20. package/dist/commands/harness.d.ts +2 -0
  21. package/dist/commands/harness.js +35 -0
  22. package/dist/commands/harness.js.map +1 -0
  23. package/dist/commands/mcp.js +5 -0
  24. package/dist/commands/mcp.js.map +1 -1
  25. package/dist/commands/memory.js +40 -0
  26. package/dist/commands/memory.js.map +1 -1
  27. package/dist/commands/native.js +4 -0
  28. package/dist/commands/native.js.map +1 -1
  29. package/dist/commands/policy.d.ts +2 -0
  30. package/dist/commands/policy.js +25 -0
  31. package/dist/commands/policy.js.map +1 -0
  32. package/dist/commands/release.js +9 -2
  33. package/dist/commands/release.js.map +1 -1
  34. package/dist/commands/run.js +15 -3
  35. package/dist/commands/run.js.map +1 -1
  36. package/dist/commands/skills.js +15 -0
  37. package/dist/commands/skills.js.map +1 -1
  38. package/dist/commands/validate.d.ts +2 -0
  39. package/dist/commands/validate.js +13 -0
  40. package/dist/commands/validate.js.map +1 -0
  41. package/dist/commands/workflow.js +35 -5
  42. package/dist/commands/workflow.js.map +1 -1
  43. package/dist/core/agent-docs-hygiene.d.ts +3 -0
  44. package/dist/core/agent-docs-hygiene.js +83 -0
  45. package/dist/core/agent-docs-hygiene.js.map +1 -0
  46. package/dist/core/agent-exporter.d.ts +3 -1
  47. package/dist/core/agent-exporter.js +136 -12
  48. package/dist/core/agent-exporter.js.map +1 -1
  49. package/dist/core/agent-profile.d.ts +1 -1
  50. package/dist/core/agent-registry.js +60 -0
  51. package/dist/core/agent-registry.js.map +1 -1
  52. package/dist/core/agent-runtime.d.ts +57 -0
  53. package/dist/core/agent-runtime.js +371 -0
  54. package/dist/core/agent-runtime.js.map +1 -0
  55. package/dist/core/config.d.ts +20 -0
  56. package/dist/core/config.js +39 -2
  57. package/dist/core/config.js.map +1 -1
  58. package/dist/core/context-intelligence.d.ts +47 -0
  59. package/dist/core/context-intelligence.js +283 -0
  60. package/dist/core/context-intelligence.js.map +1 -0
  61. package/dist/core/diagram-rail.d.ts +31 -0
  62. package/dist/core/diagram-rail.js +235 -0
  63. package/dist/core/diagram-rail.js.map +1 -0
  64. package/dist/core/diagram-validator.d.ts +10 -0
  65. package/dist/core/diagram-validator.js +53 -0
  66. package/dist/core/diagram-validator.js.map +1 -0
  67. package/dist/core/evaluation-suite.d.ts +28 -0
  68. package/dist/core/evaluation-suite.js +333 -0
  69. package/dist/core/evaluation-suite.js.map +1 -0
  70. package/dist/core/evidence-pack.d.ts +4 -0
  71. package/dist/core/evidence-pack.js +139 -0
  72. package/dist/core/evidence-pack.js.map +1 -0
  73. package/dist/core/format-compare.d.ts +12 -0
  74. package/dist/core/format-compare.js +68 -0
  75. package/dist/core/format-compare.js.map +1 -0
  76. package/dist/core/fs-evidence.d.ts +25 -0
  77. package/dist/core/fs-evidence.js +96 -0
  78. package/dist/core/fs-evidence.js.map +1 -0
  79. package/dist/core/harness-rail.d.ts +34 -0
  80. package/dist/core/harness-rail.js +158 -0
  81. package/dist/core/harness-rail.js.map +1 -0
  82. package/dist/core/json-validator.d.ts +24 -0
  83. package/dist/core/json-validator.js +138 -0
  84. package/dist/core/json-validator.js.map +1 -0
  85. package/dist/core/mcp-exposure.d.ts +20 -0
  86. package/dist/core/mcp-exposure.js +48 -0
  87. package/dist/core/mcp-exposure.js.map +1 -0
  88. package/dist/core/memory-rail.d.ts +37 -0
  89. package/dist/core/memory-rail.js +142 -0
  90. package/dist/core/memory-rail.js.map +1 -0
  91. package/dist/core/policy-rail.d.ts +27 -0
  92. package/dist/core/policy-rail.js +102 -0
  93. package/dist/core/policy-rail.js.map +1 -0
  94. package/dist/core/rail-utils.d.ts +10 -0
  95. package/dist/core/rail-utils.js +58 -0
  96. package/dist/core/rail-utils.js.map +1 -0
  97. package/dist/core/release-preflight.js +1 -1
  98. package/dist/core/release-preflight.js.map +1 -1
  99. package/dist/core/run-workspace.d.ts +38 -0
  100. package/dist/core/run-workspace.js +108 -0
  101. package/dist/core/run-workspace.js.map +1 -0
  102. package/dist/core/skill-routing.d.ts +2 -0
  103. package/dist/core/skill-routing.js +51 -0
  104. package/dist/core/skill-routing.js.map +1 -0
  105. package/dist/core/version.d.ts +1 -1
  106. package/dist/core/version.js +1 -1
  107. package/dist/core/workflow-store.d.ts +68 -0
  108. package/dist/core/workflow-store.js +360 -6
  109. package/dist/core/workflow-store.js.map +1 -1
  110. package/docs/agent-docs-hygiene.md +175 -0
  111. package/docs/agents.md +190 -2
  112. package/docs/benchmarking.md +213 -2
  113. package/docs/comparisons.md +195 -11
  114. package/docs/context-intelligence.md +127 -0
  115. package/docs/context-packs.md +237 -1
  116. package/docs/deep-agents-patterns.md +188 -0
  117. package/docs/diagram-rail.md +125 -0
  118. package/docs/ecosystem-influences.md +435 -0
  119. package/docs/evaluation-suite.md +196 -0
  120. package/docs/filesystem-evidence-rail.md +119 -0
  121. package/docs/future-rails-index.md +209 -0
  122. package/docs/harness-rail.md +117 -0
  123. package/docs/licensing-strategy.md +135 -0
  124. package/docs/mcp.md +96 -0
  125. package/docs/memory-rail.md +189 -0
  126. package/docs/metrics.md +136 -1
  127. package/docs/migration-v0.5.md +89 -0
  128. package/docs/policy-rail.md +184 -0
  129. package/docs/release-checklist.md +14 -0
  130. package/docs/release-workflow.md +34 -1
  131. package/docs/releases/README.md +27 -0
  132. package/docs/releases/RELEASE_NOTES_v0.2.1.md +19 -0
  133. package/docs/releases/RELEASE_NOTES_v0.2.2.md +48 -0
  134. package/docs/releases/RELEASE_NOTES_v0.2.3.md +36 -0
  135. package/docs/releases/RELEASE_NOTES_v0.3.0.md +42 -0
  136. package/docs/releases/RELEASE_NOTES_v0.3.1.md +37 -0
  137. package/docs/releases/RELEASE_NOTES_v0.3.2.md +33 -0
  138. package/docs/releases/RELEASE_NOTES_v0.3.3.md +31 -0
  139. package/docs/releases/RELEASE_NOTES_v0.4.0.md +35 -0
  140. package/docs/releases/RELEASE_NOTES_v0.4.1.md +37 -0
  141. package/docs/releases/RELEASE_NOTES_v0.5.0.md +21 -0
  142. package/docs/releases/RELEASE_NOTES_v0.5.1.md +19 -0
  143. package/docs/releases/RELEASE_NOTES_v0.5.2.md +27 -0
  144. package/docs/releases/RELEASE_NOTES_v0.6.0.md +33 -0
  145. package/docs/releases/RELEASE_NOTES_v0.6.1.md +37 -0
  146. package/docs/releases/RELEASE_NOTES_v0.7.0.md +33 -0
  147. package/docs/roadmap-agent-runtime-addendum.md +304 -0
  148. package/docs/roadmap-harness-diagram-payload-addendum.md +300 -0
  149. package/docs/rules.md +56 -0
  150. package/docs/security-model.md +56 -0
  151. package/docs/skill-rail.md +57 -0
  152. package/docs/spec-driven-workflow.md +49 -9
  153. package/docs/structured-payload-rail.md +251 -0
  154. package/docs/tutorial-antigravity.md +20 -0
  155. package/docs/tutorial-claude-code.md +23 -0
  156. package/docs/tutorial-codex.md +22 -0
  157. package/docs/tutorial-context-formats.md +28 -0
  158. package/docs/tutorial-cursor.md +23 -0
  159. package/docs/tutorial-deep-agents-role-packs.md +24 -0
  160. package/docs/tutorial-diagram-spec.md +26 -0
  161. package/docs/tutorial-gemini-cli.md +21 -0
  162. package/docs/tutorial-harness-workflow.md +25 -0
  163. package/docs/workflow-rail.md +98 -14
  164. package/examples/agents/README.md +13 -0
  165. package/package.json +2 -2
@@ -1,15 +1,25 @@
1
1
  # Workflow Rail
2
2
 
3
- Workflow Rail is a local task state system for SotuRail. It stores auditable workflow artifacts under `.soturail/workflows/` and can optionally plan or create local Git worktrees.
3
+ Workflow Rail is SotuRail's local task state system. It stores auditable workflow artifacts under `.soturail/workflows/` and can optionally plan local Git worktree isolation.
4
+
5
+ ## Commands
6
+
7
+ v0.7.0 adds phase-oriented Workflow Rail 2.0 commands while keeping the older v0.4 workflow commands:
4
8
 
5
9
  ```bash
10
+ soturail workflow setup
11
+ soturail workflow plan "Implement feature"
12
+ soturail workflow work --note "Implemented the first slice"
13
+ soturail workflow review --all
14
+ soturail workflow verify
15
+ soturail workflow evidence <id>
16
+ soturail workflow diagram <id>
17
+
6
18
  soturail workflow new "Implement feature"
7
19
  soturail workflow list
8
20
  soturail workflow show <id>
9
- soturail workflow plan <id>
10
21
  soturail workflow start <id> --worktree --dry-run
11
22
  soturail workflow status <id>
12
- soturail workflow verify <id>
13
23
  soturail workflow close <id>
14
24
  soturail workflow cleanup --closed --dry-run
15
25
  ```
@@ -28,17 +38,83 @@ Workflows use explicit states:
28
38
 
29
39
  ## Storage
30
40
 
31
- Each workflow uses:
41
+ Workflow Rail writes local JSON, YAML and Markdown only:
42
+
43
+ ```txt
44
+ .soturail/workflows/
45
+ index.json
46
+ current.json
47
+ templates/
48
+ <id>/
49
+ workflow.yml
50
+ plan.md
51
+ plan.json
52
+ tasks.md
53
+ verification.md
54
+ work.md
55
+ review.md
56
+ review.json
57
+ verify.md
58
+ verify.json
59
+ logs/
60
+ ```
61
+
62
+ ## Workflow Rail 2.0 Phases
63
+
64
+ The v0.7.0 loop is:
32
65
 
33
66
  ```txt
34
- .soturail/workflows/<id>/
35
- ├── workflow.yml
36
- ├── plan.md
37
- ├── tasks.md
38
- ├── verification.md
39
- └── logs/
67
+ setup -> plan -> work -> review -> verify -> evidence
40
68
  ```
41
69
 
70
+ `workflow setup` creates the local scaffold and template folder.
71
+
72
+ `workflow plan "title"` creates a workflow, marks it planned and writes a machine-readable `plan.json` with tasks, acceptance gates, role packs, context routes, linked run workspace if available and evidence path.
73
+
74
+ `workflow work` marks the active phase and appends a progress note to `work.md`. It links current changed-file counts, raw IDs and harness failures where available.
75
+
76
+ `workflow review --all` writes deterministic review reports without requiring an LLM:
77
+
78
+ ```txt
79
+ security
80
+ docs
81
+ tests
82
+ release
83
+ context
84
+ agent-readiness
85
+ ```
86
+
87
+ `workflow verify` aggregates safe local evidence. It does not publish, release, run destructive commands or invent pass/fail claims for checks that were not recorded.
88
+
89
+ `workflow evidence <id>` writes a Markdown evidence pack under `.soturail/reports/`.
90
+
91
+ ## Verification And Evidence
92
+
93
+ Verification connects:
94
+
95
+ - harness contract status;
96
+ - policy queue and decision status;
97
+ - evidence completeness;
98
+ - Diagram Rail validation status;
99
+ - evaluation report status;
100
+ - release notes path when package metadata is present.
101
+
102
+ Evidence packs include:
103
+
104
+ - workflow metadata and state;
105
+ - plan, task, review and verify paths;
106
+ - run workspace pointers where available;
107
+ - command raw IDs and offload IDs;
108
+ - changed files and filesystem evidence pointers;
109
+ - policy decisions;
110
+ - harness failures and contract status;
111
+ - diagram validation result;
112
+ - evaluation report result;
113
+ - release notes path under `docs/releases/`;
114
+ - release gates and publish checklist notes.
115
+
116
+ SotuRail does not claim build, test, audit, npm pack, publish or GitHub release success unless those results exist as local evidence.
117
+
42
118
  ## Worktrees
43
119
 
44
120
  `soturail workflow start <id> --worktree --dry-run` prints a local worktree plan. If run without `--dry-run` inside a Git repository, SotuRail may create a local worktree under `.soturail/worktrees/<id>/`.
@@ -50,10 +126,18 @@ Safety rules:
50
126
  - SotuRail does not delete user work without explicit confirmation.
51
127
  - Rollback instructions are printed when worktrees are planned.
52
128
 
53
- ## Verification
129
+ ## Diagram Integration
130
+
131
+ Diagram Rail adds visual contracts to Workflow Rail:
132
+
133
+ ```bash
134
+ soturail workflow diagram <id>
135
+ soturail diagram from-workflow <id>
136
+ soturail diagram validate
137
+ ```
54
138
 
55
- `soturail workflow verify <id>` only runs configured safe checks when they are explicit. Without configured checks, it prints a checklist instead of inventing commands.
139
+ Generated workflow diagrams live under `docs/diagrams/` and have matching `.spec.md` visual contracts. They make state transitions explicit; they do not replace tests or review.
56
140
 
57
- ## Cleanup
141
+ ## Future Directions
58
142
 
59
- `soturail workflow cleanup --closed --dry-run` previews closed workflow records that could be removed. It does not delete anything unless rerun with `--closed --yes` after review.
143
+ Future Workflow Rail work can add richer trace/report commands, deeper task generation, issue integration and release-specific templates. The boundary stays the same: SotuRail prepares local context, evidence and safety rails, while the agent host owns the editing runtime.
@@ -4,8 +4,21 @@ These examples show how to use SotuRail exports without modifying global agent c
4
4
 
5
5
  ```bash
6
6
  soturail agents doctor
7
+ soturail agents doctor --verbose
8
+ soturail agents capabilities
9
+ soturail agents status
7
10
  soturail agents export --agent all
11
+ soturail agents install --agent claude --dry-run
12
+ soturail agents install --agent cursor --dry-run
13
+ soturail agents install --agent gemini --dry-run
8
14
  soturail mcp config --agent generic
9
15
  ```
10
16
 
11
17
  Review generated files under `.soturail/exports/agents/` before enabling them in any agent host.
18
+
19
+ Deep Agents-style exports are context/config artifacts only:
20
+
21
+ ```bash
22
+ soturail agents export --agent deepagents
23
+ soturail agents export --agent deepagents-js
24
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "soturail",
3
- "version": "0.4.1",
3
+ "version": "0.7.0",
4
4
  "description": "Local-first context rails for AI coding agents: reversible terminal compression, progressive repo reading, SDD workflows, hooks, benchmarks, memory and cache-friendly payloads.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -55,7 +55,7 @@
55
55
  "soturail"
56
56
  ],
57
57
  "author": "Rafael Ryan Ramos de Souza",
58
- "license": "MIT",
58
+ "license": "UNLICENSED",
59
59
  "repository": {
60
60
  "type": "git",
61
61
  "url": "git+https://github.com/Soturine/soturail.git"