@sanity/workflow-cli 0.12.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @sanity/workflow-cli
 
+## 0.14.0
+
+### Minor Changes
+
+- 59b40fd: **BREAKING:** deployment selection now keys on the deployment `name`, selected with `--deployment`. Deployment-targeted commands (`start`, `definition diff`, `definition delete`, `nuke`) take `--deployment` as the precise selector; `--tag` still selects while it names exactly one deployment and errors listing the candidates when it spans several. `deploy --tag <tag>` now deploys every deployment carrying the tag (a tag is an environment group); `--deployment` deploys one, `--all-tags` deploys everything, and the three are mutually exclusive. `nuke` requires exactly one of `--deployment` / `--tag`, and refuses when another same-tag deployment sweeps an overlapping resource — guard document ids embed only the tag, so within a shared dataset the sweep cannot tell the deployments' guards apart and would delete the other's live locks. The interactive deploy prompt selects by name with the tag as its description. Read commands keep `--tag` as an optional filter — a repeated tag fans reads out across every resource it is deployed to.
+- de7ccfa: The instance-keyed commands (`diagnose`, `abort`, `set-stage`, `fire-action`) accept `--deployment <name>` to choose which resource to read the instance from — the precise selector consistent with the deployment-targeted commands. `--deployment` names one deployment and reads from the resource it targets; `--tag` stays the optional narrower it was, and the instance's own tag partition still comes from the loaded instance itself, never from the flag. This closes the dead end where a tag repeated across several resources left these commands unable to resolve a resource, and the "spans multiple resources" failures now point at `--deployment` as the remedy.
+
+### Patch Changes
+
+- Updated dependencies [24b11dd]
+- Updated dependencies [2005ab7]
+- Updated dependencies [24b11dd]
+- Updated dependencies [59b40fd]
+  - @sanity/workflow-engine@0.19.0
+
+## 0.13.0
+
+### Minor Changes
+
+- 58f8211: Every command's canonical oclif id now nests under the `editorial-workflows` topic, making the package mountable as a plugin of the `sanity` CLI (`sanity editorial-workflows deploy`) without colliding with host commands. The standalone surface is unchanged: the bare forms (`sanity-workflows deploy`, `sanity-workflows definition list`, …) remain as aliases of the nested ids.
+- 00c089d: **BREAKING:** Require every definition deployment and workflow deployment configuration to state an `expectedMinReaderModel` literal that exactly matches the installed engine's writer capability.
+
+  Deploy and definition-diff paths now reject missing or stale acknowledgements before client access or telemetry, with a structured error and readers-first rollout guidance.
+
+- 53661fa: Prompt interactive deploys to select a configured deployment tag when several are available and no selector flag was supplied. Render Ctrl+C prompt cancellations without a stack trace.
+
+### Patch Changes
+
+- 82e4a4e: Fix definition sharing to honor its opt-out contract: deploys now share newly created definition versions by default in every environment, including CI, `DO_NOT_TRACK`, and non-TTY runs. The first interactive run shows a mandatory disclosure rather than a consent choice, every other flagless run prints a clear status block with the explicit opt-in and opt-out flags, and only `--no-share-defs` suppresses sharing for that invocation.
+- 9126299: **BREAKING:** Delete persisted stage guard documents when their stage exits, and remove the lifted-record `GUARD_LIFTED_PREDICATE` and `isGuardLifted` exports.
+
+  Guard deletion now uses the observed document revision so stale exit reconciliation cannot delete a guard reactivated by a newer stage visit. Reactive guard streams contain only active persisted guards.
+
+- Updated dependencies [239d9f6]
+- Updated dependencies [3af2ca0]
+- Updated dependencies [7276702]
+- Updated dependencies [58f8211]
+- Updated dependencies [00c089d]
+- Updated dependencies [71cd58e]
+- Updated dependencies [cd03973]
+- Updated dependencies [d26cc1a]
+- Updated dependencies [9126299]
+- Updated dependencies [72018af]
+- Updated dependencies [5cd8ffd]
+- Updated dependencies [b82bda4]
+- Updated dependencies [55a54b3]
+- Updated dependencies [b82bda4]
+- Updated dependencies [4490442]
+- Updated dependencies [1540dce]
+  - @sanity/workflow-engine@0.18.0
+
 ## 0.12.0
 
 ### Minor Changes

