@sanity/workflow-cli 0.5.1

package/oclif.manifest.json

@@ -0,0 +1,684 @@
+{
+  "commands": {
+    "abort": {
+      "aliases": [],
+      "args": {
+        "instanceId": {
+          "description": "Workflow instance id.",
+          "name": "instanceId",
+          "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.",
+      "examples": [
+        "<%= config.bin %> abort wf-instance.abc123",
+        "<%= config.bin %> abort wf-instance.abc123 --reason 'superseded by relaunch'"
+      ],
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "reason": {
+          "description": "Reason for aborting (recorded in history).",
+          "name": "reason",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "abort",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "abort.js"
+      ]
+    },
+    "deploy": {
+      "aliases": [],
+      "args": {},
+      "description": "Validate, diff, and deploy workflow definitions to the configured dataset.",
+      "examples": [
+        "<%= config.bin %> deploy",
+        "<%= 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.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dry-run": {
+          "description": "Validate + diff against the deployed version; do not write.",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "check": {
+          "description": "Validate definitions only; do not contact the dataset.",
+          "name": "check",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "only": {
+          "description": "Limit deploy/check/diff to a single workflow definition by name.",
+          "name": "only",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "deploy",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "deploy.js"
+      ]
+    },
+    "diagnose": {
+      "aliases": [],
+      "args": {
+        "instanceId": {
+          "description": "Workflow instance id.",
+          "name": "instanceId",
+          "required": true
+        }
+      },
+      "description": "Explain why a workflow instance is or isn't progressing, and what would unstick it.",
+      "examples": [
+        "<%= config.bin %> diagnose wf-instance.abc123",
+        "<%= config.bin %> diagnose wf-instance.abc123 --tag prod",
+        "<%= config.bin %> diagnose wf-instance.abc123 --json"
+      ],
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "json": {
+          "description": "Emit the structured diagnosis as JSON instead of rendered output.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "diagnose",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "diagnose.js"
+      ]
+    },
+    "fire-action": {
+      "aliases": [],
+      "args": {
+        "instanceId": {
+          "description": "Workflow instance id.",
+          "name": "instanceId",
+          "required": true
+        }
+      },
+      "description": "Fire an action on an instance — act on a user's behalf to unstick a waiting task. Omit --action to list what can be fired.",
+      "examples": [
+        "<%= config.bin %> fire-action wf-instance.abc123",
+        "<%= config.bin %> fire-action wf-instance.abc123 --task approve --action approve",
+        "<%= config.bin %> fire-action wf-instance.abc123 --task approve --action approve --as user.xyz --as-role editor",
+        "<%= config.bin %> fire-action wf-instance.abc123 --task publish --action publish --param note=shipping"
+      ],
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "task": {
+          "description": "Task the action belongs to. Required to fire; omit --action to list.",
+          "name": "task",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "action": {
+          "description": "Action to fire. Omit to list the actions available on the instance.",
+          "name": "action",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "param": {
+          "description": "Action param as key=value (repeatable). Values are JSON-parsed, falling back to a string.",
+          "name": "param",
+          "default": [],
+          "hasDynamicHelp": false,
+          "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",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "fire-action",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "fire-action.js"
+      ]
+    },
+    "list": {
+      "aliases": [],
+      "args": {},
+      "description": "List workflow instances in the configured dataset.",
+      "examples": [
+        "<%= config.bin %> list",
+        "<%= config.bin %> list --in-flight",
+        "<%= config.bin %> list --workflow-id productLaunch"
+      ],
+      "flags": {
+        "in-flight": {
+          "description": "Only instances that have not completed.",
+          "name": "in-flight",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "failed": {
+          "description": "Only instances with at least one failed task.",
+          "name": "failed",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "workflow-id": {
+          "description": "Filter by workflow definition name.",
+          "name": "workflow-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "subject": {
+          "description": "Filter by subject document id. (not yet implemented)",
+          "name": "subject",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "limit": {
+          "description": "Maximum rows to return.",
+          "name": "limit",
+          "default": 50,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "list",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "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-task": {
+      "aliases": [],
+      "args": {
+        "instanceId": {
+          "description": "Workflow instance id.",
+          "name": "instanceId",
+          "required": true
+        },
+        "task": {
+          "description": "Task name within the current stage.",
+          "name": "task",
+          "required": true
+        }
+      },
+      "description": "Re-invoke a failed task on an in-flight instance.",
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "retry-task",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "retry-task.js"
+      ]
+    },
+    "set-stage": {
+      "aliases": [],
+      "args": {
+        "instanceId": {
+          "description": "Workflow instance id.",
+          "name": "instanceId",
+          "required": true
+        }
+      },
+      "description": "Force-set an instance's current stage, bypassing guards + effects (manual override).",
+      "flags": {
+        "to": {
+          "description": "Target stage name.",
+          "name": "to",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "reason": {
+          "description": "Reason for the manual override.",
+          "name": "reason",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "set-stage",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "set-stage.js"
+      ]
+    },
+    "show": {
+      "aliases": [],
+      "args": {
+        "instanceId": {
+          "description": "Workflow instance document id.",
+          "name": "instanceId",
+          "required": true
+        }
+      },
+      "description": "Show the state, tasks, and effects of a workflow instance.",
+      "examples": [
+        "<%= config.bin %> show wf-instance.abc123",
+        "<%= config.bin %> show wf-instance.abc123 --include history"
+      ],
+      "flags": {
+        "include": {
+          "description": "Optional sections to include in output.",
+          "name": "include",
+          "default": [],
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "history"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "show",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "show.js"
+      ]
+    },
+    "tail": {
+      "aliases": [],
+      "args": {
+        "instanceId": {
+          "description": "Workflow instance id to tail.",
+          "name": "instanceId",
+          "required": true
+        }
+      },
+      "description": "Stream new history entries on a workflow instance as they land in the dataset.",
+      "examples": [
+        "<%= config.bin %> tail wf-instance.abc123"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "tail",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "tail.js"
+      ]
+    },
+    "definition:delete": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "Workflow definition name.",
+          "name": "name",
+          "required": true
+        }
+      },
+      "description": "Delete a deployed workflow definition (every version, or one via --version). Refuses while non-terminal instances exist unless --cascade aborts them first — instances are aborted in place, never deleted.",
+      "examples": [
+        "<%= config.bin %> definition delete my-workflow",
+        "<%= config.bin %> definition delete my-workflow --version 2",
+        "<%= config.bin %> definition delete my-workflow --cascade --reason 'workflow retired'"
+      ],
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "version": {
+          "description": "Delete only this deployed version (default: every version).",
+          "name": "version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "cascade": {
+          "description": "Abort every non-terminal instance pinned to the targeted versions, then delete.",
+          "name": "cascade",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "reason": {
+          "description": "Free-text reason — recorded on each cascade-abort history entry.",
+          "name": "reason",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "definition:delete",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "definition",
+        "delete.js"
+      ]
+    },
+    "definition:diff": {
+      "aliases": [],
+      "args": {
+        "definition": {
+          "description": "Workflow definition name.",
+          "name": "definition",
+          "required": true
+        }
+      },
+      "description": "Diff an in-code definition against the deployed version (latest by default).",
+      "examples": [
+        "<%= config.bin %> definition diff productLaunch",
+        "<%= config.bin %> definition diff productLaunch --version 2"
+      ],
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "version": {
+          "description": "Deployed version to diff against (default: latest).",
+          "name": "version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "definition:diff",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "definition",
+        "diff.js"
+      ]
+    },
+    "definition:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List deployed workflow definitions.",
+      "examples": [
+        "<%= config.bin %> definition list",
+        "<%= config.bin %> definition list --tag prod"
+      ],
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "limit": {
+          "description": "The maximum number of definitions to return.",
+          "name": "limit",
+          "default": 100,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "workflow-id": {
+          "description": "Filter to a single workflow definition name (e.g. product-launch)",
+          "name": "workflow-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "definition:list",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "definition",
+        "list.js"
+      ]
+    },
+    "definition:show": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "Workflow definition name.",
+          "name": "name",
+          "required": true
+        }
+      },
+      "description": "Show a deployed workflow definition.",
+      "flags": {
+        "tag": {
+          "description": "Workflow environment tag (e.g. prod, test). Overrides WORKFLOW_TAG.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "version": {
+          "description": "Specific version (default: latest).",
+          "name": "version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "definition:show",
+      "pluginAlias": "@sanity/workflow-cli",
+      "pluginName": "@sanity/workflow-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "definition",
+        "show.js"
+      ]
+    }
+  },
+  "version": "0.5.1"
+}