@sanity/workflow-cli 0.12.0 → 0.14.0

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

@@ -3,20 +3,22 @@ import { Flags } from '@oclif/core';
 import { computeDiffEntries, errorMessage, workflow, } from '@sanity/workflow-engine';
 import logSymbols from 'log-symbols';
 import ora from 'ora';
-import { WorkflowCommand } from "../lib/base-command.js";
-import { clientFor, resolveTokenOrFail } from "../lib/client.js";
-import { selectDefinitions, validateOrFail } from "../lib/definitions.js";
-import { diffReport } from "../lib/diff.js";
-import { fail, isAuthRejection } from "../lib/fail.js";
-import { tagFlags } from "../lib/flags.js";
-import { loadWorkflowConfig } from "../lib/load-config.js";
-import { deploymentToTarget, selectDeployments } from "../lib/select-deployment.js";
-import { shareDefinitionsAfterDeploy } from "../lib/share-definitions.js";
-import { cliTelemetry } from "../lib/telemetry.js";
-import { groupBanner } from "../lib/ui.js";
+import { WorkflowCommand } from "../../lib/base-command.js";
+import { clientFor, resolveTokenOrFail } from "../../lib/client.js";
+import { selectDefinitions, validateOrFail } from "../../lib/definitions.js";
+import { diffReport } from "../../lib/diff.js";
+import { fail, isAuthRejection } from "../../lib/fail.js";
+import { deploymentFlags } from "../../lib/flags.js";
+import { loadWorkflowConfig } from "../../lib/load-config.js";
+import { deploymentLabel, deploymentToTarget, selectDeployments, } from "../../lib/select-deployment.js";
+import { shareDefinitionsAfterDeploy } from "../../lib/share-definitions.js";
+import { cliTelemetry } from "../../lib/telemetry.js";
+import { groupBanner } from "../../lib/ui.js";
 export default class Deploy extends WorkflowCommand {
+    static aliases = ['deploy'];
     static description = 'Validate, diff, and deploy workflow definitions to the resource bound by the selected deployment.';
     static examples = [
+        '<%= config.bin %> deploy --deployment review-prod',
         '<%= config.bin %> deploy --tag prod',
         '<%= config.bin %> deploy --all-tags',
         '<%= config.bin %> deploy --check',
@@ -24,11 +26,15 @@ export default class Deploy extends WorkflowCommand {
         '<%= config.bin %> deploy --only productLaunch',
     ];
     static flags = {
-        ...tagFlags,
+        ...deploymentFlags,
+        tag: Flags.string({
+            description: 'Workflow environment tag (e.g. prod, test) — deploys every deployment carrying the tag (a tag is an environment group).',
+            exclusive: ['deployment'],
+        }),
         'all-tags': Flags.boolean({
-            description: 'Deploy every deployment in the config, not just one tag.',
+            description: 'Deploy every deployment in the config, not just a selection.',
             default: false,
-            exclusive: ['tag'],
+            exclusive: ['tag', 'deployment'],
         }),
         'dry-run': Flags.boolean({
             description: 'Validate + diff against the deployed version; do not write.',
@@ -43,14 +49,18 @@ export default class Deploy extends WorkflowCommand {
         }),
         'share-defs': Flags.boolean({
             allowNo: true,
-            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.',
         }),
     };
     async run() {
         const { flags } = await this.parse(Deploy);
         validateModeFlags(flags.check, flags['dry-run']);
         const config = await loadWorkflowConfig();
-        const batches = buildBatches(selectDeployments(config, { tag: flags.tag, allTags: flags['all-tags'] }), flags.only);
+        const batches = buildBatches(await selectDeployments(config, {
+            name: flags.deployment,
+            tag: flags.tag,
+            allTags: flags['all-tags'],
+        }), flags.only);
         const log = (line) => this.log(line);
         if (flags.check) {
             await reconcileBatches({
@@ -144,9 +154,6 @@ export function validateModeFlags(check, dryRun) {
         fail('Pass either --check or --dry-run, not both.');
     }
 }
-function deploymentLabel({ name, tag }) {
-    return `${name} (${tag})`;
-}
 export function buildBatches(deployments, only) {
     return deployments.map((deployment) => {
         const context = deployments.length > 1 ? `${deploymentLabel(deployment)} — ` : '';

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

@@ -1,5 +1,5 @@
 import { type Diagnosis, type DiagnoseInput, type SuggestedRemediation, type WorkflowEvaluation } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../lib/base-command.ts';
+import { WorkflowCommand } from '../../lib/base-command.ts';
 /** The `--json` transitions payload: raw derived state (atom GROQ, negation,
  *  pivotality, solvable requirement) — structure for scripts, never baked
  *  English. Pure so the shape is a testable contract. */
@@ -32,6 +32,7 @@ export declare function renderDiagnosis({ diagnosis, input, remediations, explan
     explanations?: ReadonlyMap<string, string> | undefined;
 }): string[];
 export default class Diagnose extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {
@@ -39,6 +40,7 @@ export default class Diagnose extends WorkflowCommand {
     };
     static flags: {
         json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        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/{diagnose.js → editorial-workflows/diagnose.js}

@@ -2,12 +2,12 @@ import { styleText } from 'node:util';
 import { Args } from '@oclif/core';
 import { diagnoseInputFromEvaluation, workflow, unsatisfiedTransitionSummaries, } from '@sanity/workflow-engine';
 import logSymbols from 'log-symbols';
-import { WorkflowCommand } from "../lib/base-command.js";
-import { resolveInstanceContext } from "../lib/context.js";
-import { fail, failureDetail } from "../lib/fail.js";
-import { jsonFlags, tagFlags } from "../lib/flags.js";
-import { baseEngineArgs } from "../lib/operation-args.js";
-import { formatTimestamp, sectionHeader, activityIcon } from "../lib/ui.js";
+import { WorkflowCommand } from "../../lib/base-command.js";
+import { resolveInstanceContext } from "../../lib/context.js";
+import { fail, failureDetail } from "../../lib/fail.js";
+import { instanceFlags, jsonFlags } from "../../lib/flags.js";
+import { baseEngineArgs } from "../../lib/operation-args.js";
+import { formatTimestamp, sectionHeader, activityIcon } from "../../lib/ui.js";
 import { instanceHeader } from "./show.js";
 function formatAssignee(a) {
     return a.type === 'user' ? `user:${a.id}` : `role:${a.role}`;
@@ -212,6 +212,7 @@ export function renderDiagnosis({ diagnosis, input, remediations, explanations,
     return lines;
 }
 export default class Diagnose extends WorkflowCommand {
+    static aliases = ['diagnose'];
     static description = "Explain why a workflow instance is or isn't progressing, and what would unstick it.";
     static examples = [
         '<%= config.bin %> diagnose wf-instance.abc123',
@@ -222,7 +223,7 @@ export default class Diagnose extends WorkflowCommand {
         instanceId: Args.string({ required: true, description: 'Workflow instance id.' }),
     };
     static flags = {
-        ...tagFlags,
+        ...instanceFlags,
         ...jsonFlags,
     };
     async run() {

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

@@ -1,6 +1,6 @@
 import { type AvailableAction } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../lib/base-command.ts';
-import { type WriteOutcome, type WriteReport } from '../lib/ops-report.ts';
+import { WorkflowCommand } from '../../lib/base-command.ts';
+import { type WriteOutcome, type WriteReport } from '../../lib/ops-report.ts';
 /**
  * The list-mode body: every action on the current stage's activities, marked
  * fireable or not (with the disabling reason), plus a hint showing the
@@ -30,6 +30,7 @@ export declare function fireActionReport({ result, activity, action, }: {
     action: string;
 }): WriteReport;
 export default class FireAction extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {
@@ -40,6 +41,7 @@ export default class FireAction extends WorkflowCommand {
         activity: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         action: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         param: import("@oclif/core/interfaces").OptionFlag<string[], 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/{fire-action.js → editorial-workflows/fire-action.js}

@@ -2,13 +2,13 @@ import { styleText } from 'node:util';
 import { Args, Flags } from '@oclif/core';
 import { actionRendering, actionDisabledDetail, deniedGuardLabels, workflow, } from '@sanity/workflow-engine';
 import logSymbols from 'log-symbols';
-import { WorkflowCommand } from "../lib/base-command.js";
-import { resolveInstanceContext } from "../lib/context.js";
-import { fail, failOnThrow, failureDetail } from "../lib/fail.js";
-import { jsonFlags, tagFlags } from "../lib/flags.js";
-import { baseEngineArgs } from "../lib/operation-args.js";
-import { cascadeTail, opsAppliedLines, runWriteVerb, } from "../lib/ops-report.js";
-import { parseParams } from "../lib/params.js";
+import { WorkflowCommand } from "../../lib/base-command.js";
+import { resolveInstanceContext } from "../../lib/context.js";
+import { fail, failOnThrow, failureDetail } from "../../lib/fail.js";
+import { instanceFlags, jsonFlags } from "../../lib/flags.js";
+import { baseEngineArgs } from "../../lib/operation-args.js";
+import { cascadeTail, opsAppliedLines, runWriteVerb, } from "../../lib/ops-report.js";
+import { parseParams } from "../../lib/params.js";
 import { instanceHeader } from "./show.js";
 function reasonText(reason) {
     if (reason.kind === 'mutation-guard-denied') {
@@ -82,6 +82,7 @@ export function fireActionReport({ result, activity, action, }) {
     };
 }
 export default class FireAction extends WorkflowCommand {
+    static aliases = ['fire-action'];
     static 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.';
     static examples = [
         '<%= config.bin %> fire-action wf-instance.abc123',
@@ -92,7 +93,7 @@ export default class FireAction extends WorkflowCommand {
         instanceId: Args.string({ required: true, description: 'Workflow instance id.' }),
     };
     static flags = {
-        ...tagFlags,
+        ...instanceFlags,
         activity: Flags.string({
             description: 'Activity the action belongs to. Required to fire; omit --action to list.',
         }),

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

@@ -1,5 +1,5 @@
 import { type TerminalState } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../lib/base-command.ts';
+import { WorkflowCommand } from '../../lib/base-command.ts';
 interface InstanceRow {
     _id: string;
     definition: string;
@@ -45,6 +45,7 @@ export declare function instanceRow(r: InstanceRow): {
     lastChangedAt: string;
 };
 export default class List extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static flags: {

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

@@ -1,12 +1,12 @@
 import { Flags } from '@oclif/core';
 import { WORKFLOW_INSTANCE_TYPE, assertReadableModel, documentPrefilter, inFlightFilter, instanceWatchesDocument, tagScopeFilter, terminalState, } from '@sanity/workflow-engine';
 import logSymbols from 'log-symbols';
-import { WorkflowCommand } from "../lib/base-command.js";
-import { resolveReadTargets } from "../lib/context.js";
-import { failOnThrow } from "../lib/fail.js";
-import { tagFlags } from "../lib/flags.js";
-import { runReadAcrossTargets } from "../lib/read-fanout.js";
-import { clipToLimit, formatAge, formatTable } from "../lib/ui.js";
+import { WorkflowCommand } from "../../lib/base-command.js";
+import { resolveReadTargets } from "../../lib/context.js";
+import { failOnThrow } from "../../lib/fail.js";
+import { tagFlags } from "../../lib/flags.js";
+import { runReadAcrossTargets } from "../../lib/read-fanout.js";
+import { formatAge, logClippedTable } from "../../lib/ui.js";
 export function buildListQuery(flags) {
     const filters = [`_type == "${WORKFLOW_INSTANCE_TYPE}"`];
     const params = {};
@@ -56,6 +56,7 @@ export function instanceRow(r) {
     };
 }
 export default class List extends WorkflowCommand {
+    static aliases = ['list'];
     static description = 'List workflow instances in the configured dataset (in-flight by default).';
     static examples = [
         '<%= config.bin %> list',
@@ -100,24 +101,23 @@ export default class List extends WorkflowCommand {
                     this.log(`${logSymbols.info} no instances match`);
                     return;
                 }
-                const { rows, note } = clipToLimit(fetched, flags.limit);
-                const lines = formatTable(['instance', 'workflow', 'tag', 'stage', 'status', 'updated'], rows.map((r) => {
-                    const row = instanceRow(r);
-                    return [
-                        row._id,
-                        row.definition,
-                        row.tag,
-                        row.currentStage,
-                        row.status,
-                        formatAge(row.lastChangedAt),
-                    ];
-                }));
-                for (const line of lines) {
-                    this.log(line);
-                }
-                if (note) {
-                    this.log(note);
-                }
+                logClippedTable({
+                    rows: fetched,
+                    limit: flags.limit,
+                    headers: ['instance', 'workflow', 'tag', 'stage', 'status', 'updated'],
+                    toCells: (r) => {
+                        const row = instanceRow(r);
+                        return [
+                            row._id,
+                            row.definition,
+                            row.tag,
+                            row.currentStage,
+                            row.status,
+                            formatAge(row.lastChangedAt),
+                        ];
+                    },
+                    log: (line) => this.log(line),
+                });
             },
         });
         if (failures.length > 0) {

package/dist/commands/editorial-workflows/nuke.d.ts

@@ -0,0 +1,13 @@
+import { WorkflowCommand } from '../../lib/base-command.ts';
+export default class Nuke extends WorkflowCommand {
+    static aliases: string[];
+    static summary: string;
+    static description: string;
+    static examples: string[];
+    static flags: {
+        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>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

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

@@ -2,29 +2,34 @@ import { Flags } from '@oclif/core';
 import { input } from '@sanity/cli-core/ux';
 import { resourceGdr } from '@sanity/workflow-engine';
 import logSymbols from 'log-symbols';
-import { WorkflowCommand } from "../lib/base-command.js";
-import { clientFor, resolveApiHost, resolveTokenOrFail } from "../lib/client.js";
-import { dedupeResources } from "../lib/context.js";
-import { fail } from "../lib/fail.js";
-import { loadWorkflowConfig } from "../lib/load-config.js";
-import { confirmationMatches, executeNuke, formatNukeSummary, involvedTargets, planCounts, renderNukePlan, resolveNukePlan, } from "../lib/nuke.js";
-import { runWriteVerb } from "../lib/ops-report.js";
-import { canPromptOnStderr } from "../lib/prompt.js";
-import { selectDeployment } from "../lib/select-deployment.js";
+import { WorkflowCommand } from "../../lib/base-command.js";
+import { clientFor, resolveApiHost, resolveTokenOrFail } from "../../lib/client.js";
+import { dedupeResources } from "../../lib/context.js";
+import { fail } from "../../lib/fail.js";
+import { loadWorkflowConfig } from "../../lib/load-config.js";
+import { confirmationMatches, executeNuke, formatNukeSummary, involvedTargets, planCounts, refuseOverlappingNuke, renderNukePlan, resolveNukePlan, sweptResources, } from "../../lib/nuke.js";
+import { runWriteVerb } from "../../lib/ops-report.js";
+import { canPromptOnStderr } from "../../lib/prompt.js";
+import { selectDeployment } from "../../lib/select-deployment.js";
 export default class Nuke extends WorkflowCommand {
+    static aliases = ['nuke'];
     static summary = 'Delete every engine-owned document for a deployment tag — the dev-period big red button.';
     static 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).';
     static examples = [
-        '<%= config.bin %> nuke --tag plugin-dev',
+        '<%= config.bin %> nuke --deployment plugin-dev',
         '<%= config.bin %> nuke --tag plugin-dev --force',
     ];
     static flags = {
+        deployment: Flags.string({
+            description: 'The deployment name to reset.',
+            exactlyOne: ['deployment', 'tag'],
+        }),
         tag: Flags.string({
-            description: 'The deployment tag to reset. Required — a destructive reset never guesses the environment.',
-            required: true,
+            description: 'The deployment tag to reset (while it names exactly one deployment).',
+            exactlyOne: ['deployment', 'tag'],
         }),
         force: Flags.boolean({
             description: 'Skip the confirmation prompt (for scripts/CI). The plan still prints.',
@@ -34,7 +39,8 @@ export default class Nuke extends WorkflowCommand {
     async run() {
         const { flags } = await this.parse(Nuke);
         const config = await loadWorkflowConfig();
-        const deployment = selectDeployment(config, { tag: flags.tag });
+        const deployment = selectDeployment(config, { name: flags.deployment, tag: flags.tag });
+        refuseOverlappingNuke(config.deployments, deployment);
         const targets = buildTargets(deployment, await resolveTokenOrFail());
         const plan = await resolveNukePlan({ tag: deployment.tag, targets });
         const apiHost = resolveApiHost() ?? 'https://api.sanity.io (production default)';
@@ -57,12 +63,11 @@ export default class Nuke extends WorkflowCommand {
     }
 }
 function buildTargets(deployment, token) {
-    const engineResource = deployment.workflowResource;
-    const aliasResources = (deployment.resourceAliases ?? []).map((binding) => binding.resource);
-    return dedupeResources([engineResource, ...aliasResources]).map((resource) => ({
+    const engineGdr = resourceGdr(deployment.workflowResource);
+    return dedupeResources(sweptResources(deployment)).map((resource) => ({
         resource,
         client: clientFor(resource, token),
-        holdsEngineDocs: resourceGdr(resource) === resourceGdr(engineResource),
+        holdsEngineDocs: resourceGdr(resource) === engineGdr,
     }));
 }
 async function confirmOrFail(targets) {

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

@@ -1,5 +1,6 @@
-import { StubCommand } from '../lib/stub.ts';
+import { StubCommand } from '../../lib/stub.ts';
 export default class ResetActivity extends StubCommand {
+    static hiddenAliases: string[];
     static hidden: boolean;
     static description: string;
     static args: {

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

@@ -1,6 +1,7 @@
 import { Args } from '@oclif/core';
-import { StubCommand } from "../lib/stub.js";
+import { StubCommand } from "../../lib/stub.js";
 export default class ResetActivity extends StubCommand {
+    static hiddenAliases = ['reset-activity'];
     static hidden = true;
     static description = 'Reset a failed activity on an in-flight instance — back to pending (re-run) or to skipped (bypass).';
     static args = {

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

@@ -1,8 +1,9 @@
 import { type SetStageArgs, type WorkflowInstance } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../lib/base-command.ts';
-import { type EngineScope } from '../lib/operation-args.ts';
-import { type WriteOutcome, type WriteReport } from '../lib/ops-report.ts';
+import { WorkflowCommand } from '../../lib/base-command.ts';
+import { type EngineScope } from '../../lib/operation-args.ts';
+import { type WriteOutcome, type WriteReport } from '../../lib/ops-report.ts';
 export default class SetStage extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {
@@ -11,6 +12,7 @@ export default class SetStage extends WorkflowCommand {
     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>;
+        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/{set-stage.js → editorial-workflows/set-stage.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 { resolveInstanceContext } from "../lib/context.js";
-import { tagFlags } from "../lib/flags.js";
-import { buildOperationArgs } from "../lib/operation-args.js";
-import { cascadeTail, opsAppliedLines, 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 { cascadeTail, opsAppliedLines, runWriteVerb, } from "../../lib/ops-report.js";
 export default class SetStage extends WorkflowCommand {
+    static aliases = ['set-stage'];
     static 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.";
     static examples = [
         '<%= config.bin %> set-stage wf-instance.abc123 --to ready',
@@ -19,7 +20,7 @@ export default class SetStage extends WorkflowCommand {
         }),
     };
     static flags = {
-        ...tagFlags,
+        ...instanceFlags,
         to: Flags.string({
             required: true,
             description: 'Target stage name.',

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

@@ -1,6 +1,7 @@
 import { type WorkflowInstance } from '@sanity/workflow-engine';
-import { WorkflowCommand } from '../lib/base-command.ts';
+import { WorkflowCommand } from '../../lib/base-command.ts';
 export default class Show extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {

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

@@ -2,11 +2,12 @@ import { styleText } from 'node:util';
 import { Args, Flags } from '@oclif/core';
 import { abortReason, displayTitle, terminalState, } from '@sanity/workflow-engine';
 import logSymbols from 'log-symbols';
-import { WorkflowCommand } from "../lib/base-command.js";
-import { findInstance, resolveReadTargets } from "../lib/context.js";
-import { tagFlags } from "../lib/flags.js";
-import { formatKeyValue, formatTimestamp, sectionHeader, activityIcon } from "../lib/ui.js";
+import { WorkflowCommand } from "../../lib/base-command.js";
+import { findInstance, resolveReadTargets } from "../../lib/context.js";
+import { tagFlags } from "../../lib/flags.js";
+import { formatKeyValue, formatTimestamp, sectionHeader, activityIcon } from "../../lib/ui.js";
 export default class Show extends WorkflowCommand {
+    static aliases = ['show'];
     static description = 'Show the state, activities, and effects of a workflow instance.';
     static examples = [
         '<%= config.bin %> show wf-instance.abc123',
@@ -67,27 +68,40 @@ export function instanceHeader(instance) {
     return [title, ...rows].join('\n');
 }
 export function describeInstance(instance, options) {
-    const lines = [sectionHeader('Stages')];
-    for (const stage of instance.stages) {
-        const marker = stage.exitedAt
-            ? styleText('dim', ` (exited ${formatTimestamp(stage.exitedAt)})`)
-            : styleText('cyan', ' (current)');
-        lines.push(`  • ${stage.name}${marker}`);
-        for (const activity of stage.activities ?? []) {
-            lines.push(`      ${activityIcon[activity.status]} ${activity.name}  ${styleText('dim', `[${activity.status}]`)}`);
-        }
-    }
-    if (instance.pendingEffects.length > 0) {
-        lines.push('', sectionHeader('Pending effects'));
-        for (const eff of instance.pendingEffects) {
-            lines.push(`  • ${eff.name}  ${styleText('dim', `(key=${eff._key})`)}`);
-        }
-    }
-    if (options.includeHistory) {
-        lines.push('', sectionHeader('History'));
-        for (const entry of instance.history) {
-            lines.push(`  ${styleText('dim', `[${formatTimestamp(entry.at)}]`)} ${displayTitle(entry._type)}`);
-        }
+    return [
+        ...stageLines(instance),
+        ...pendingEffectLines(instance),
+        ...(options.includeHistory ? historyLines(instance) : []),
+    ];
+}
+function stageLines(instance) {
+    return [
+        sectionHeader('Stages'),
+        ...instance.stages.flatMap((stage) => [
+            `  • ${stage.name}${stageMarker(stage)}`,
+            ...(stage.activities ?? []).map((activity) => `      ${activityIcon[activity.status]} ${activity.name}  ${styleText('dim', `[${activity.status}]`)}`),
+        ]),
+    ];
+}
+function stageMarker(stage) {
+    return stage.exitedAt
+        ? styleText('dim', ` (exited ${formatTimestamp(stage.exitedAt)})`)
+        : styleText('cyan', ' (current)');
+}
+function pendingEffectLines(instance) {
+    if (instance.pendingEffects.length === 0) {
+        return [];
     }
-    return lines;
+    return [
+        '',
+        sectionHeader('Pending effects'),
+        ...instance.pendingEffects.map((eff) => `  • ${eff.name}  ${styleText('dim', `(key=${eff._key})`)}`),
+    ];
+}
+function historyLines(instance) {
+    return [
+        '',
+        sectionHeader('History'),
+        ...instance.history.map((entry) => `  ${styleText('dim', `[${formatTimestamp(entry.at)}]`)} ${displayTitle(entry._type)}`),
+    ];
 }

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

@@ -1,7 +1,8 @@
 import { StartNotSettledError, type InitialFieldValue, type StartInstanceArgs, type WorkflowInstance } 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 Start extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {
@@ -12,6 +13,7 @@ export default class Start extends WorkflowCommand {
         version: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
         field: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
         'instance-id': 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/{start.js → editorial-workflows/start.js}

@@ -1,15 +1,16 @@
 import { styleText } from 'node:util';
 import { Args, Flags } from '@oclif/core';
 import { buildInitialFields, errorMessage, StartNotPrimedError, StartNotSettledError, startRefusal, workflow, } from '@sanity/workflow-engine';
-import { WorkflowCommand } from "../lib/base-command.js";
-import { resolveContext } from "../lib/context.js";
-import { fetchDeployedDefinition } from "../lib/definitions.js";
-import { fail, failOnThrow, failureDetail } from "../lib/fail.js";
-import { jsonFlags, tagFlags } from "../lib/flags.js";
-import { baseEngineArgs } from "../lib/operation-args.js";
-import { runWriteVerb } from "../lib/ops-report.js";
-import { parseParams } from "../lib/params.js";
+import { WorkflowCommand } from "../../lib/base-command.js";
+import { resolveContext } from "../../lib/context.js";
+import { fetchDeployedDefinition } from "../../lib/definitions.js";
+import { fail, failOnThrow, failureDetail } from "../../lib/fail.js";
+import { deploymentFlags, jsonFlags } from "../../lib/flags.js";
+import { baseEngineArgs } from "../../lib/operation-args.js";
+import { runWriteVerb } from "../../lib/ops-report.js";
+import { parseParams } from "../../lib/params.js";
 export default class Start extends WorkflowCommand {
+    static aliases = ['start'];
     static 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).";
     static examples = [
@@ -22,7 +23,7 @@ export default class Start extends WorkflowCommand {
         name: Args.string({ required: true, description: 'Workflow definition name.' }),
     };
     static flags = {
-        ...tagFlags,
+        ...deploymentFlags,
         version: Flags.integer({
             description: 'Definition version to start from (default: highest deployed).',
         }),

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

@@ -1,5 +1,6 @@
-import { WorkflowCommand } from '../lib/base-command.ts';
+import { WorkflowCommand } from '../../lib/base-command.ts';
 export default class Tail extends WorkflowCommand {
+    static aliases: string[];
     static description: string;
     static examples: string[];
     static args: {