package/README.md

@@ -20,6 +20,19 @@ pnpm --filter @sanity/workflow-cli dev list --include-completed
 pnpm --filter @sanity/workflow-cli dev show wf-instance.abc123
 ```
 
+The package is an [oclif](https://oclif.io) plugin: every command's canonical
+id nests under the `editorial-workflows` topic
+(`sanity-workflows editorial-workflows deploy`), so mounting the package into
+the `sanity` CLI's plugin list surfaces the same commands as
+`sanity editorial-workflows …` without its canonical ids colliding with the
+host's own commands (the sanity CLI already has a `deploy`). The bare forms
+used throughout this README (`deploy`, `definition list`, …) are aliases of
+the nested ids and are the standalone binary's stable surface. oclif registers
+plugin aliases in a host unconditionally (an id collision resolves by plugin
+priority, host first), so a host mount would also surface these bare aliases
+at its root — trimming or hiding them for the mounted context is part of the
+host-side mount work, not something a host can configure away.
+
 Authenticate once with `sanity login` (the CLI reads that session token); for
 CI, set `SANITY_AUTH_TOKEN` instead. Then create a `sanity.workflow.ts` in the
 directory you run from — see [Configuration](#configuration).
@@ -36,7 +49,8 @@ project will fail on cross-resource reads.
 
 The CLI is configured by a `sanity.workflow.ts` (or `.js`/`.mjs`) discovered in
 the directory you run from. It exports a config built with
-`defineWorkflowConfig`, declaring one **deployment** per environment:
+`defineWorkflowConfig`, declaring your **deployments** (typically one per
+environment):
 
 ```ts
 import {defineWorkflowConfig} from '@sanity/workflow-engine/define'
