@sanity/workflow-cli 0.11.0 → 0.13.0

package/oclif.manifest.json

@@ -1,7 +1,9 @@
 {
   "commands": {
-    "abort": {
-      "aliases": [],
+    "editorial-workflows:abort": {
+      "aliases": [
+        "abort"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -9,7 +11,7 @@
           "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'"
@@ -32,7 +34,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "abort",
+      "id": "editorial-workflows:abort",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -41,11 +43,14 @@
       "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": [
@@ -92,7 +97,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 +105,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "deploy",
+      "id": "editorial-workflows:deploy",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -109,11 +114,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "deploy.js"
       ]
     },
-    "diagnose": {
-      "aliases": [],
+    "editorial-workflows:diagnose": {
+      "aliases": [
+        "diagnose"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -144,7 +152,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "diagnose",
+      "id": "editorial-workflows:diagnose",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -153,11 +161,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "diagnose.js"
       ]
     },
-    "fire-action": {
-      "aliases": [],
+    "editorial-workflows:fire-action": {
+      "aliases": [
+        "fire-action"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id.",
@@ -210,7 +221,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "fire-action",
+      "id": "editorial-workflows:fire-action",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -219,11 +230,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": [
@@ -278,7 +292,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "list",
+      "id": "editorial-workflows:list",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -287,10 +301,53 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "list.js"
       ]
     },
-    "reset-activity": {
+    "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 --tag plugin-dev --force"
+      ],
+      "flags": {
+        "tag": {
+          "description": "The deployment tag to reset. Required — a destructive reset never guesses the environment.",
+          "name": "tag",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "description": "Skip the confirmation prompt (for scripts/CI). The plan still prints.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "editorial-workflows:nuke",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Delete every engine-owned document for a deployment tag — the dev-period big red button.",
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "editorial-workflows",
+        "nuke.js"
+      ]
+    },
+    "editorial-workflows:reset-activity": {
       "aliases": [],
       "args": {
         "instanceId": {
@@ -308,8 +365,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",
@@ -318,11 +377,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.",
@@ -361,7 +423,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "set-stage",
+      "id": "editorial-workflows:set-stage",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -370,11 +432,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "set-stage.js"
       ]
     },
-    "show": {
-      "aliases": [],
+    "editorial-workflows:show": {
+      "aliases": [
+        "show"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance document id.",
@@ -409,7 +474,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "show",
+      "id": "editorial-workflows:show",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -418,11 +483,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "show.js"
       ]
     },
-    "start": {
-      "aliases": [],
+    "editorial-workflows:start": {
+      "aliases": [
+        "start"
+      ],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -434,7 +502,8 @@
       "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 --version 2 --tag prod",
+        "<%= config.bin %> start productLaunch --instance-id prod.wf-instance.a1b2c3d4e5f6"
       ],
       "flags": {
         "tag": {
@@ -459,6 +528,13 @@
           "multiple": true,
           "type": "option"
         },
+        "instance-id": {
+          "description": "Start under this instance id — for retries. The id is the start's idempotency key: pass the id of a start that failed partway and the engine resumes it instead of creating a duplicate (an already-settled start replays as a no-op). Omit to mint a fresh id.",
+          "name": "instance-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "json": {
           "description": "Emit structured JSON instead of rendered output.",
           "name": "json",
@@ -468,7 +544,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "start",
+      "id": "editorial-workflows:start",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -477,11 +553,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "start.js"
       ]
     },
-    "tail": {
-      "aliases": [],
+    "editorial-workflows:tail": {
+      "aliases": [
+        "tail"
+      ],
       "args": {
         "instanceId": {
           "description": "Workflow instance id to tail.",
@@ -504,7 +583,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "tail",
+      "id": "editorial-workflows:tail",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -513,11 +592,14 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "tail.js"
       ]
     },
-    "definition:delete": {
-      "aliases": [],
+    "editorial-workflows:definition:delete": {
+      "aliases": [
+        "definition:delete"
+      ],
       "args": {
         "name": {
           "description": "Workflow definition name.",
@@ -562,7 +644,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "definition:delete",
+      "id": "editorial-workflows:definition:delete",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -571,12 +653,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.",
@@ -607,7 +692,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "definition:diff",
+      "id": "editorial-workflows:definition:diff",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -616,12 +701,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": [
@@ -654,7 +742,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "definition:list",
+      "id": "editorial-workflows:definition:list",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -663,12 +751,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.",
@@ -695,7 +786,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "definition:show",
+      "id": "editorial-workflows:definition:show",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -704,10 +795,11 @@
       "relativePath": [
         "dist",
         "commands",
+        "editorial-workflows",
         "definition",
         "show.js"
       ]
     }
   },
-  "version": "0.11.0"
+  "version": "0.13.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -56,15 +56,15 @@
     "jiti": "^2.7.0",
     "log-symbols": "^7.0.1",
     "ora": "^9.4.0",
-    "@sanity/workflow-engine": "0.16.0"
+    "@sanity/workflow-engine": "0.18.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.11.0",
-    "@sanity/workflow-examples": "0.6.0"
+    "@sanity/workflow-engine-test": "0.13.0",
+    "@sanity/workflow-examples": "0.8.0"
   },
   "oclif": {
     "bin": "sanity-workflows",
@@ -79,11 +79,13 @@
     ],
     "topicSeparator": " ",
     "topics": {
-      "definition": {
-        "description": "Read and manage workflow definitions"
-      },
-      "dev": {
-        "description": "Local scaffolding helpers"
+      "editorial-workflows": {
+        "description": "Editorial Workflows — deploy, inspect, and administer definitions and instances",
+        "subtopics": {
+          "definition": {
+            "description": "Read and manage workflow definitions"
+          }
+        }
       }
     }
   },