@sanity/workflow-cli 0.13.0 → 0.20.0

package/oclif.manifest.json

@@ -17,8 +17,21 @@
         "<%= config.bin %> abort wf-instance.abc123 --reason 'superseded by relaunch'"
       ],
       "flags": {
+        "deployment": {
+          "description": "Deployment name — read the instance from 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) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "exclusive": [
+            "deployment"
+          ],
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -54,6 +67,7 @@
       "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",
@@ -61,17 +75,31 @@
         "<%= config.bin %> deploy --only productLaunch"
       ],
       "flags": {
+        "deployment": {
+          "description": "Deployment name — the unique identity of one deployment in the config.",
+          "exclusive": [
+            "tag"
+          ],
+          "name": "deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — deploys every deployment carrying the tag (a tag is an environment group).",
+          "exclusive": [
+            "deployment"
+          ],
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "all-tags": {
-          "description": "Deploy every deployment in the config, not just one tag.",
+          "description": "Deploy every deployment in the config, not just a selection.",
           "exclusive": [
-            "tag"
+            "tag",
+            "deployment"
           ],
           "name": "all-tags",
           "allowNo": false,
@@ -136,8 +164,21 @@
         "<%= config.bin %> diagnose wf-instance.abc123 --json"
       ],
       "flags": {
+        "deployment": {
+          "description": "Deployment name — read the instance from 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) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "exclusive": [
+            "deployment"
+          ],
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -183,8 +224,21 @@
         "<%= config.bin %> fire-action wf-instance.abc123 --activity publish --action publish --param note=shipping"
       ],
       "flags": {
+        "deployment": {
+          "description": "Deployment name — read the instance from 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) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "exclusive": [
+            "deployment"
+          ],
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -249,7 +303,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -312,14 +366,20 @@
       "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). Content documents are never touched. Prints a dry-run plan, then requires you to type back every involved dataset (--force skips the prompt; the plan still prints).",
       "examples": [
-        "<%= config.bin %> nuke --tag plugin-dev",
+        "<%= config.bin %> nuke --deployment plugin-dev",
         "<%= config.bin %> nuke --tag plugin-dev --force"
       ],
       "flags": {
+        "deployment": {
+          "description": "The deployment name to reset.",
+          "name": "deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "tag": {
-          "description": "The deployment tag to reset. Required — a destructive reset never guesses the environment.",
+          "description": "The deployment tag to reset (while it names exactly one deployment).",
           "name": "tag",
-          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -398,8 +458,21 @@
         "<%= config.bin %> set-stage wf-instance.abc123 --to ready --reason 'unblock for demo'"
       ],
       "flags": {
+        "deployment": {
+          "description": "Deployment name — read the instance from 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) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
+          "exclusive": [
+            "deployment"
+          ],
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -454,7 +527,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -506,8 +579,21 @@
         "<%= config.bin %> start productLaunch --instance-id prod.wf-instance.a1b2c3d4e5f6"
       ],
       "flags": {
+        "deployment": {
+          "description": "Deployment name — the unique identity of one deployment in the config.",
+          "exclusive": [
+            "tag"
+          ],
+          "name": "deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — selects the deployment to act on while the tag names exactly one; pass --deployment when it spans several.",
+          "exclusive": [
+            "deployment"
+          ],
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -574,7 +660,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -614,8 +700,21 @@
         "<%= config.bin %> definition delete my-workflow --cascade --reason 'workflow retired'"
       ],
       "flags": {
+        "deployment": {
+          "description": "Deployment name — the unique identity of one deployment in the config.",
+          "exclusive": [
+            "tag"
+          ],
+          "name": "deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — selects the deployment to act on while the tag names exactly one; pass --deployment when it spans several.",
+          "exclusive": [
+            "deployment"
+          ],
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -675,8 +774,21 @@
         "<%= config.bin %> definition diff productLaunch --version 2"
       ],
       "flags": {
+        "deployment": {
+          "description": "Deployment name — the unique identity of one deployment in the config.",
+          "exclusive": [
+            "tag"
+          ],
+          "name": "deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — selects the deployment to act on while the tag names exactly one; pass --deployment when it spans several.",
+          "exclusive": [
+            "deployment"
+          ],
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -718,7 +830,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -770,7 +882,7 @@
       "description": "Show a deployed workflow definition.",
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "description": "Workflow environment tag (e.g. prod, test) — an optional query filter, and the resource disambiguator when the config spans several.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -801,5 +913,5 @@
       ]
     }
   },
-  "version": "0.13.0"
+  "version": "0.20.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.13.0",
+  "version": "0.20.0",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -55,16 +55,19 @@
     "diff": "^9.0.0",
     "jiti": "^2.7.0",
     "log-symbols": "^7.0.1",
-    "ora": "^9.4.0",
-    "@sanity/workflow-engine": "0.18.0"
+    "ora": "^9.4.0"
   },
   "devDependencies": {
     "@types/diff": "^8.0.0",
     "@types/node": "^24.12.4",
     "oclif": "^4.23.16",
     "vitest": "^4.1.8",
-    "@sanity/workflow-engine-test": "0.13.0",
-    "@sanity/workflow-examples": "0.8.0"
+    "@sanity/workflow-engine": "0.20.0",
+    "@sanity/workflow-engine-test": "0.20.0",
+    "@sanity/workflow-examples": "0.9.0"
+  },
+  "peerDependencies": {
+    "@sanity/workflow-engine": "0.20.0"
   },
   "oclif": {
     "bin": "sanity-workflows",