@openworkflow/cli 0.4.2 → 0.4.3

package/dist/cli.js

@@ -35,6 +35,7 @@ workerCmd
 program
     .command("dashboard")
     .description("start the dashboard to view workflow runs")
+    .option("-p, --port <number>", "custom port for the dashboard server", Number.parseInt)
     .option("--config <path>", "path to OpenWorkflow config file")
     .action(withErrorHandling(dashboard));
 await program.parseAsync(process.argv);

package/dist/commands.d.ts

@@ -2,6 +2,9 @@ import { WorkerConfig } from "./config.js";
 interface CommandOptions {
     config?: string;
 }
+interface DashboardOptions extends CommandOptions {
+    port?: number;
+}
 /**
  * openworkflow -V | --version
  * @returns the version string, or "-" if it cannot be determined
@@ -26,9 +29,30 @@ export declare function workerStart(options?: WorkerStartOptions): Promise<void>
 /**
  * openworkflow dashboard
  * Starts the dashboard by delegating to `@openworkflow/dashboard` via npx.
- * @param options - Command options
+ * @param port - Optional dashboard port.
+ * @returns Spawn configuration for launching the dashboard process.
+ */
+export declare function getDashboardSpawnOptions(port?: number): {
+    command: string;
+    args: string[];
+    spawnOptions: {
+        stdio: "inherit";
+        env?: NodeJS.ProcessEnv;
+    };
+};
+/**
+ * Validate dashboard port option.
+ * @param port - Optional dashboard port.
+ * @returns Validated dashboard port.
+ * @throws {CLIError} If the provided port is not an integer in the 1-65535 range.
+ */
+export declare function validateDashboardPort(port?: number): number | undefined;
+/**
+ * Start the dashboard process.
+ * @param options - Dashboard command options.
+ * @returns Resolves when the dashboard process exits.
  */
-export declare function dashboard(options?: CommandOptions): Promise<void>;
+export declare function dashboard(options?: DashboardOptions): Promise<void>;
 /**
  * Discover workflow files from directories. Recursively scans directories for
  * workflow files with supported extensions (.ts, .js, .mjs, .cjs).

package/dist/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAkC,MAAM,aAAa,CAAC;AAiC3E,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAoBnC;AAED;;;GAGG;AACH,wBAAsB,IAAI,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoItE;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmDxE;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,cAAc,CAAC;AAE/D;;;GAGG;AACH,wBAAsB,WAAW,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAuEf;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2D3E;AAwOD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CA4CV;AAiWD,UAAU,oBAAoB;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAsBD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAMR;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAkC,MAAM,aAAa,CAAC;AAiC3E,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,gBAAiB,SAAQ,cAAc;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAoBnC;AAED;;;GAGG;AACH,wBAAsB,IAAI,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoItE;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmDxE;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,cAAc,CAAC;AAE/D;;;GAGG;AACH,wBAAsB,WAAW,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAuEf;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,YAAY,EAAE;QACZ,KAAK,EAAE,SAAS,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;KACzB,CAAC;CACH,CAYA;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAavE;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CA8D7E;AAwOD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CA4CV;AAiWD,UAAU,oBAAoB;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAsBD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAMR;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAKR"}

package/dist/commands.js

@@ -247,20 +247,52 @@ export async function workerStart(options = {}) {
 /**
  * openworkflow dashboard
  * Starts the dashboard by delegating to `@openworkflow/dashboard` via npx.
- * @param options - Command options
+ * @param port - Optional dashboard port.
+ * @returns Spawn configuration for launching the dashboard process.
+ */
+export function getDashboardSpawnOptions(port) {
+    return {
+        command: "npx",
+        args: ["@openworkflow/dashboard"],
+        spawnOptions: {
+            stdio: "inherit",
+            env: port === undefined
+                ? process.env
+                : { ...process.env, PORT: String(port) },
+        },
+    };
+}
+/**
+ * Validate dashboard port option.
+ * @param port - Optional dashboard port.
+ * @returns Validated dashboard port.
+ * @throws {CLIError} If the provided port is not an integer in the 1-65535 range.
+ */
+export function validateDashboardPort(port) {
+    if (port === undefined) {
+        return undefined;
+    }
+    if (!Number.isInteger(port) || port < 1 || port > 65_535) {
+        throw new CLIError("Invalid dashboard port.", "Use an integer between 1 and 65535, for example `--port 3001`.");
+    }
+    return port;
+}
+/**
+ * Start the dashboard process.
+ * @param options - Dashboard command options.
+ * @returns Resolves when the dashboard process exits.
  */
 export async function dashboard(options = {}) {
     const configPath = options.config;
+    const port = validateDashboardPort(options.port);
     consola.start("Starting dashboard...");
     const { configFile } = await loadConfigWithEnv(configPath);
     if (!configFile) {
         throw new CLIError("No config file found.", "Run `npx @openworkflow/cli init` to create a config file before starting the dashboard.");
     }
     consola.info(`Using config: ${configFile}`);
-    // eslint-disable-next-line sonarjs/no-os-command-from-path
-    const child = spawn("npx", ["@openworkflow/dashboard"], {
-        stdio: "inherit",
-    });
+    const spawnConfig = getDashboardSpawnOptions(port);
+    const child = spawn(spawnConfig.command, spawnConfig.args, spawnConfig.spawnOptions);
     await new Promise((resolve, reject) => {
         /** remove signal handlers after the child exits */
         function cleanupSignalHandlers() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openworkflow/cli",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "type": "module",
   "exports": {
     ".": {