@sanity/workflow-cli 0.27.0 → 0.28.0

package/oclif.manifest.json

@@ -1,9 +1,7 @@
 {
   "commands": {
-    "editorial-workflows:abort": {
-      "aliases": [
-        "abort"
-      ],
+    "workflows:abort": {
+      "aliases": [],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -13,8 +11,8 @@
       },
       "description": "Abort an in-flight workflow instance — a hard stop: pending effects are cancelled, stage guards removed, and the instance is marked terminal where it stands.",
       "examples": [
-        "<%= config.bin %> abort wf-instance.abc123",
-        "<%= config.bin %> abort wf-instance.abc123 --reason 'superseded by relaunch'"
+        "<%= config.bin %> workflows abort wf-instance.abc123",
+        "<%= config.bin %> workflows abort wf-instance.abc123 --reason 'superseded by relaunch'"
       ],
       "flags": {
         "deployment": {
@@ -47,7 +45,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:abort",
+      "id": "workflows:abort",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -56,23 +54,21 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "abort.js"
       ]
     },
-    "editorial-workflows:deploy": {
-      "aliases": [
-        "deploy"
-      ],
+    "workflows:deploy": {
+      "aliases": [],
       "args": {},
       "description": "Validate, diff, and deploy workflow definitions to the resource bound by the selected deployment.",
       "examples": [
-        "<%= config.bin %> deploy --deployment review-prod",
-        "<%= config.bin %> deploy --tag prod",
-        "<%= config.bin %> deploy --all-tags",
-        "<%= config.bin %> deploy --check",
-        "<%= config.bin %> deploy --dry-run",
-        "<%= config.bin %> deploy --only productLaunch"
+        "<%= config.bin %> workflows deploy --deployment review-prod",
+        "<%= config.bin %> workflows deploy --tag prod",
+        "<%= config.bin %> workflows deploy --all-tags",
+        "<%= config.bin %> workflows deploy --check",
+        "<%= config.bin %> workflows deploy --dry-run",
+        "<%= config.bin %> workflows deploy --only productLaunch"
       ],
       "flags": {
         "deployment": {
@@ -133,7 +129,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:deploy",
+      "id": "workflows:deploy",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -142,14 +138,12 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "deploy.js"
       ]
     },
-    "editorial-workflows:diagnose": {
-      "aliases": [
-        "diagnose"
-      ],
+    "workflows:diagnose": {
+      "aliases": [],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -159,9 +153,9 @@
       },
       "description": "Explain why a workflow instance is or isn't progressing, and what would unstick it.",
       "examples": [
-        "<%= config.bin %> diagnose wf-instance.abc123",
-        "<%= config.bin %> diagnose wf-instance.abc123 --tag prod",
-        "<%= config.bin %> diagnose wf-instance.abc123 --json"
+        "<%= config.bin %> workflows diagnose wf-instance.abc123",
+        "<%= config.bin %> workflows diagnose wf-instance.abc123 --tag prod",
+        "<%= config.bin %> workflows diagnose wf-instance.abc123 --json"
       ],
       "flags": {
         "deployment": {
@@ -193,7 +187,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:diagnose",
+      "id": "workflows:diagnose",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -202,14 +196,12 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "diagnose.js"
       ]
     },
-    "editorial-workflows:fire-action": {
-      "aliases": [
-        "fire-action"
-      ],
+    "workflows:fire-action": {
+      "aliases": [],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -219,9 +211,9 @@
       },
       "description": "Fire an action on an instance to unstick a waiting activity — the write acts as the configured token. Omit --action to list what can be fired.",
       "examples": [
-        "<%= config.bin %> fire-action wf-instance.abc123",
-        "<%= config.bin %> fire-action wf-instance.abc123 --activity approve --action approve",
-        "<%= config.bin %> fire-action wf-instance.abc123 --activity publish --action publish --param note=shipping"
+        "<%= config.bin %> workflows fire-action wf-instance.abc123",
+        "<%= config.bin %> workflows fire-action wf-instance.abc123 --activity approve --action approve",
+        "<%= config.bin %> workflows fire-action wf-instance.abc123 --activity publish --action publish --param note=shipping"
       ],
       "flags": {
         "deployment": {
@@ -275,7 +267,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:fire-action",
+      "id": "workflows:fire-action",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -284,23 +276,21 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "fire-action.js"
       ]
     },
-    "editorial-workflows:list": {
-      "aliases": [
-        "list"
-      ],
+    "workflows:list": {
+      "aliases": [],
       "args": {},
       "description": "List workflow instances in the configured dataset (in-flight by default).",
       "examples": [
-        "<%= config.bin %> list",
-        "<%= config.bin %> list --include-completed",
-        "<%= config.bin %> list --definition productLaunch",
-        "<%= config.bin %> list --document dataset:proj:ds:article-1",
-        "<%= config.bin %> list --tag prod",
-        "<%= config.bin %> list --json"
+        "<%= config.bin %> workflows list",
+        "<%= config.bin %> workflows list --include-completed",
+        "<%= config.bin %> workflows list --definition productLaunch",
+        "<%= config.bin %> workflows list --document dataset:proj:ds:article-1",
+        "<%= config.bin %> workflows list --tag prod",
+        "<%= config.bin %> workflows list --json"
       ],
       "flags": {
         "tag": {
@@ -353,7 +343,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:list",
+      "id": "workflows:list",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -362,20 +352,18 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "list.js"
       ]
     },
-    "editorial-workflows:nuke": {
-      "aliases": [
-        "nuke"
-      ],
+    "workflows:nuke": {
+      "aliases": [],
       "args": {},
       "description": "The reset for a dataset holding engine documents the versioned upgrade framework cannot yet migrate: deletes the tag's instances, definitions, and guards (across every alias-bound resource). --instance <id> instead deletes one terminal instance plus its guards. Content documents are never touched. Prints a dry-run plan, then confirms (--force skips the prompt; the plan still prints).",
       "examples": [
-        "<%= config.bin %> nuke --deployment plugin-dev",
-        "<%= config.bin %> nuke --tag plugin-dev --force",
-        "<%= config.bin %> nuke --instance plugin-dev.wf-instance.abc123"
+        "<%= config.bin %> workflows nuke --deployment plugin-dev",
+        "<%= config.bin %> workflows nuke --tag plugin-dev --force",
+        "<%= config.bin %> workflows nuke --instance plugin-dev.wf-instance.abc123"
       ],
       "flags": {
         "deployment": {
@@ -408,7 +396,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:nuke",
+      "id": "workflows:nuke",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -418,14 +406,12 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "nuke.js"
       ]
     },
-    "editorial-workflows:reset-activity": {
-      "aliases": [
-        "reset-activity"
-      ],
+    "workflows:reset-activity": {
+      "aliases": [],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -440,8 +426,8 @@
       },
       "description": "Reset a failed activity on an in-flight instance — back to active to re-run it, or --skip to bypass it (mark it skipped) so a gated exit transition can fire.",
       "examples": [
-        "<%= config.bin %> reset-activity wf-instance.abc123 legal-review",
-        "<%= config.bin %> reset-activity wf-instance.abc123 legal-review --skip"
+        "<%= config.bin %> workflows reset-activity wf-instance.abc123 legal-review",
+        "<%= config.bin %> workflows reset-activity wf-instance.abc123 legal-review --skip"
       ],
       "flags": {
         "deployment": {
@@ -473,7 +459,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:reset-activity",
+      "id": "workflows:reset-activity",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -482,14 +468,12 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "reset-activity.js"
       ]
     },
-    "editorial-workflows:set-stage": {
-      "aliases": [
-        "set-stage"
-      ],
+    "workflows:set-stage": {
+      "aliases": [],
       "args": {
         "instanceId": {
           "description": "Workflow instance id to move.",
@@ -499,9 +483,9 @@
       },
       "description": "Force an instance into a stage, regardless of its declared transitions and filters — the engine's setStage admin override. The target stage's enter lifecycle still runs (auto-activities start, stage guards reconcile), and the post-move cascade can immediately auto-transition the instance onward.",
       "examples": [
-        "<%= config.bin %> set-stage wf-instance.abc123 --to ready",
-        "<%= config.bin %> set-stage wf-instance.abc123",
-        "<%= config.bin %> set-stage wf-instance.abc123 --to ready --reason 'unblock for demo'"
+        "<%= config.bin %> workflows set-stage wf-instance.abc123 --to ready",
+        "<%= config.bin %> workflows set-stage wf-instance.abc123",
+        "<%= config.bin %> workflows set-stage wf-instance.abc123 --to ready --reason 'unblock for demo'"
       ],
       "flags": {
         "deployment": {
@@ -541,7 +525,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:set-stage",
+      "id": "workflows:set-stage",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -550,14 +534,12 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "set-stage.js"
       ]
     },
-    "editorial-workflows:show": {
-      "aliases": [
-        "show"
-      ],
+    "workflows:show": {
+      "aliases": [],
       "args": {
         "instanceId": {
           "description": "Workflow instance document id.",
@@ -567,9 +549,9 @@
       },
       "description": "Show the state, activities, and effects of a workflow instance.",
       "examples": [
-        "<%= config.bin %> show wf-instance.abc123",
-        "<%= config.bin %> show wf-instance.abc123 --include history",
-        "<%= config.bin %> show wf-instance.abc123 --json"
+        "<%= config.bin %> workflows show wf-instance.abc123",
+        "<%= config.bin %> workflows show wf-instance.abc123 --include history",
+        "<%= config.bin %> workflows show wf-instance.abc123 --json"
       ],
       "flags": {
         "tag": {
@@ -599,7 +581,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:show",
+      "id": "workflows:show",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -608,14 +590,12 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "show.js"
       ]
     },
-    "editorial-workflows:start": {
-      "aliases": [
-        "start"
-      ],
+    "workflows:start": {
+      "aliases": [],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -625,10 +605,10 @@
       },
       "description": "Start a workflow instance from a deployed definition. Supply values for the workflow's input-sourced fields with --field (e.g. the subject document ref).",
       "examples": [
-        "<%= config.bin %> start productLaunch",
-        "<%= config.bin %> start article-review --field subject='{\"id\":\"dataset:proj:ds:article-1\",\"type\":\"article\"}'",
-        "<%= config.bin %> start productLaunch --version 2 --tag prod",
-        "<%= config.bin %> start productLaunch --instance-id prod.wf-instance.a1b2c3d4e5f6"
+        "<%= config.bin %> workflows start productLaunch",
+        "<%= config.bin %> workflows start article-review --field subject='{\"id\":\"dataset:proj:ds:article-1\",\"type\":\"article\"}'",
+        "<%= config.bin %> workflows start productLaunch --version 2 --tag prod",
+        "<%= config.bin %> workflows start productLaunch --instance-id prod.wf-instance.a1b2c3d4e5f6"
       ],
       "flags": {
         "deployment": {
@@ -682,7 +662,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:start",
+      "id": "workflows:start",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -691,14 +671,12 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "start.js"
       ]
     },
-    "editorial-workflows:tail": {
-      "aliases": [
-        "tail"
-      ],
+    "workflows:tail": {
+      "aliases": [],
       "args": {
         "instanceId": {
           "description": "Workflow instance id to tail.",
@@ -708,7 +686,7 @@
       },
       "description": "Stream new history entries on a workflow instance as they land in the dataset.",
       "examples": [
-        "<%= config.bin %> tail wf-instance.abc123"
+        "<%= config.bin %> workflows tail wf-instance.abc123"
       ],
       "flags": {
         "tag": {
@@ -721,7 +699,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:tail",
+      "id": "workflows:tail",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -730,14 +708,12 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "tail.js"
       ]
     },
-    "editorial-workflows:definition:delete": {
-      "aliases": [
-        "definition:delete"
-      ],
+    "workflows:definition:delete": {
+      "aliases": [],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -747,9 +723,9 @@
       },
       "description": "Delete a deployed workflow definition (every version, or one via --version). Refuses while non-terminal instances exist unless --cascade aborts them first — instances are aborted in place, never deleted.",
       "examples": [
-        "<%= config.bin %> definition delete my-workflow",
-        "<%= config.bin %> definition delete my-workflow --version 2",
-        "<%= config.bin %> definition delete my-workflow --cascade --reason 'workflow retired'"
+        "<%= config.bin %> workflows definition delete my-workflow",
+        "<%= config.bin %> workflows definition delete my-workflow --version 2",
+        "<%= config.bin %> workflows definition delete my-workflow --cascade --reason 'workflow retired'"
       ],
       "flags": {
         "deployment": {
@@ -795,7 +771,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:definition:delete",
+      "id": "workflows:definition:delete",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -804,15 +780,13 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "definition",
         "delete.js"
       ]
     },
-    "editorial-workflows:definition:diff": {
-      "aliases": [
-        "definition:diff"
-      ],
+    "workflows:definition:diff": {
+      "aliases": [],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -822,8 +796,8 @@
       },
       "description": "Diff an in-code definition against the deployed version (latest by default).",
       "examples": [
-        "<%= config.bin %> definition diff productLaunch",
-        "<%= config.bin %> definition diff productLaunch --version 2"
+        "<%= config.bin %> workflows definition diff productLaunch",
+        "<%= config.bin %> workflows definition diff productLaunch --version 2"
       ],
       "flags": {
         "deployment": {
@@ -856,7 +830,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:definition:diff",
+      "id": "workflows:definition:diff",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -865,21 +839,19 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "definition",
         "diff.js"
       ]
     },
-    "editorial-workflows:definition:list": {
-      "aliases": [
-        "definition:list"
-      ],
+    "workflows:definition:list": {
+      "aliases": [],
       "args": {},
       "description": "List deployed workflow definitions.",
       "examples": [
-        "<%= config.bin %> definition list",
-        "<%= config.bin %> definition list --tag prod",
-        "<%= config.bin %> definition list --json"
+        "<%= config.bin %> workflows definition list",
+        "<%= config.bin %> workflows definition list --tag prod",
+        "<%= config.bin %> workflows definition list --json"
       ],
       "flags": {
         "tag": {
@@ -913,7 +885,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:definition:list",
+      "id": "workflows:definition:list",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -922,15 +894,13 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "definition",
         "list.js"
       ]
     },
-    "editorial-workflows:definition:show": {
-      "aliases": [
-        "definition:show"
-      ],
+    "workflows:definition:show": {
+      "aliases": [],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -963,7 +933,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "editorial-workflows:definition:show",
+      "id": "workflows:definition:show",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -972,11 +942,11 @@
       "relativePath": [
         "dist",
         "commands",
-        "editorial-workflows",
+        "workflows",
         "definition",
         "show.js"
       ]
     }
   },
-  "version": "0.27.0"
+  "version": "0.28.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -62,12 +62,12 @@
     "@types/node": "^24.12.4",
     "oclif": "^4.23.16",
     "vitest": "^4.1.8",
-    "@sanity/workflow-engine": "0.27.0",
-    "@sanity/workflow-engine-test": "0.27.0",
-    "@sanity/workflow-examples": "0.10.6"
+    "@sanity/workflow-engine": "0.28.0",
+    "@sanity/workflow-engine-test": "0.28.0",
+    "@sanity/workflow-examples": "0.10.7"
   },
   "peerDependencies": {
-    "@sanity/workflow-engine": "0.27.0"
+    "@sanity/workflow-engine": "0.28.0"
   },
   "oclif": {
     "bin": "sanity-workflows",
@@ -83,7 +83,7 @@
     ],
     "topicSeparator": " ",
     "topics": {
-      "editorial-workflows": {
+      "workflows": {
         "description": "Editorial Workflows — deploy, inspect, and administer definitions and instances",
         "subtopics": {
           "definition": {