@@ -46,7 +60,8 @@ import {articleReview, urlDraft} from './src/workflows.ts'
 export default defineWorkflowConfig({
   deployments: [
     {
-      name: 'production',
+      expectedMinReaderModel: 2,
+      name: 'production', // the deployment's unique identity (lowercase letters, digits, dashes)
       tag: 'prod', // the environment partition the engine's docs are scoped to
       workflowResource: {type: 'dataset', id: 'acme.workflows'}, // where those docs live
       resourceAliases: [
@@ -62,14 +77,25 @@ export default defineWorkflowConfig({
 })
 ```
 
-Pick a deployment with `--tag <tag>`; with a single deployment configured you
-can omit it, and with several configured a bare `deploy` fails asking for
-`--tag` or `--all-tags`. `--all-tags` deploys every deployment in the config in
-one run: a failure in one doesn't stop the rest — the run continues, prints a
-summary of what failed, and exits non-zero. The client's project + dataset are derived
-from the deployment's `workflowResource`, and `deploy` expands each
-definition's `@<handle>:` reference to the bound physical resource. An invalid
-config fails with a clean, path-prefixed error before the command runs.
+`name` is the deployment's identity: unique across the config and constrained
+to the same grammar as `tag`. Tags group deployments by environment and may
+repeat, as long as no two deployments share both a `workflowResource` and a
+`tag` — that pair is the storage partition, and the config rejects the
+collision naming both entries.
+
+Pick a deployment with `--deployment <name>`; with a single deployment configured you
+can omit it. `--tag <tag>` also works on single-deployment commands while the
+tag names exactly one deployment — on `deploy` it targets every deployment
+carrying the tag (a tag is an environment group). With several configured, a
+bare interactive `deploy` presents a keyboard-driven deployment selector (by
+name, tag alongside). In CI or another non-interactive shell, it fails asking
+for `--deployment`, `--tag`, or `--all-tags` instead of blocking for input.
+`--all-tags` deploys every deployment in the config in one run: a failure in one doesn't
+stop the rest — the run continues, prints a summary of what failed, and exits
+non-zero. The client's project + dataset are derived from the deployment's
+`workflowResource`, and `deploy` expands each definition's `@<handle>:`
+reference to the bound physical resource. An invalid config fails with a clean,
+path-prefixed error before the command runs.
 
 `resourceAliases` is only for content that lives in a _different_ resource from
 `workflowResource`. A definition can reference a document in the **same**
@@ -127,26 +153,26 @@ stale compiled output.
 
 ## Command status
 
-| Command                                | Status                                                                                                                                                                                           |
-| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `deploy`                               | wired — calls `workflow.deployDefinitions` over the selected deployment's definitions                                                                                                            |
-| `deploy --all-tags`                    | wired — deploys every deployment in the config, continuing past per-deployment failures                                                                                                          |
-| `deploy --check`                       | wired — runs `validateDefinition` over the local batch + a duplicate-name check                                                                                                                  |
-| `deploy --dry-run`                     | wired — fetches existing docs and renders a coloured JSON diff per change                                                                                                                        |
-| `deploy --only <name>`                 | wired — filters deploy/check/dry-run to one definition by `name`                                                                                                                                 |
-| `start <name>`                         | wired — calls `workflow.startInstance` (`--field` for input fields)                                                                                                                              |
-| `list`                                 | wired — `client.fetch` over `sanity.workflow.instance` documents (`--definition <name>` to filter)                                                                                               |
-| `show <instance-id>`                   | wired — `client.getDocument`                                                                                                                                                                     |
-| `diagnose <instance-id>`               | wired — calls `workflow.diagnose`, classifies why the instance is/isn't progressing                                                                                                              |
-| `tail <instance-id>`                   | wired — `client.listen()` over the instance, prints new history entries                                                                                                                          |
-| `abort <instance-id>`                  | wired — calls `workflow.abortInstance` (hard stop: cancels pending effects, lifts guards)                                                                                                        |
-| `set-stage <instance-id> --to <stage>` | wired — calls `workflow.setStage` (admin override: skips declared transitions/filters; enter lifecycle + cascade still run)                                                                      |
-| `fire-action <instance-id>`            | wired — `workflow.availableActions` lists actions; `workflow.fireAction` fires one                                                                                                               |
-| `definition list`                      | wired — `client.fetch` over `sanity.workflow.definition` documents                                                                                                                               |
-| `definition show <name>`               | wired — `client.fetch`, latest version unless `--version`                                                                                                                                        |
-| `definition diff <name>`               | wired — diffs the in-code definition against the deployed latest (`--version` to pin)                                                                                                            |
-| `definition delete <name>`             | wired — calls `workflow.deleteDefinition` (refuses on live instances unless `--cascade`)                                                                                                         |
-| `nuke --tag <tag>`                     | wired — dev-period reset (exists only until the versioned upgrade framework): deletes every engine-owned doc for the tag (instances, definitions, guards across resources); plan + typed confirm |
+| Command                                         | Status                                                                                                                                                                                                                                                                                                                                                |
+| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `deploy`                                        | wired — calls `workflow.deployDefinitions` over the selected deployment's definitions                                                                                                                                                                                                                                                                 |
+| `deploy --all-tags`                             | wired — deploys every deployment in the config, continuing past per-deployment failures                                                                                                                                                                                                                                                               |
+| `deploy --check`                                | wired — runs `validateDefinition` over the local batch + a duplicate-name check                                                                                                                                                                                                                                                                       |
+| `deploy --dry-run`                              | wired — fetches existing docs and renders a coloured JSON diff per change                                                                                                                                                                                                                                                                             |
+| `deploy --only <name>`                          | wired — filters deploy/check/dry-run to one definition by `name`                                                                                                                                                                                                                                                                                      |
+| `start <name>`                                  | wired — calls `workflow.startInstance` (`--field` for input fields)                                                                                                                                                                                                                                                                                   |
+| `list`                                          | wired — `client.fetch` over `sanity.workflow.instance` documents (`--definition <name>` to filter)                                                                                                                                                                                                                                                    |
+| `show <instance-id>`                            | wired — `client.getDocument`                                                                                                                                                                                                                                                                                                                          |
+| `diagnose <instance-id>`                        | wired — calls `workflow.diagnose`, classifies why the instance is/isn't progressing                                                                                                                                                                                                                                                                   |
+| `tail <instance-id>`                            | wired — `client.listen()` over the instance, prints new history entries                                                                                                                                                                                                                                                                               |
+| `abort <instance-id>`                           | wired — calls `workflow.abortInstance` (hard stop: cancels pending effects, removes guards)                                                                                                                                                                                                                                                           |
+| `set-stage <instance-id> --to <stage>`          | wired — calls `workflow.setStage` (admin override: skips declared transitions/filters; enter lifecycle + cascade still run)                                                                                                                                                                                                                           |
+| `fire-action <instance-id>`                     | wired — `workflow.availableActions` lists actions; `workflow.fireAction` fires one                                                                                                                                                                                                                                                                    |
+| `definition list`                               | wired — `client.fetch` over `sanity.workflow.definition` documents                                                                                                                                                                                                                                                                                    |
+| `definition show <name>`                        | wired — `client.fetch`, latest version unless `--version`                                                                                                                                                                                                                                                                                             |
+| `definition diff <name>`                        | wired — diffs the in-code definition against the deployed latest (`--version` to pin)                                                                                                                                                                                                                                                                 |
+| `definition delete <name>`                      | wired — calls `workflow.deleteDefinition` (refuses on live instances unless `--cascade`)                                                                                                                                                                                                                                                              |
+| `nuke --deployment <name>` / `nuke --tag <tag>` | wired — dev-period reset (exists only until the versioned upgrade framework): deletes every engine-owned doc for the deployment's tag (instances, definitions, guards across resources); exactly one selector required; refuses while another same-tag deployment sweeps an overlapping resource (guard ids embed only the tag); plan + typed confirm |
 
 ## Telemetry
 
@@ -155,8 +181,9 @@ per-command trace (`Editorial Workflows CLI Command Executed` — the command id
 names of declared flags used, never their values, and a success flag) plus
 the engine's adoption events from the operations it drives. Consent is the
 account-wide status managed by `npx sanity telemetry enable|disable|status`;
-CI and trueish `DO_NOT_TRACK` suppress everything (except a `deploy --share-defs`,
-which forces that deploy's telemetry — see [Definition sharing](#definition-sharing)),
+CI and trueish `DO_NOT_TRACK` suppress everything (except a deploy that may share
+new definitions, which forces that deploy's telemetry unless `--no-share-defs`
+is passed — see [Definition sharing](#definition-sharing)),
 and a session that isn't logged in sends nothing. A one-time notice on stderr
 discloses collection on first use.
 
@@ -176,25 +203,27 @@ definition-feedback endpoint, not the telemetry pipeline; telemetry carries
 only a content-free marker (content hash plus structural counts) per shared
 definition and a per-invocation decision event.
 
-Sharing is **opt-out**. Pass `--share-defs` to donate without being asked, or
-`--no-share-defs` to decline. With neither flag, an interactive terminal is
-asked **once** — the answer is remembered in your Sanity user config, so the
-prompt never repeats — before anything is sent; notice always precedes the
-send. Every later flagless deploy then prints a one-line reminder of the
-current state (sharing, or not) and the flag to change it, so an ongoing
-donation is never silent. Unattended runs (CI, `DO_NOT_TRACK`, a non-TTY pipe)
-can't prompt: by default they donate nothing (opt in per run with
-`--share-defs`). An explicit `--share-defs` also sends that deploy's telemetry
-regardless of CI / `DO_NOT_TRACK` — a command-line arg beats env vars;
-account-level `sanity telemetry disable` still applies. A failed share only
-warns, never failing a completed deploy.
+Sharing is **opt-out in every environment**. Pass `--no-share-defs` to decline
+for one invocation. With neither flag, the first interactive deploy prints a
+full notice before sending and remembers that the notice was shown; every later
+flagless deploy prints a status block showing that sharing is on by default and
+showing runnable shell examples for the default, explicit opt-in, and opt-out
+forms; the explicit flags suppress the status block. Unattended runs (CI,
+`DO_NOT_TRACK`, or a non-TTY pipe) also share by default and print that status
+block in their logs.
+A flagless deploy or explicit `--share-defs` forces that deploy's telemetry
+through the environment gate so donated definitions retain their content-free
+markers; account-level `sanity telemetry disable` still applies. A failed share
+only warns, never failing a completed deploy.
 
 ## Known gaps
 
-- **No `sanity workflow` plugin wiring yet.** The proposal targets the
-  Sanity CLI as a plugin host. The package publishes as a standalone
-  `sanity-workflows` binary today; plugging into `sanity` as an oclif
-  plugin is a separate piece of work.
+- **Not mounted in the `sanity` CLI yet.** The package side is mount-ready —
+  commands nest under the `editorial-workflows` oclif topic (see
+  [Run](#run)) — but the `sanity` CLI does not list this package in its
+  plugin array, so the commands ship only through the standalone
+  `sanity-workflows` binary today. The host-side mount (and what happens to
+  the bare aliases inside a host) is a separate piece of work.
 - **No true bypass.** `set-stage` is the engine's `setStage` admin
   override: it skips the definition's declared transitions and filters, but
   the target stage's enter lifecycle and the post-move cascade still run. A

package/dist/commands/{abort.d.ts → editorial-workflows/abort.d.ts}

@@ -1,7 +1,8 @@
 import { type WorkflowInstance } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../lib/base-command.ts';
-import { type WriteReport } from '../lib/ops-report.ts';
+import { WorkflowCommand } from '../../lib/base-command.ts';
+import { type WriteReport } from '../../lib/ops-report.ts';
 export default class Abort extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {
@@ -9,6 +10,7 @@ export default class Abort extends WorkflowCommand {
     };
     static flags: {
         reason: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        deployment: 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>;

package/dist/commands/{abort.js → editorial-workflows/abort.js}

@@ -1,13 +1,14 @@
 import { styleText } from 'node:util';
 import { Args, Flags } from '@oclif/core';
 import { workflow } from '@sanity/workflow-engine';
-import { WorkflowCommand } from "../lib/base-command.js";
-import { resolveInstanceContext } from "../lib/context.js";
-import { tagFlags } from "../lib/flags.js";
-import { buildOperationArgs } from "../lib/operation-args.js";
-import { runWriteVerb } from "../lib/ops-report.js";
+import { WorkflowCommand } from "../../lib/base-command.js";
+import { resolveInstanceContext } from "../../lib/context.js";
+import { instanceFlags } from "../../lib/flags.js";
+import { buildOperationArgs } from "../../lib/operation-args.js";
+import { runWriteVerb } from "../../lib/ops-report.js";
 export default class Abort extends WorkflowCommand {
-    static 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.';
+    static aliases = ['abort'];
+    static 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.';
     static examples = [
         '<%= config.bin %> abort wf-instance.abc123',
         "<%= config.bin %> abort wf-instance.abc123 --reason 'superseded by relaunch'",
@@ -16,7 +17,7 @@ export default class Abort extends WorkflowCommand {
         instanceId: Args.string({ required: true, description: 'Workflow instance id.' }),
     };
     static flags = {
-        ...tagFlags,
+        ...instanceFlags,
         reason: Flags.string({ description: 'Reason for aborting (recorded in history).' }),
     };
     async run() {

package/dist/commands/{definition → editorial-workflows/definition}/delete.d.ts

@@ -1,7 +1,8 @@
 import { type DeleteDefinitionArgs, type DeleteDefinitionResult } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../../lib/base-command.ts';
-import { type EngineScope } from '../../lib/operation-args.ts';
+import { WorkflowCommand } from '../../../lib/base-command.ts';
+import { type EngineScope } from '../../../lib/operation-args.ts';
 export default class DefinitionDelete extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {
@@ -11,6 +12,7 @@ export default class DefinitionDelete extends WorkflowCommand {
         version: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
         cascade: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         reason: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        deployment: 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>;

package/dist/commands/{definition → editorial-workflows/definition}/delete.js

@@ -1,12 +1,13 @@
 import { styleText } from 'node:util';
 import { Args, Flags } from '@oclif/core';
 import { workflow, } from '@sanity/workflow-engine';
-import { WorkflowCommand } from "../../lib/base-command.js";
-import { resolveContext } from "../../lib/context.js";
-import { tagFlags } from "../../lib/flags.js";
-import { baseEngineArgs } from "../../lib/operation-args.js";
-import { runWriteVerb } from "../../lib/ops-report.js";
+import { WorkflowCommand } from "../../../lib/base-command.js";
+import { resolveContext } from "../../../lib/context.js";
+import { deploymentFlags } from "../../../lib/flags.js";
+import { baseEngineArgs } from "../../../lib/operation-args.js";
+import { runWriteVerb } from "../../../lib/ops-report.js";
 export default class DefinitionDelete extends WorkflowCommand {
+    static aliases = ['definition:delete'];
     static 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.';
@@ -19,7 +20,7 @@ export default class DefinitionDelete extends WorkflowCommand {
         name: Args.string({ required: true, description: 'Workflow definition name.' }),
     };
     static flags = {
-        ...tagFlags,
+        ...deploymentFlags,
         version: Flags.integer({
             description: 'Delete only this deployed version (default: every version).',
         }),

package/dist/commands/{definition → editorial-workflows/definition}/diff.d.ts

@@ -1,6 +1,7 @@
 import { type WorkflowDefinition } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../../lib/base-command.ts';
+import { WorkflowCommand } from '../../../lib/base-command.ts';
 export default class DefinitionDiff extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {
@@ -8,6 +9,7 @@ export default class DefinitionDiff extends WorkflowCommand {
     };
     static flags: {
         version: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        deployment: 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>;

package/dist/commands/{definition → editorial-workflows/definition}/diff.js

@@ -1,13 +1,14 @@
 import { Args, Flags } from '@oclif/core';
 import { diffEntry } from '@sanity/workflow-engine';
 import ora from 'ora';
-import { WorkflowCommand } from "../../lib/base-command.js";
-import { resolveContext } from "../../lib/context.js";
-import { fetchDeployedDefinition, selectDefinitions, validateOrFail } from "../../lib/definitions.js";
-import { diffReport } from "../../lib/diff.js";
-import { tagFlags } from "../../lib/flags.js";
-import { deploymentToTarget } from "../../lib/select-deployment.js";
+import { WorkflowCommand } from "../../../lib/base-command.js";
+import { resolveContext } from "../../../lib/context.js";
+import { fetchDeployedDefinition, selectDefinitions, validateOrFail, } from "../../../lib/definitions.js";
+import { diffReport } from "../../../lib/diff.js";
+import { deploymentFlags } from "../../../lib/flags.js";
+import { deploymentToTarget } from "../../../lib/select-deployment.js";
 export default class DefinitionDiff extends WorkflowCommand {
+    static aliases = ['definition:diff'];
     static description = 'Diff an in-code definition against the deployed version (latest by default).';
     static examples = [
         '<%= config.bin %> definition diff productLaunch',
@@ -17,7 +18,7 @@ export default class DefinitionDiff extends WorkflowCommand {
         name: Args.string({ required: true, description: 'Workflow definition name.' }),
     };
     static flags = {
-        ...tagFlags,
+        ...deploymentFlags,
         version: Flags.integer({ description: 'Deployed version to diff against (default: latest).' }),
     };
     async run() {

package/dist/commands/{definition → editorial-workflows/definition}/list.d.ts

@@ -1,4 +1,4 @@
-import { WorkflowCommand } from '../../lib/base-command.ts';
+import { WorkflowCommand } from '../../../lib/base-command.ts';
 interface DefinitionListFlags {
     tag?: string | undefined;
     name?: string | undefined;
@@ -22,6 +22,7 @@ export declare function buildDefinitionListQuery(flags: DefinitionListFlags): {
     params: Record<string, unknown>;
 };
 export default class DefinitionList extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static flags: {

package/dist/commands/{definition → editorial-workflows/definition}/list.js

@@ -1,11 +1,11 @@
 import { Flags } from '@oclif/core';
 import { WORKFLOW_DEFINITION_TYPE, WORKFLOW_INSTANCE_TYPE, assertReadableModel, inFlightFilter, tagScopeFilter, } from '@sanity/workflow-engine';
 import logSymbols from 'log-symbols';
-import { WorkflowCommand } from "../../lib/base-command.js";
-import { resolveReadTargets } from "../../lib/context.js";
-import { tagFlags } from "../../lib/flags.js";
-import { runReadAcrossTargets } from "../../lib/read-fanout.js";
-import { clipToLimit, formatTable } from "../../lib/ui.js";
+import { WorkflowCommand } from "../../../lib/base-command.js";
+import { resolveReadTargets } from "../../../lib/context.js";
+import { tagFlags } from "../../../lib/flags.js";
+import { runReadAcrossTargets } from "../../../lib/read-fanout.js";
+import { logClippedTable } from "../../../lib/ui.js";
 export function buildDefinitionListQuery(flags) {
     const params = { limit: flags.limit + 1 };
     const filters = [`_type == "${WORKFLOW_DEFINITION_TYPE}"`];
@@ -40,6 +40,7 @@ export function buildDefinitionListQuery(flags) {
     return { groq, params };
 }
 export default class DefinitionList extends WorkflowCommand {
+    static aliases = ['definition:list'];
     static description = 'List deployed workflow definitions.';
     static examples = [
         '<%= config.bin %> definition list',
@@ -70,22 +71,21 @@ export default class DefinitionList extends WorkflowCommand {
                     this.log(`${logSymbols.info} no definitions found`);
                     return;
                 }
-                const { rows, note } = clipToLimit(fetched, flags.limit);
-                const lines = formatTable(['workflow', 'title', 'tag', 'stages', 'in flight', 'instances', 'created'], rows.map((r) => [
-                    `${r.name} v${r.version}`,
-                    r.title,
-                    r.tag,
-                    String(r.stageCount),
-                    String(r.inFlightCount),
-                    String(r.totalInstances),
-                    r._createdAt,
-                ]));
-                for (const line of lines) {
-                    this.log(line);
-                }
-                if (note) {
-                    this.log(note);
-                }
+                logClippedTable({
+                    rows: fetched,
+                    limit: flags.limit,
+                    headers: ['workflow', 'title', 'tag', 'stages', 'in flight', 'instances', 'created'],
+                    toCells: (r) => [
+                        `${r.name} v${r.version}`,
+                        r.title,
+                        r.tag,
+                        String(r.stageCount),
+                        String(r.inFlightCount),
+                        String(r.totalInstances),
+                        r._createdAt,
+                    ],
+                    log: (line) => this.log(line),
+                });
             },
         });
         if (failures.length > 0) {

package/dist/commands/{definition → editorial-workflows/definition}/show.d.ts

@@ -1,7 +1,8 @@
 import { type DeployedDefinition, type WorkflowDefinition, type WorkflowResource } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../../lib/base-command.ts';
-import { type ReadTarget } from '../../lib/context.ts';
+import { WorkflowCommand } from '../../../lib/base-command.ts';
+import { type ReadTarget } from '../../../lib/context.ts';
 export default class DefinitionShow extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static args: {
         name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;

package/dist/commands/{definition → editorial-workflows/definition}/show.js

@@ -2,13 +2,14 @@ import { styleText } from 'node:util';
 import { Args, Flags } from '@oclif/core';
 import { assertReadableModel, isTerminalStage, } from '@sanity/workflow-engine';
 import logSymbols from 'log-symbols';
-import { WorkflowCommand } from "../../lib/base-command.js";
-import { resolveReadTargets, soleHitOrFail } from "../../lib/context.js";
-import { buildDefinitionShowQuery, buildDefinitionTagsQuery } from "../../lib/definitions.js";
-import { fail } from "../../lib/fail.js";
-import { tagFlags } from "../../lib/flags.js";
-import { formatKeyValue, resourceLabel, sectionHeader } from "../../lib/ui.js";
+import { WorkflowCommand } from "../../../lib/base-command.js";
+import { resolveReadTargets, soleHitOrFail } from "../../../lib/context.js";
+import { buildDefinitionShowQuery, buildDefinitionTagsQuery } from "../../../lib/definitions.js";
+import { fail } from "../../../lib/fail.js";
+import { tagFlags } from "../../../lib/flags.js";
+import { formatKeyValue, resourceLabel, sectionHeader } from "../../../lib/ui.js";
 export default class DefinitionShow extends WorkflowCommand {
+    static aliases = ['definition:show'];
     static description = 'Show a deployed workflow definition.';
     static args = {
         name: Args.string({ required: true, description: 'Workflow definition name.' }),

package/dist/commands/{deploy.d.ts → editorial-workflows/deploy.d.ts}

@@ -1,5 +1,5 @@
 import { type DeployDefinitionResult, type WorkflowDefinition, type WorkflowDeployment } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../lib/base-command.ts';
+import { WorkflowCommand } from '../../lib/base-command.ts';
 /** A deployment paired with the definitions selected + validated for it. */
 interface DeployBatch {
     deployment: WorkflowDeployment;
@@ -11,15 +11,17 @@ interface DeployFailure {
     message: string;
 }
 export default class Deploy extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static flags: {
+        tag: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'all-tags': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         check: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         only: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'share-defs': import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        tag: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        deployment: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
     /** Deploy (or diff, for `--dry-run`) one deployment's definitions.