@openworkflow/cli 0.5.0 → 0.5.1

package/dist/cli.js

@@ -2,14 +2,18 @@
 /* v8 ignore file -- @preserve */
 import { dashboard, doctor, getVersion, init, workerStart, } from "./commands.js";
 import { withErrorHandling } from "./errors.js";
-import { Command, Option } from "commander";
+import { initializeTelemetry, shutdownTelemetry, trackCommand, } from "./telemetry.js";
+import { Command, CommanderError, Option } from "commander";
 // openworkflow
 const program = new Command();
+initializeTelemetry(program);
 program
     .name("openworkflow")
     .description("OpenWorkflow CLI - learn more at https://openworkflow.dev")
     .usage("<command> [options]")
-    .version(getVersion());
+    .exitOverride()
+    .version(getVersion())
+    .option("--no-telemetry", "disable telemetry");
 // init
 program
     .command("init")
@@ -49,4 +53,15 @@ program
     .option("--config <path>", "path to OpenWorkflow config file")
     .option("--env-file <path>", "load environment variables from file")
     .action(withErrorHandling(dashboard));
-await program.parseAsync(process.argv);
+try {
+    await program.parseAsync(process.argv);
+}
+catch (error) {
+    if (!(error instanceof CommanderError))
+        throw error;
+    process.exitCode = error.exitCode;
+    trackCommand();
+}
+finally {
+    await shutdownTelemetry();
+}

package/dist/commands.d.ts

@@ -20,6 +20,7 @@ export declare function getVersion(): string;
 /**
  * openworkflow init
  * @param options - Command options
+ * @returns Resolves when setup finishes.
  */
 export declare function init(options?: InitOptions): Promise<void>;
 /**

package/dist/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../commands.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAIb,MAAM,aAAa,CAAC;AAwCrB,KAAK,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;AAEpD,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,WAAY,SAAQ,cAAc;IAC1C,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,UAAU,gBAAiB,SAAQ,cAAc;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAoBnC;AAED;;;GAGG;AAEH,wBAAsB,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAqJnE;AA8BD;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2DxE;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,CA8Ef;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,CA6D7E;AA4PD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CA8CV;AA2WD,UAAU,oBAAoB;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAoCD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../commands.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAIb,MAAM,aAAa,CAAC;AAyCrB,KAAK,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;AAEpD,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,WAAY,SAAQ,cAAc;IAC1C,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,UAAU,gBAAiB,SAAQ,cAAc;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAoBnC;AAED;;;;GAIG;AAEH,wBAAsB,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAsJnE;AA8BD;;;GAGG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2DxE;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,CA8Ef;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,CA6D7E;AA4PD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE,CA8CV;AA+WD,UAAU,oBAAoB;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAoCD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,IAAI,GACjD,MAAM,CAER"}

package/dist/commands.js

@@ -1,6 +1,7 @@
 import { findConfigFile, loadConfigFromPath, } from "./config.js";
 import { CLIError, exit } from "./errors.js";
 import { createModuleLoader } from "./module-loader.js";
+import { trackCommand } from "./telemetry.js";
 import { CONFIG, HELLO_WORLD_RUNNER, HELLO_WORLD_WORKFLOW, POSTGRES_CLIENT, POSTGRES_PROD_SQLITE_DEV_CLIENT, SQLITE_CLIENT, } from "./templates.js";
 import * as p from "@clack/prompts";
 import { consola } from "consola";
@@ -40,6 +41,7 @@ export function getVersion() {
 /**
  * openworkflow init
  * @param options - Command options
+ * @returns Resolves when setup finishes.
  */
 // oxlint-disable-next-line complexity
 export async function init(options = {}) {
@@ -61,7 +63,7 @@ export async function init(options = {}) {
             initialValue: false,
         });
         if (!shouldOverride || p.isCancel(shouldOverride))
-            cancelSetup();
+            return cancelSetup();
         configFileToDelete = configFile;
     }
     const backendChoice = options.backend ??
@@ -87,7 +89,8 @@ export async function init(options = {}) {
             initialValue: "sqlite",
         }));
     if (typeof backendChoice === "symbol")
-        cancelSetup();
+        return cancelSetup();
+    trackCommand(backendChoice);
     const spinner = p.spinner();
     // detect package manager & install packages
     spinner.start("Detecting package manager...");
@@ -114,7 +117,7 @@ export async function init(options = {}) {
             initialValue: true,
         }));
     if (p.isCancel(shouldSetup))
