@sfship/plugin-ship 1.0.0-beta.2

package/LICENSE.txt

@@ -0,0 +1,206 @@
+Apache License Version 2.0
+
+Copyright (c) 2026 Salesforce, Inc.
+All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,164 @@
+# plugin-ship
+
+[![NPM](https://img.shields.io/npm/v/plugin-ship.svg?label=plugin-ship)](https://www.npmjs.com/package/plugin-ship) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
+
+A Salesforce CLI plugin for managing the full development and release lifecycle of second-generation managed and unlocked packages.
+
+Flows and tasks are defined in a `ship.yml` config file. Flows are sequences of tasks that can pass data between steps. Tasks can also be run individually outside of a flow.
+
+## Install
+
+```bash
+sf plugins install plugin-ship
+```
+
+## Setup
+
+Connect your GitHub account before using tasks that interact with GitHub:
+
+```bash
+sf ship service connect github
+```
+
+## Commands
+
+- [`sf ship flow list`](#sf-ship-flow-list)
+- [`sf ship flow info <name>`](#sf-ship-flow-info)
+- [`sf ship flow run <name>`](#sf-ship-flow-run)
+- [`sf ship task list`](#sf-ship-task-list)
+- [`sf ship task info <name>`](#sf-ship-task-info)
+- [`sf ship task run <name>`](#sf-ship-task-run)
+- [`sf ship service connect github`](#sf-ship-service-connect-github)
+
+---
+
+### `sf ship flow list`
+
+Lists all flows defined in `ship.yml`.
+
+```
+USAGE
+  $ sf ship flow list [--config <value>]
+
+FLAGS
+  --config=<value>  [default: ship.yml] Path to the ship config file.
+```
+
+### `sf ship flow info`
+
+Shows description, params, and steps for a flow.
+
+```
+USAGE
+  $ sf ship flow info <name> [--config <value>]
+
+ARGUMENTS
+  NAME  Name of the flow.
+
+FLAGS
+  --config=<value>  [default: ship.yml] Path to the ship config file.
+```
+
+### `sf ship flow run`
+
+Runs a named flow defined in `ship.yml`.
+
+```
+USAGE
+  $ sf ship flow run <name> [--config <value>] [--param <value>...]
+
+ARGUMENTS
+  NAME  Name of the flow to run.
+
+FLAGS
+  --config=<value>  [default: ship.yml] Path to the ship config file.
+  --param=<value>   Flow param in key=value format. May be specified multiple times.
+
+EXAMPLES
+  $ sf ship flow run release --param version=1.2.0
+```
+
+### `sf ship task list`
+
+Lists all available tasks — built-in and any custom tasks in `.ship/tasks/`.
+
+```
+USAGE
+  $ sf ship task list [--config <value>]
+
+FLAGS
+  --config=<value>  [default: ship.yml] Path to the ship config file.
+```
+
+### `sf ship task info`
+
+Shows description and param schema for a task.
+
+```
+USAGE
+  $ sf ship task info <name> [--config <value>]
+
+ARGUMENTS
+  NAME  Name of the task.
+
+FLAGS
+  --config=<value>  [default: ship.yml] Path to the ship config file.
+```
+
+### `sf ship task run`
+
+Runs a single task directly, outside of a flow.
+
+```
+USAGE
+  $ sf ship task run <name> [--config <value>] [--param <value>...]
+
+ARGUMENTS
+  NAME  Name of the task to run.
+
+FLAGS
+  --config=<value>  [default: ship.yml] Path to the ship config file.
+  --param=<value>   Task param in key=value format. May be specified multiple times.
+
+EXAMPLES
+  $ sf ship task run deploy-metadata --param targetOrg=myOrg
+```
+
+### `sf ship service connect github`
+
+Connects a GitHub account via OAuth device flow.
+
+```
+USAGE
+  $ sf ship service connect github [--alias <value>]
+
+FLAGS
+  --alias=<value>  [default: default] Alias to store the connection under.
+```
+
+## Local Development
+
+```bash
+# Install dependencies and compile
+yarn && yarn build
+
+# Link to the SF CLI for local testing
+sf plugins link .
+```
+
+### Commit Types
+
+When making a commit, the format `{type}: my lowercase message` is enforced.
+
+| Type       | Description                                    |
+| ---------- | ---------------------------------------------- |
+| `feat`     | New feature                                    |
+| `fix`      | Bug fix                                        |
+| `chore`    | Maintenance (deps, config, tooling)            |
+| `refactor` | Code change that's neither a fix nor a feature |
+| `test`     | Adding or updating tests                       |
+| `docs`     | Documentation only                             |
+| `ci`       | CI/CD config changes                           |
+| `build`    | Changes to the build system                    |
+| `perf`     | Performance improvement                        |
+| `style`    | Formatting, whitespace (no logic change)       |

package/lib/commands/ship/flow/eject.d.ts

@@ -0,0 +1,15 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+/** Copies a built-in flow into the project for customization. */
+export default class FlowEject extends SfCommand<void> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly args: {
+        flowName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static readonly flags: {
+        config: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static readonly enableJsonFlag = false;
+    run(): Promise<void>;
+}

package/lib/commands/ship/flow/eject.js

@@ -0,0 +1,55 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { existsSync, copyFileSync, mkdirSync } from 'node:fs';
+import { dirname, join, relative } from 'node:path';
+import { Args } from '@oclif/core';
+import { SfCommand, Flags, StandardColors } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { loadConfig, resolveProjectPaths } from '../../../core/config.loader.js';
+import { FlowRegistry, builtinsDir } from '../../../core/flow.registry.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@sfship/plugin-ship', 'ship.flow.eject');
+/** Copies a built-in flow into the project for customization. */
+export default class FlowEject extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static args = {
+        flowName: Args.string({ description: messages.getMessage('args.flowName.summary'), required: true }),
+    };
+    static flags = {
+        config: Flags.file({ default: 'ship.yml', summary: messages.getMessage('flags.config.summary') }),
+    };
+    static enableJsonFlag = false;
+    async run() {
+        const { args, flags } = await this.parse(FlowEject);
+        this.log('');
+        this.styledHeader('Flow Eject');
+        const config = loadConfig(flags.config);
+        const { shipDir } = resolveProjectPaths(flags.config, config);
+        const src = new FlowRegistry(shipDir).builtinSource(args.flowName);
+        if (!src) {
+            this.error(`"${args.flowName}" is not a built-in flow.`, { exit: 1 });
+        }
+        const dest = join(shipDir, 'flows', relative(builtinsDir, src));
+        if (existsSync(dest)) {
+            this.error(`${dest} already exists. Remove it first if you want to re-eject.`, { exit: 1 });
+        }
+        mkdirSync(dirname(dest), { recursive: true });
+        copyFileSync(src, dest);
+        this.log(StandardColors.success('✓') + ` Ejected flow to: ${dest}`);
+        this.log('');
+    }
+}
+//# sourceMappingURL=eject.js.map

package/lib/commands/ship/flow/eject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eject.js","sourceRoot":"","sources":["../../../../src/commands/ship/flow/eject.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAE3E,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,CAAC;AAEjF,iEAAiE;AACjE,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,SAAe;IAC7C,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,IAAI,GAAG;QAC5B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;KACrG,CAAC;IAEK,MAAM,CAAU,KAAK,GAAG;QAC7B,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;KAClG,CAAC;IAEK,MAAM,CAAU,cAAc,GAAG,KAAK,CAAC;IAEvC,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEpD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACb,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAEhC,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE9D,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnE,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,2BAA2B,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;QAChE,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,2DAA2D,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9F,CAAC;QAED,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,qBAAqB,IAAI,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACf,CAAC"}

package/lib/commands/ship/flow/info.d.ts

@@ -0,0 +1,15 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+/** Shows description, params, and steps for a flow. */
+export default class FlowInfo extends SfCommand<void> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly args: {
+        flowName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static readonly flags: {
+        config: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static readonly enableJsonFlag = false;
+    run(): Promise<void>;
+}

package/lib/commands/ship/flow/info.js

@@ -0,0 +1,86 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Args } from '@oclif/core';
+import { SfCommand, Flags, Ux, StandardColors } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { loadConfig, resolveProjectPaths } from '../../../core/config.loader.js';
+import { FlowRegistry } from '../../../core/flow.registry.js';
+import { asError } from '../../../core/error.js';
+import { formatFlowPreview } from '../../../core/flow.view.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@sfship/plugin-ship', 'ship.flow.info');
+/** Shows description, params, and steps for a flow. */
+export default class FlowInfo extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static args = {
+        flowName: Args.string({ description: messages.getMessage('args.flowName.summary'), required: true }),
+    };
+    static flags = {
+        config: Flags.file({ default: 'ship.yml', summary: messages.getMessage('flags.config.summary') }),
+    };
+    static enableJsonFlag = false;
+    async run() {
+        const { args, flags } = await this.parse(FlowInfo);
+        this.log('');
+        this.styledHeader('Flow Info');
+        const config = loadConfig(flags.config);
+        const { shipDir } = resolveProjectPaths(flags.config, config);
+        const registry = new FlowRegistry(shipDir);
+        let flow;
+        try {
+            flow = registry.resolveFlow(args.flowName);
+        }
+        catch (err) {
+            this.error(asError(err).message, { exit: 1 });
+        }
+        const ux = new Ux();
+        this.log(formatFlowPreview(args.flowName, flow.description));
+        this.log('');
+        if (flow.params && flow.params.length > 0) {
+            this.styledHeader('Params');
+            ux.table({
+                data: flow.params.map((p) => ({
+                    name: p.name,
+                    type: p.type,
+                    required: p.required ? 'yes' : 'no',
+                    default: p.default ?? '—',
+                    description: p.description ?? '—',
+                })),
+            });
+        }
+        this.styledHeader('Flow Steps');
+        ux.table({
+            data: Object.entries(flow.steps).map(([stepId, step], index) => ({
+                '#': index + 1,
+                id: stepId,
+                task: step.task,
+                params: step.params
+                    ? Object.entries(step.params)
+                        .map(([k, v]) => `${k}=${String(v)}`)
+                        .join(', ')
+                    : '—',
+            })),
+        });
+        const requiredParams = (flow.params ?? [])
+            .filter((p) => p.required)
+            .map((p) => `--param ${p.name}=<${p.name}>`)
+            .join(' ');
+        const exampleCmd = [`sf ship flow run ${args.flowName}`, requiredParams].filter(Boolean).join(' ');
+        this.log(StandardColors.info('Tip:') + ' Run ' + StandardColors.success(exampleCmd) + ' to execute this flow.');
+        this.log('');
+    }
+}
+//# sourceMappingURL=info.js.map

package/lib/commands/ship/flow/info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"info.js","sourceRoot":"","sources":["../../../../src/commands/ship/flow/info.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AACnF,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;AAEhF,uDAAuD;AACvD,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,SAAe;IAC5C,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,IAAI,GAAG;QAC5B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;KACrG,CAAC;IAEK,MAAM,CAAU,KAAK,GAAG;QAC7B,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;KAClG,CAAC;IAEK,MAAM,CAAU,cAAc,GAAG,KAAK,CAAC;IAEvC,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEnD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACb,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAE/B,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,IAAI,CAAC;QACT,IAAI,CAAC;YACH,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;QACpB,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEb,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC5B,EAAE,CAAC,KAAK,CAAC;gBACP,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC5B,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;oBACnC,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,GAAG;oBACzB,WAAW,EAAE,CAAC,CAAC,WAAW,IAAI,GAAG;iBAClC,CAAC,CAAC;aACJ,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAChC,EAAE,CAAC,KAAK,CAAC;YACP,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC/D,GAAG,EAAE,KAAK,GAAG,CAAC;gBACd,EAAE,EAAE,MAAM;gBACV,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,IAAI,CAAC,MAAM;oBACjB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;yBACxB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;yBACpC,IAAI,CAAC,IAAI,CAAC;oBACf,CAAC,CAAC,GAAG;aACR,CAAC,CAAC;SACJ,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;aACvC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACzB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC;aAC3C,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,MAAM,UAAU,GAAG,CAAC,oBAAoB,IAAI,CAAC,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,wBAAwB,CAAC,CAAC;QAChH,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACf,CAAC"}

package/lib/commands/ship/flow/list.d.ts

@@ -0,0 +1,12 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+/** Lists all flows defined in ship.yml. */
+export default class FlowList extends SfCommand<void> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        config: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static readonly enableJsonFlag = false;
+    run(): Promise<void>;
+}

package/lib/commands/ship/flow/list.js

@@ -0,0 +1,51 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SfCommand, Flags, StandardColors } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { loadConfig, resolveProjectPaths } from '../../../core/config.loader.js';
+import { FlowRegistry } from '../../../core/flow.registry.js';
+import { renderTree } from '../../../core/tree.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@sfship/plugin-ship', 'ship.flow.list');
+/** Lists all flows defined in ship.yml. */
+export default class FlowList extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        config: Flags.file({ default: 'ship.yml', summary: messages.getMessage('flags.config.summary') }),
+    };
+    static enableJsonFlag = false;
+    async run() {
+        const { flags } = await this.parse(FlowList);
+        const config = loadConfig(flags.config);
+        const { shipDir } = resolveProjectPaths(flags.config, config);
+        const registry = new FlowRegistry(shipDir);
+        const names = registry.list();
+        this.log('');
+        this.styledHeader('Flow List');
+        if (names.length === 0) {
+            this.log('No flows available.');
+            return;
+        }
+        this.log(renderTree(names));
+        this.log('');
+        this.log(StandardColors.info('Tip:') +
+            ' Run ' +
+            StandardColors.success('sf ship flow info <path>') +
+            ' to see full details for a flow.');
+        this.log('');
+    }
+}
+//# sourceMappingURL=list.js.map

package/lib/commands/ship/flow/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../src/commands/ship/flow/list.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;AAEhF,2CAA2C;AAC3C,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,SAAe;IAC5C,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;KAClG,CAAC;IAEK,MAAM,CAAU,cAAc,GAAG,KAAK,CAAC;IAEvC,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAE9B,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACb,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAE/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAChC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACb,IAAI,CAAC,GAAG,CACN,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC;YACzB,OAAO;YACP,cAAc,CAAC,OAAO,CAAC,0BAA0B,CAAC;YAClD,kCAAkC,CACrC,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACf,CAAC"}

package/lib/commands/ship/flow/run.d.ts

@@ -0,0 +1,16 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+/** Executes a built-in flow or one defined in `ship.yml`. */
+export default class FlowRun extends SfCommand<void> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly args: {
+        flowName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static readonly flags: {
+        config: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        param: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static readonly enableJsonFlag = false;
+    run(): Promise<void>;
+}