soturail 0.3.3 → 0.4.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 (73) hide show
  1. package/README.md +57 -7
  2. package/dist/cli.js +4 -0
  3. package/dist/cli.js.map +1 -1
  4. package/dist/commands/agents.d.ts +2 -0
  5. package/dist/commands/agents.js +41 -0
  6. package/dist/commands/agents.js.map +1 -0
  7. package/dist/commands/bench.d.ts +1 -1
  8. package/dist/commands/bench.js +53 -4
  9. package/dist/commands/bench.js.map +1 -1
  10. package/dist/commands/context.js +11 -5
  11. package/dist/commands/context.js.map +1 -1
  12. package/dist/commands/doctor.js +7 -0
  13. package/dist/commands/doctor.js.map +1 -1
  14. package/dist/commands/hooks.d.ts +4 -2
  15. package/dist/commands/hooks.js +15 -10
  16. package/dist/commands/hooks.js.map +1 -1
  17. package/dist/commands/mcp.js +28 -1
  18. package/dist/commands/mcp.js.map +1 -1
  19. package/dist/commands/release.js +5 -3
  20. package/dist/commands/release.js.map +1 -1
  21. package/dist/commands/workflow.d.ts +2 -0
  22. package/dist/commands/workflow.js +40 -0
  23. package/dist/commands/workflow.js.map +1 -0
  24. package/dist/core/agent-exporter.d.ts +15 -0
  25. package/dist/core/agent-exporter.js +257 -0
  26. package/dist/core/agent-exporter.js.map +1 -0
  27. package/dist/core/agent-profile.d.ts +25 -0
  28. package/dist/core/agent-profile.js +2 -0
  29. package/dist/core/agent-profile.js.map +1 -0
  30. package/dist/core/agent-registry.d.ts +6 -0
  31. package/dist/core/agent-registry.js +109 -0
  32. package/dist/core/agent-registry.js.map +1 -0
  33. package/dist/core/config.d.ts +4 -0
  34. package/dist/core/config.js +10 -2
  35. package/dist/core/config.js.map +1 -1
  36. package/dist/core/context-pack.d.ts +3 -1
  37. package/dist/core/context-pack.js +23 -2
  38. package/dist/core/context-pack.js.map +1 -1
  39. package/dist/core/mcp-resources.js +9 -1
  40. package/dist/core/mcp-resources.js.map +1 -1
  41. package/dist/core/mcp-server.d.ts +4 -0
  42. package/dist/core/mcp-server.js +26 -0
  43. package/dist/core/mcp-server.js.map +1 -1
  44. package/dist/core/version.d.ts +1 -1
  45. package/dist/core/version.js +1 -1
  46. package/dist/core/workflow-store.d.ts +24 -0
  47. package/dist/core/workflow-store.js +188 -0
  48. package/dist/core/workflow-store.js.map +1 -0
  49. package/dist/core/worktree-manager.d.ts +10 -0
  50. package/dist/core/worktree-manager.js +55 -0
  51. package/dist/core/worktree-manager.js.map +1 -0
  52. package/docs/agents.md +33 -0
  53. package/docs/benchmarking.md +4 -3
  54. package/docs/comparisons.md +4 -2
  55. package/docs/context-packs.md +6 -1
  56. package/docs/hooks.md +5 -2
  57. package/docs/mcp.md +16 -0
  58. package/docs/metrics.md +2 -1
  59. package/docs/release-workflow.md +2 -0
  60. package/docs/security-model.md +6 -2
  61. package/docs/usage.md +17 -0
  62. package/docs/windows.md +27 -1
  63. package/docs/workflow-rail.md +43 -21
  64. package/examples/agents/README.md +11 -0
  65. package/examples/agents/antigravity.md +8 -0
  66. package/examples/agents/claude.md +9 -0
  67. package/examples/agents/codex.md +8 -0
  68. package/examples/agents/cursor.md +8 -0
  69. package/examples/agents/gemini.md +8 -0
  70. package/examples/workflows/README.md +13 -0
  71. package/examples/workflows/bugfix-workflow.md +11 -0
  72. package/examples/workflows/release-workflow.md +9 -0
  73. package/package.json +1 -1
@@ -0,0 +1,8 @@
1
+ # Codex Example
2
+
3
+ ```bash
4
+ soturail agents export --agent codex
5
+ soturail context pack --target codex
6
+ ```
7
+
8
+ Use the generated `AGENTS.md` and context pack as project-local guidance. Do not route `git push` through `soturail run`.
@@ -0,0 +1,8 @@
1
+ # Cursor Example
2
+
3
+ ```bash
4
+ soturail agents export --agent cursor
5
+ soturail agents install --agent cursor --mode rules --dry-run
6
+ ```
7
+
8
+ Cursor rule exports are project-local and should be reviewed before writing to `.cursor/rules/`.
@@ -0,0 +1,8 @@
1
+ # Gemini Example
2
+
3
+ ```bash
4
+ soturail agents export --agent gemini
5
+ soturail context pack --target gemini
6
+ ```
7
+
8
+ Review `GEMINI.md` before adding it to a repository.
@@ -0,0 +1,13 @@
1
+ # Workflow Examples
2
+
3
+ Workflow Rail stores local task state under `.soturail/workflows/`.
4
+
5
+ ```bash
6
+ soturail workflow new "Fix bug"
7
+ soturail workflow list
8
+ soturail workflow plan <id>
9
+ soturail workflow start <id> --worktree --dry-run
10
+ soturail workflow verify <id>
11
+ ```
12
+
13
+ SotuRail does not push, merge or delete worktrees automatically.
@@ -0,0 +1,11 @@
1
+ # Bugfix Workflow
2
+
3
+ ```bash
4
+ soturail workflow new "Fix parser bug"
5
+ soturail workflow plan <id>
6
+ soturail context pack --target codex
7
+ soturail run npm test
8
+ soturail workflow verify <id>
9
+ ```
10
+
11
+ Keep evidence local and include raw IDs in the final review notes when useful.
@@ -0,0 +1,9 @@
1
+ # Release Workflow
2
+
3
+ ```bash
4
+ soturail self all
5
+ soturail release check
6
+ npm pack --dry-run
7
+ ```
8
+
9
+ Only create a GitHub release after npm publish succeeds and the published CLI version is verified.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "soturail",
3
- "version": "0.3.3",
3
+ "version": "0.4.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": {