-        cancelSetup();
+        return cancelSetup();
     if (!shouldSetup) {
         p.outro("Setup skipped.");
         return;
@@ -380,11 +383,11 @@ export async function dashboard(options = {}) {
 // -----------------------------------------------------------------------------
 /**
  * Show a canceled-setup message and exit the process with status 0.
+ * @returns Never resolves because the process exits.
  */
 function cancelSetup() {
     p.cancel("Setup canceled.");
-    // oxlint-disable-next-line unicorn/no-process-exit
-    process.exit(0);
+    return exit(0);
 }
 /**
  * Exercise backend initialization, connectivity, and workflow table access.
@@ -861,7 +864,9 @@ function findConfigWithEnv(options) {
 async function loadConfigWithEnv(options) {
     const configPath = findConfigWithEnv(options);
     try {
-        return await loadConfigFromPath(configPath ?? "openworkflow.config.ts");
+        const loaded = await loadConfigFromPath(configPath ?? "openworkflow.config.ts");
+        trackCommand(loaded.config.backend);
+        return loaded;
     }
     catch (error) {
         const message = error instanceof Error ? error.message : String(error);

package/dist/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../errors.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAExB,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAK7C;AAED;;;GAGG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAWvD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,EACnD,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GACvC,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAiB/B"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../errors.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAExB,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAK7C;AAED;;;GAGG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAYvD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,EACnD,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GACvC,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAiB/B"}

package/dist/errors.js

@@ -1,4 +1,5 @@
 /* v8 ignore file -- @preserve */
+import { shutdownTelemetry } from "./telemetry.js";
 import { consola } from "consola";
 /**
  * User-facing CLI error.
@@ -16,6 +17,7 @@ export class CLIError extends Error {
  * @param code - Process exit code
  */
 export async function exit(code) {
+    await shutdownTelemetry();
     await Promise.all([process.stdout, process.stderr].map((stream) => new Promise((resolve) => {
         stream.end(resolve);
     })));

package/dist/telemetry.d.ts

@@ -0,0 +1,16 @@
+import type { Command } from "commander";
+import type { Backend } from "openworkflow/internal";
+/**
+ * Set up telemetry before the CLI prints output.
+ * @param program - Root CLI command
+ */
+export declare function initializeTelemetry(program: Command): void;
+/**
+ * Track after loading config or choosing an init backend.
+ * Help, version, and argument errors are tracked without a backend.
+ * @param backend - Configured backend or init selection
+ */
+export declare function trackCommand(backend?: Backend | "sqlite" | "postgres" | "both"): void;
+/** Send queued events before the CLI exits. */
+export declare function shutdownTelemetry(): Promise<void>;
+//# sourceMappingURL=telemetry.d.ts.map

package/dist/telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAoBrD;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAsC1D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GACjD,IAAI,CAoCN;AAED,+CAA+C;AAC/C,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAMvD"}

package/dist/telemetry.js

@@ -0,0 +1,101 @@
+import { randomUUID } from "node:crypto";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { homedir } from "node:os";
+import path from "node:path";
+import { PostHog } from "posthog-node";
+let telemetry;
+const backendTypes = new Map([
+    ["BackendSqlite", "sqlite"],
+    ["BackendPostgres", "postgres"],
+    ["sqlite", "sqlite"],
+    ["postgres", "postgres"],
+    ["both", "both"],
+]);
+/**
+ * Set up telemetry before the CLI prints output.
+ * @param program - Root CLI command
+ */
+export function initializeTelemetry(program) {
+    telemetry = undefined;
+    if (process.env["DO_NOT_TRACK"] ||
+        process.env["OPENWORKFLOW_TELEMETRY_DISABLED"] ||
+        process.env["CI"] ||
+        process.argv.includes("--no-telemetry"))
+        return;
+    try {
+        const directory = path.join(homedir(), ".openworkflow");
+        const file = path.join(directory, "telemetry-id");
+        mkdirSync(directory, { recursive: true });
+        if (!existsSync(file)) {
+            writeFileSync(file, randomUUID(), { flag: "wx", mode: 0o600 });
+            console.error("OpenWorkflow collects CLI usage via PostHog. Set DO_NOT_TRACK=1 to opt out.\n" +
+                "https://openworkflow.dev/docs/cli#telemetry\n");
+        }
+        const distinctId = readFileSync(file, "utf8").trim();
+        if (!distinctId)
+            return;
+        const state = {
+            program,
+            distinctId,
+            client: new PostHog("phc_C1Cm1NAKHDFA3eKLVqcYzR5wUk8WhSbMMXltk5Qj1Ye"),
+        };
+        program.on("beforeAllHelp", ({ command }) => {
+            state.helpCommand = command;
+        });
+        program.on("option:version", () => {
+            state.version = true;
+        });
+        telemetry = state;
+    }
+    catch {
+        // ignore, telemetry is optional
+    }
+}
+/**
+ * Track after loading config or choosing an init backend.
+ * Help, version, and argument errors are tracked without a backend.
+ * @param backend - Configured backend or init selection
+ */
+export function trackCommand(backend) {
+    const state = telemetry;
+    if (!state)
+        return;
+    try {
+        let command = state.helpCommand ?? state.program;
+        let child;
+        while ((child = command.commands.find((candidate) => candidate.name() === command.args[0]))) {
+            command = child;
+        }
+        const backendName = typeof backend === "string" ? backend : backend?.constructor.name;
+        const commandName = command.parent?.parent
+            ? `${command.parent.name()} ${command.name()}`
+            : command.name();
+        state.client.capture({
+            distinctId: state.distinctId,
+            event: "cli_command_invoked",
+            properties: {
+                command: state.version ? "version" : commandName,
+                backend: backendName
+                    ? (backendTypes.get(backendName) ?? "custom")
+                    : undefined,
+                help: state.helpCommand ? true : undefined,
+                cli_version: state.program.version(),
+                os: process.platform,
+                arch: process.arch,
+                node_version: process.versions.node,
+            },
+        });
+    }
+    catch {
+        // ignore, telemetry is optional
+    }
+}
+/** Send queued events before the CLI exits. */
+export async function shutdownTelemetry() {
+    try {
+        await telemetry?.client.shutdown();
+    }
+    catch {
+        // ignore, telemetry is optional
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openworkflow/cli",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "type": "module",
   "exports": {
     ".": {
@@ -32,7 +32,8 @@
     "consola": "^3.4.2",
     "dotenv": "^17.4.2",
     "jiti": "^2.7.0",
-    "nypm": "^0.6.10"
+    "nypm": "^0.6.10",
+    "posthog-node": "~5.21.2"
   },
   "devDependencies": {
     "openworkflow": "*",