@sanity/workflow-cli 0.8.1 → 0.10.0

package/oclif.manifest.json

@@ -16,7 +16,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -37,7 +37,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -48,21 +47,31 @@
     "deploy": {
       "aliases": [],
       "args": {},
-      "description": "Validate, diff, and deploy workflow definitions to the configured dataset.",
+      "description": "Validate, diff, and deploy workflow definitions to the resource bound by the selected deployment.",
       "examples": [
-        "<%= config.bin %> deploy",
+        "<%= config.bin %> deploy --tag prod",
+        "<%= config.bin %> deploy --all-tags",
         "<%= config.bin %> deploy --check",
         "<%= config.bin %> deploy --dry-run",
         "<%= config.bin %> deploy --only productLaunch"
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
+        "all-tags": {
+          "description": "Deploy every deployment in the config, not just one tag.",
+          "exclusive": [
+            "tag"
+          ],
+          "name": "all-tags",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "dry-run": {
           "description": "Validate + diff against the deployed version; do not write.",
           "name": "dry-run",
@@ -76,11 +85,17 @@
           "type": "boolean"
         },
         "only": {
-          "description": "Limit deploy/check/diff to a single workflow definition by name.",
+          "description": "Limit deploy/check/diff to a single workflow definition by name. Every targeted deployment must contain it.",
           "name": "only",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "share-definitions-with-sanity": {
+          "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-in for this invocation only; the CLI never prompts. Independent of telemetry consent.",
+          "name": "share-definitions-with-sanity",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -90,7 +105,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -115,14 +129,14 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "json": {
-          "description": "Emit the structured diagnosis as JSON instead of rendered output.",
+          "description": "Emit structured JSON instead of rendered output.",
           "name": "json",
           "allowNo": false,
           "type": "boolean"
@@ -135,7 +149,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -152,16 +165,15 @@
           "required": true
         }
       },
-      "description": "Fire an action on an instance — act on a user's behalf to unstick a waiting activity. Omit --action to list what can be fired.",
+      "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 approve --action approve --as user.xyz --as-role editor",
         "<%= config.bin %> fire-action wf-instance.abc123 --activity publish --action publish --param note=shipping"
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -189,21 +201,6 @@
           "multiple": true,
           "type": "option"
         },
-        "as": {
-          "description": "Attribute the fire to this Sanity user id (default: a workflow-cli system actor).",
-          "name": "as",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "as-role": {
-          "description": "Role to attribute to the --as user (repeatable), so role-gated filters pass.",
-          "name": "as-role",
-          "default": [],
-          "hasDynamicHelp": false,
-          "multiple": true,
-          "type": "option"
-        },
         "json": {
           "description": "Emit structured JSON instead of rendered output.",
           "name": "json",
@@ -218,7 +215,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -233,12 +229,12 @@
       "examples": [
         "<%= config.bin %> list",
         "<%= config.bin %> list --in-flight",
-        "<%= config.bin %> list --workflow-name productLaunch",
+        "<%= config.bin %> list --definition productLaunch",
         "<%= config.bin %> list --tag prod"
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -256,9 +252,9 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "workflow-name": {
-          "description": "Filter by workflow definition name.",
-          "name": "workflow-name",
+        "definition": {
+          "description": "Only instances of this workflow definition (its `name`; the instance's `definition` field).",
+          "name": "definition",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -279,7 +275,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -287,60 +282,7 @@
         "list.js"
       ]
     },
-    "move-stage": {
-      "aliases": [],
-      "args": {
-        "instanceId": {
-          "description": "Workflow instance id to move.",
-          "name": "instanceId",
-          "required": true
-        }
-      },
-      "description": "Move an instance to a new stage. Guards + transition effects run as if the transition fired normally.",
-      "examples": [
-        "<%= config.bin %> move-stage wf-instance.abc123 --to ready",
-        "<%= config.bin %> move-stage wf-instance.abc123 --to ready --reason 'unblock for demo'"
-      ],
-      "flags": {
-        "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
-          "name": "tag",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "to": {
-          "description": "Target stage name.",
-          "name": "to",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "reason": {
-          "description": "Free-text reason — recorded on the history entry for audit.",
-          "name": "reason",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "move-stage",
-      "pluginAlias": "@sanity/workflow-cli",
-      "pluginName": "@sanity/workflow-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "move-stage.js"
-      ]
-    },
-    "retry-activity": {
+    "reset-activity": {
       "aliases": [],
       "args": {
         "instanceId": {
@@ -354,12 +296,12 @@
           "required": true
         }
       },
-      "description": "Re-invoke a failed activity on an in-flight instance.",
+      "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": [],
-      "id": "retry-activity",
+      "id": "reset-activity",
       "pluginAlias": "@sanity/workflow-cli",
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
@@ -368,20 +310,31 @@
       "relativePath": [
         "dist",
         "commands",
-        "retry-activity.js"
+        "reset-activity.js"
       ]
     },
     "set-stage": {
       "aliases": [],
       "args": {
         "instanceId": {
-          "description": "Workflow instance id.",
+          "description": "Workflow instance id to move.",
           "name": "instanceId",
           "required": true
         }
       },
-      "description": "Force-set an instance's current stage, bypassing guards + effects (manual override).",
+      "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 --to ready --reason 'unblock for demo'"
+      ],
       "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "to": {
           "description": "Target stage name.",
           "name": "to",
@@ -391,7 +344,7 @@
           "type": "option"
         },
         "reason": {
-          "description": "Reason for the manual override.",
+          "description": "Free-text reason — recorded on the history entry for audit.",
           "name": "reason",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -399,7 +352,6 @@
         }
       },
       "hasDynamicHelp": false,
-      "hidden": true,
       "hiddenAliases": [],
       "id": "set-stage",
       "pluginAlias": "@sanity/workflow-cli",
@@ -428,6 +380,13 @@
         "<%= config.bin %> show wf-instance.abc123 --include history"
       ],
       "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "include": {
           "description": "Optional sections to include in output.",
           "name": "include",
@@ -447,7 +406,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -455,6 +413,65 @@
         "show.js"
       ]
     },
+    "start": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "Workflow definition name.",
+          "name": "name",
+          "required": true
+        }
+      },
+      "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"
+      ],
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "version": {
+          "description": "Definition version to start from (default: highest deployed).",
+          "name": "version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "field": {
+          "description": "Initial value for a declared input-sourced field, as name=value (repeatable). Values are JSON-parsed, falling back to a string; ref kinds take a JSON object with a GDR `id` and doc `type`.",
+          "name": "field",
+          "default": [],
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "json": {
+          "description": "Emit structured JSON instead of rendered output.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "start",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "start.js"
+      ]
+    },
     "tail": {
       "aliases": [],
       "args": {
@@ -468,7 +485,15 @@
       "examples": [
         "<%= config.bin %> tail wf-instance.abc123"
       ],
-      "flags": {},
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "tail",
@@ -476,7 +501,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -501,7 +525,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -535,7 +559,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -547,9 +570,9 @@
     "definition:diff": {
       "aliases": [],
       "args": {
-        "definition": {
+        "name": {
           "description": "Workflow definition name.",
-          "name": "definition",
+          "name": "name",
           "required": true
         }
       },
@@ -560,7 +583,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -581,7 +604,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -600,7 +622,7 @@
       ],
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -614,9 +636,9 @@
           "multiple": false,
           "type": "option"
         },
-        "workflow-name": {
-          "description": "Filter to a single workflow definition name (e.g. product-launch)",
-          "name": "workflow-name",
+        "name": {
+          "description": "Filter to a single workflow definition name (e.g. product-launch).",
+          "name": "name",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -629,7 +651,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -650,7 +671,7 @@
       "description": "Show a deployed workflow definition.",
       "flags": {
         "tag": {
-          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "description": "Workflow environment tag (e.g. prod, test) — the deployment to target for writes; an optional filter for reads.",
           "name": "tag",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -671,7 +692,6 @@
       "pluginName": "@sanity/workflow-cli",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -681,5 +701,5 @@
       ]
     }
   },
-  "version": "0.8.1"
+  "version": "0.10.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/workflow-cli",
-  "version": "0.8.1",
+  "version": "0.10.0",
   "description": "Command-line tool for deploying, inspecting, and administering Sanity workflow definitions and instances.",
   "keywords": [
     "cli",
@@ -27,7 +27,8 @@
   "files": [
     "dist",
     "bin/run.js",
-    "oclif.manifest.json"
+    "oclif.manifest.json",
+    "CHANGELOG.md"
   ],
   "type": "module",
   "sideEffects": false,
@@ -41,32 +42,38 @@
     "./package.json": "./package.json"
   },
   "publishConfig": {
-    "access": "restricted"
+    "access": "public"
   },
   "dependencies": {
     "@oclif/core": "^4.11.4",
     "@oclif/plugin-help": "^6.2.50",
+    "@sanity/cli-core": "^2.1.1",
     "@sanity/client": "^7.22.1",
+    "@sanity/telemetry": "^1.1.0",
     "boxen": "^8.0.1",
-    "console-table-printer": "^2.16.0",
     "date-fns": "^4.4.0",
     "diff": "^9.0.0",
+    "jiti": "^2.7.0",
     "log-symbols": "^7.0.1",
     "ora": "^9.4.0",
-    "@sanity/workflow-engine": "0.13.0"
+    "@sanity/workflow-engine": "0.15.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.8.0",
-    "@sanity/workflow-examples": "0.3.0"
+    "@sanity/workflow-engine-test": "0.10.0",
+    "@sanity/workflow-examples": "0.5.0"
   },
   "oclif": {
     "bin": "sanity-workflows",
     "commands": "./dist/commands",
     "dirname": "sanity-workflows",
+    "hooks": {
+      "finally": "./dist/hooks/finally/telemetry",
+      "prerun": "./dist/hooks/prerun/telemetry"
+    },
     "plugins": [
       "@oclif/plugin-help"
     ],
@@ -84,9 +91,10 @@
     "node": ">=20.12"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && tsc -p tsconfig.declarations.json",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "test": "vitest run",
+    "test:packaging": "vitest run --config vitest.packaging.config.ts",
     "test:watch": "vitest",
     "dev": "NODE_OPTIONS='--conditions=development' tsx --env-file-if-exists=../../.env bin/dev.js",
     "cli": "NODE_OPTIONS='--conditions=development' tsx --env-file-if-exists=../../.env bin/dev.js"

package/dist/commands/move-stage.d.ts

@@ -1,52 +0,0 @@
-import { Command } from '@oclif/core';
-import { type SetStageArgs } from '@sanity/workflow-engine';
-import { type WorkflowConfig } from '../lib/config.ts';
-import { type RanOp } from '../lib/ops-report.ts';
-export default class MoveStage extends Command {
-    static description: string;
-    static examples: string[];
-    static args: {
-        instanceId: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
-    static flags: {
-        to: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        reason: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        tag: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}
-/** The shared operation args ({@link buildOperationArgs}) plus the
- *  setStage-specific target. */
-export declare function buildSetStageArgs({ config, instanceId, targetStage, reason, }: {
-    config: WorkflowConfig;
-    instanceId: string;
-    targetStage: string;
-    reason: string | undefined;
-}): Omit<SetStageArgs, 'client'>;
-interface SetStageOutcome {
-    fired: boolean;
-    cascaded: number;
-    instance: {
-        currentStage: string;
-    };
-    ranOps?: RanOp[];
-}
-export interface MoveStageReport {
-    fired: boolean;
-    /** Spinner message — warn copy when not fired, success copy otherwise. */
-    message: string;
-    /**
-     * The full "ops applied" block to print after the spinner — a blank
-     * line, the header, and one line per op. Empty when nothing ran (or
-     * when the transition didn't fire), so the caller can print it
-     * unconditionally.
-     */
-    opsLines: string[];
-}
-/**
- * Turn a `setStage` result into the spinner message + ops block. Pure so
- * the fired / not-fired / cascaded / ops permutations can be asserted
- * without driving a real transition.
- */
-export declare function moveStageReport(result: SetStageOutcome, to: string): MoveStageReport;
-export {};