@sanity/workflow-cli 0.20.0 → 0.22.0

package/oclif.manifest.json

@@ -18,7 +18,7 @@
       ],
       "flags": {
         "deployment": {
-          "description": "Deployment name — read the instance from the resource that deployment targets; the tag partition still comes from the loaded instance.",
+          "description": "Deployment name — narrow the instance search to the resource that deployment targets; the tag partition still comes from the loaded instance.",
           "exclusive": [
             "tag"
           ],
@@ -28,7 +28,7 @@
           "type": "option"
         },
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "exclusive": [
             "deployment"
           ],
@@ -165,7 +165,7 @@
       ],
       "flags": {
         "deployment": {
-          "description": "Deployment name — read the instance from the resource that deployment targets; the tag partition still comes from the loaded instance.",
+          "description": "Deployment name — narrow the instance search to the resource that deployment targets; the tag partition still comes from the loaded instance.",
           "exclusive": [
             "tag"
           ],
@@ -175,7 +175,7 @@
           "type": "option"
         },
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "exclusive": [
             "deployment"
           ],
@@ -225,7 +225,7 @@
       ],
       "flags": {
         "deployment": {
-          "description": "Deployment name — read the instance from the resource that deployment targets; the tag partition still comes from the loaded instance.",
+          "description": "Deployment name — narrow the instance search to the resource that deployment targets; the tag partition still comes from the loaded instance.",
           "exclusive": [
             "tag"
           ],
@@ -235,7 +235,7 @@
           "type": "option"
         },
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "exclusive": [
             "deployment"
           ],
@@ -299,11 +299,12 @@
         "<%= 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 --tag prod",
+        "<%= config.bin %> list --json"
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -342,6 +343,12 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "json": {
+          "description": "Emit structured JSON instead of rendered output.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -408,7 +415,9 @@
       ]
     },
     "editorial-workflows:reset-activity": {
-      "aliases": [],
+      "aliases": [
+        "reset-activity"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -421,13 +430,41 @@
           "required": true
         }
       },
-      "description": "Reset a failed activity on an in-flight instance — back to pending (re-run) or to skipped (bypass).",
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hidden": true,
-      "hiddenAliases": [
-        "reset-activity"
+      "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"
       ],
+      "flags": {
+        "deployment": {
+          "description": "Deployment name — narrow the instance search to the resource that deployment targets; the tag partition still comes from the loaded instance.",
+          "exclusive": [
+            "tag"
+          ],
+          "name": "deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
+          "exclusive": [
+            "deployment"
+          ],
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "skip": {
+          "description": "Bypass the activity (mark it skipped) instead of re-running it (back to active).",
+          "name": "skip",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "editorial-workflows:reset-activity",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
@@ -459,7 +496,7 @@
       ],
       "flags": {
         "deployment": {
-          "description": "Deployment name — read the instance from the resource that deployment targets; the tag partition still comes from the loaded instance.",
+          "description": "Deployment name — narrow the instance search to the resource that deployment targets; the tag partition still comes from the loaded instance.",
           "exclusive": [
             "tag"
           ],
@@ -469,7 +506,7 @@
           "type": "option"
         },
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "exclusive": [
             "deployment"
           ],
@@ -523,18 +560,19 @@
       "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 --include history",
+        "<%= config.bin %> show wf-instance.abc123 --json"
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "include": {
-          "description": "Optional sections to include in output.",
+          "description": "Optional sections to include in rendered output (--json always carries the full document).",
           "name": "include",
           "default": [],
           "hasDynamicHelp": false,
@@ -543,6 +581,12 @@
             "history"
           ],
           "type": "option"
+        },
+        "json": {
+          "description": "Emit structured JSON instead of rendered output.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -660,7 +704,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -826,11 +870,12 @@
       "description": "List deployed workflow definitions.",
       "examples": [
         "<%= config.bin %> definition list",
-        "<%= config.bin %> definition list --tag prod"
+        "<%= config.bin %> definition list --tag prod",
+        "<%= config.bin %> definition list --json"
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -850,6 +895,12 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "json": {
+          "description": "Emit structured JSON instead of rendered output.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -882,7 +933,7 @@
       "description": "Show a deployed workflow definition.",
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter that also narrows which resources are searched; omit to span them all.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -894,6 +945,12 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "json": {
+          "description": "Emit structured JSON instead of rendered output.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -913,5 +970,5 @@
       ]
     }
   },
-  "version": "0.20.0"
+  "version": "0.22.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.20.0",
+  "version": "0.22.0",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -62,17 +62,18 @@
     "@types/node": "^24.12.4",
     "oclif": "^4.23.16",
     "vitest": "^4.1.8",
-    "@sanity/workflow-engine": "0.20.0",
-    "@sanity/workflow-engine-test": "0.20.0",
-    "@sanity/workflow-examples": "0.9.0"
+    "@sanity/workflow-engine": "0.22.0",
+    "@sanity/workflow-engine-test": "0.22.0",
+    "@sanity/workflow-examples": "0.10.1"
   },
   "peerDependencies": {
-    "@sanity/workflow-engine": "0.20.0"
+    "@sanity/workflow-engine": "0.22.0"
   },
   "oclif": {
     "bin": "sanity-workflows",
     "commands": "./dist/commands",
     "dirname": "sanity-workflows",
+    "helpClass": "./dist/help",
     "hooks": {
       "finally": "./dist/hooks/finally/telemetry",
       "prerun": "./dist/hooks/prerun/telemetry"