@sanity/workflow-cli 0.12.0 → 0.14.0

package/oclif.manifest.json

@@ -1,7 +1,9 @@
 {
   "commands": {
-    "abort": {
-      "aliases": [],
+    "editorial-workflows:abort": {
+      "aliases": [
+        "abort"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -9,14 +11,27 @@
           "required": true
         }
       },
-      "description": "Abort an in-flight workflow instance — a hard stop: pending effects are cancelled, stage guards lifted, and the instance is marked terminal where it stands.",
+      "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'"
       ],
       "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,
@@ -32,7 +47,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "abort",
+      "id": "editorial-workflows:abort",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -41,14 +56,18 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "abort.js"
       ]
     },
-    "deploy": {
-      "aliases": [],
+    "editorial-workflows:deploy": {
+      "aliases": [
+        "deploy"
+      ],
       "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",
@@ -56,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,
@@ -92,7 +125,7 @@
           "type": "option"
         },
         "share-defs": {
-          "description": "Share the definition documents newly created by this deploy with Sanity — the full document, verbatim (structure, names, filters, effect configuration, seeded values), plus its deployment coordinates (project and dataset, or resource id); never content documents, instances, or your Sanity auth token. Opt-out: an interactive terminal is asked once (the answer is remembered), while unattended runs (CI / non-TTY / DO_NOT_TRACK) share nothing unless --share-defs is passed. Use --no-share-defs to opt out. An explicit --share-defs also sends telemetry for this deploy regardless of CI / DO_NOT_TRACK.",
+          "description": "Share the definition documents newly created by this deploy with Sanity — the full document, verbatim (structure, names, filters, effect configuration, seeded values), plus its deployment coordinates (project and dataset, or resource id); never content documents, instances, or your Sanity auth token. Sharing is the default in every environment, including CI / non-TTY / DO_NOT_TRACK. Use --no-share-defs to opt out.",
           "name": "share-defs",
           "allowNo": true,
           "type": "boolean"
@@ -100,7 +133,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "deploy",
+      "id": "editorial-workflows:deploy",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -109,11 +142,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "deploy.js"
       ]
     },
-    "diagnose": {
-      "aliases": [],
+    "editorial-workflows:diagnose": {
+      "aliases": [
+        "diagnose"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -128,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,
@@ -144,7 +193,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "diagnose",
+      "id": "editorial-workflows:diagnose",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -153,11 +202,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "diagnose.js"
       ]
     },
-    "fire-action": {
-      "aliases": [],
+    "editorial-workflows:fire-action": {
+      "aliases": [
+        "fire-action"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -172,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,
@@ -210,7 +275,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "fire-action",
+      "id": "editorial-workflows:fire-action",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -219,11 +284,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "fire-action.js"
       ]
     },
-    "list": {
-      "aliases": [],
+    "editorial-workflows:list": {
+      "aliases": [
+        "list"
+      ],
       "args": {},
       "description": "List workflow instances in the configured dataset (in-flight by default).",
       "examples": [
@@ -235,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,
@@ -278,7 +346,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "list",
+      "id": "editorial-workflows:list",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -287,22 +355,31 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "list.js"
       ]
     },
-    "nuke": {
-      "aliases": [],
+    "editorial-workflows:nuke": {
+      "aliases": [
+        "nuke"
+      ],
       "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"
@@ -316,7 +393,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "nuke",
+      "id": "editorial-workflows:nuke",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -326,10 +403,11 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "nuke.js"
       ]
     },
-    "reset-activity": {
+    "editorial-workflows:reset-activity": {
       "aliases": [],
       "args": {
         "instanceId": {
@@ -347,8 +425,10 @@
       "flags": {},
       "hasDynamicHelp": false,
       "hidden": true,
-      "hiddenAliases": [],
-      "id": "reset-activity",
+      "hiddenAliases": [
+        "reset-activity"
+      ],
+      "id": "editorial-workflows:reset-activity",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -357,11 +437,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "reset-activity.js"
       ]
     },
-    "set-stage": {
-      "aliases": [],
+    "editorial-workflows:set-stage": {
+      "aliases": [
+        "set-stage"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id to move.",
@@ -375,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,
@@ -400,7 +496,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "set-stage",
+      "id": "editorial-workflows:set-stage",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -409,11 +505,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "set-stage.js"
       ]
     },
-    "show": {
-      "aliases": [],
+    "editorial-workflows:show": {
+      "aliases": [
+        "show"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance document id.",
@@ -428,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,
@@ -448,7 +547,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "show",
+      "id": "editorial-workflows:show",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -457,11 +556,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "show.js"
       ]
     },
-    "start": {
-      "aliases": [],
+    "editorial-workflows:start": {
+      "aliases": [
+        "start"
+      ],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -477,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,
@@ -515,7 +630,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "start",
+      "id": "editorial-workflows:start",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -524,11 +639,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "start.js"
       ]
     },
-    "tail": {
-      "aliases": [],
+    "editorial-workflows:tail": {
+      "aliases": [
+        "tail"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id to tail.",
@@ -542,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,
@@ -551,7 +669,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "tail",
+      "id": "editorial-workflows:tail",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -560,11 +678,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "tail.js"
       ]
     },
-    "definition:delete": {
-      "aliases": [],
+    "editorial-workflows:definition:delete": {
+      "aliases": [
+        "definition:delete"
+      ],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -579,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,
@@ -609,7 +743,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "definition:delete",
+      "id": "editorial-workflows:definition:delete",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -618,12 +752,15 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "definition",
         "delete.js"
       ]
     },
-    "definition:diff": {
-      "aliases": [],
+    "editorial-workflows:definition:diff": {
+      "aliases": [
+        "definition:diff"
+      ],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -637,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,
@@ -654,7 +804,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "definition:diff",
+      "id": "editorial-workflows:definition:diff",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -663,12 +813,15 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "definition",
         "diff.js"
       ]
     },
-    "definition:list": {
-      "aliases": [],
+    "editorial-workflows:definition:list": {
+      "aliases": [
+        "definition:list"
+      ],
       "args": {},
       "description": "List deployed workflow definitions.",
       "examples": [
@@ -677,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,
@@ -701,7 +854,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "definition:list",
+      "id": "editorial-workflows:definition:list",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -710,12 +863,15 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "definition",
         "list.js"
       ]
     },
-    "definition:show": {
-      "aliases": [],
+    "editorial-workflows:definition:show": {
+      "aliases": [
+        "definition:show"
+      ],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -726,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,
@@ -742,7 +898,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "definition:show",
+      "id": "editorial-workflows:definition:show",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -751,10 +907,11 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "definition",
         "show.js"
       ]
     }
   },
-  "version": "0.12.0"
+  "version": "0.14.0"
 }