@dataworks-technology/cli 1.1.0 → 1.3.0

package/.agents/plugins/marketplace.json

@@ -0,0 +1,20 @@
+{
+  "name": "dataworks-cli",
+  "interface": {
+    "displayName": "Dataworks CLI"
+  },
+  "plugins": [
+    {
+      "name": "dataworks",
+      "source": {
+        "source": "local",
+        "path": "./plugins/dataworks"
+      },
+      "policy": {
+        "installation": "AVAILABLE",
+        "authentication": "ON_INSTALL"
+      },
+      "category": "Data"
+    }
+  ]
+}

package/.claude-plugin/marketplace.json

@@ -0,0 +1,16 @@
+{
+  "name": "dataworks-cli",
+  "owner": {
+    "name": "Dataworks Technology"
+  },
+  "metadata": {
+    "description": "Official Dataworks CLI integrations for Claude Code"
+  },
+  "plugins": [
+    {
+      "name": "dataworks",
+      "source": "./plugins/dataworks",
+      "description": "Query Dataworks athlete metrics using the authenticated local CLI session"
+    }
+  ]
+}

package/README.md

@@ -22,14 +22,16 @@ The `dw` binary turns the public GraphQL contract published by `@dataworks-techn
 
 | Command               | Description                                                 |
 | --------------------- | ----------------------------------------------------------- |
+| `dw agents install`   | Install the Dataworks skill and MCP tools for AI agents     |
 | `dw auth ...`         | Log in, log out, and inspect the active UAT or Live session |
+| `dw autocomplete`     | Install shell completion for commands and flags             |
 | `dw data ...`         | Run schema-derived queries, mutations, and subscriptions    |
 | `dw ingest`           | Send athlete metrics to the Data Engine ingest endpoint     |
 | `dw events subscribe` | Subscribe to AppSync Events channels                        |
 | `dw graphql ...`      | Run raw GraphQL queries, mutations, and subscriptions       |
 | `dw report-error`     | Report a datasource error                                   |
-| `dw tenant select`    | Select the tenant used by subsequent commands               |
-| `dw commands`         | Print the complete machine-readable command inventory       |
+| `dw tenant ...`       | List or select the tenant used by subsequent commands       |
+| `dw commands`         | Print the complete command inventory                        |
 
 ---
 
@@ -41,7 +43,7 @@ The `dw` binary turns the public GraphQL contract published by `@dataworks-techn
 
 ---
 
-## Getting Started
+## Quickstart
 
 1. **Install the CLI:**
 
@@ -54,7 +56,7 @@ The `dw` binary turns the public GraphQL contract published by `@dataworks-techn
 
    ```sh
    dw auth login --environment uat
-   dw auth status --json
+   dw auth status
    ```
 
    The CLI opens Dataworks Managed Login in your browser and never receives your password. Sessions are stored in the operating-system credential store, never in the Dataworks config file. If a browser cannot be opened automatically, pass `--no-browser` and visit the displayed URL on the same computer. Headless jobs can provide a protected `DW_SESSION_JSON` secret instead.
@@ -63,33 +65,116 @@ The `dw` binary turns the public GraphQL contract published by `@dataworks-techn
    `--client-id`, `DW_UAT_CLIENT_ID`, `DW_LIVE_CLIENT_ID`, or `DW_CLIENT_ID` when
    testing a different app client.
 
-3. **Select a tenant.** Run the command without an ID to choose interactively, or
-   pass an ID for noninteractive use. The selection is saved to your local profile.
+3. **List and select a tenant.** The selection is saved to your local profile
+   and used by subsequent commands.
 
    ```bash
+   dw tenant list
    dw tenant select
    dw tenant select tenant-123
    ```
 
-   Use `dw tenant select --json` to list the available tenant IDs and friendly
-   names without opening an interactive prompt.
+   `dw tenant list` shows the friendly name, ID, and current selection. Agents
+   and scripts should use `dw tenant list --json`.
 
 4. **Discover and run commands:**
 
    ```sh
-   dw commands --json
-   dw data athlete list --json
+   dw commands
+   dw data athlete list
    dw data athlete create --name "Ada" --date-of-birth 1992-01-01
    ```
 
 Generated command documentation is available in [`docs/commands`](./docs/commands/README.md).
 
+5. **Enable Dataworks in Codex or Claude Code:**
+
+   ```sh
+   dw agents install
+   ```
+
+   This detects supported clients and installs the complete Dataworks plugin:
+   the metric-query skill plus its read-only `query_metrics` MCP server. Start a
+   new Codex thread after installation. In Claude Code, run `/reload-plugins` or
+   start a new session. To configure only one client, use
+   `dw agents install codex` or `dw agents install claude-code`.
+
+   Until setup is completed, interactive CLI use prints this reminder at most
+   once every 24 hours. It never appears with `--json`. Permanently hide it with
+   `dw agents reminder disable`, restore it with `dw agents reminder enable`, or
+   set `DW_NO_AGENT_REMINDER=1` for a single process or automation environment.
+
+---
+
+## Bash autocomplete
+
+Generate the completion cache and print the one-time Bash setup instructions:
+
+```sh
+dw autocomplete bash
+```
+
+Global npm installs and upgrades run this command automatically. It prepares the
+latest completion cache and prints the setup instruction, but does not edit your
+shell startup files. If npm cannot access the shell cache, installation still
+succeeds and you can retry with `dw autocomplete bash`.
+
+After following the displayed instruction and reloading Bash, press Tab to
+complete `dw` command names and flags. Run `dw autocomplete --refresh-cache`
+after installing a release that adds commands.
+
+## AI agent metric queries
+
+The package includes a focused, read-only MCP server with one tool:
+`query_metrics`. It uses the same OS-backed login session and selected tenant as
+`dw`, resolves an athlete by exact ID or unique name, maps common metric aliases,
+polls asynchronous Data Explorer queries, and returns normalized structured
+rows. GPS values include decoded latitude and longitude; heart-rate values use
+numeric BPM when valid.
+
+The simplest setup for Codex and Claude Code is:
+
+```sh
+dw agents install
+```
+
+The command is safe to rerun after upgrades. It installs or updates the complete
+Dataworks plugin for each detected client and reports the reload or restart step.
+If an old marketplace registration points to a different CLI installation, rerun
+with `--force`.
+
+Successful setup automatically disables the periodic CLI reminder. To opt out
+without installing an agent integration, run `dw agents reminder disable`.
+
+Other MCP clients can launch the installed `dw-mcp` binary directly:
+
+```json
+{
+  "mcpServers": {
+    "dataworks": {
+      "command": "dw-mcp",
+      "args": []
+    }
+  }
+}
+```
+
+The npm package ships a cross-compatible Codex and Claude Code plugin at
+`plugins/dataworks`. Its focused skill turns requests such as “give me the last
+30 GPS values for James Haigh” into a `query_metrics` call. The tool accepts
+exactly one of `athlete_id` or `athlete_name`, plus `metric`; optional inputs are
+`limit`, `order`, `from`, `to`, `event_id`, `dataset_datasource_id`,
+`tenant_id`, `metric_category`, and `timeout_ms`.
+
+The server never performs mutations. If name resolution is ambiguous, it
+returns candidates and requires an explicit athlete ID rather than guessing.
+
 ---
 
 ## Output and Safety
 
-- Commands that emit finite data support `--json` and return a stable `{data,meta}` envelope.
-- Subscriptions and other streams emit newline-delimited JSON (NDJSON).
+- Commands render human-readable tables by default.
+- Pass `--json` for scripts and agents. Finite results use a stable `{data,meta}` envelope; subscriptions and other streams emit newline-delimited JSON (NDJSON).
 - Generated mutations support `--dry-run --json` to render a request without sending it.
 - Destructive mutations and all Live mutations require confirmation; non-interactive callers must pass `--yes`.
 - Passwords, tokens, authorization headers, secrets, and API keys are redacted from structured output.
@@ -106,6 +191,83 @@ dw data athlete delete --public-id athlete-123 --yes
 dw graphql query --document @query.graphql --variables @variables.json --json
 ```
 
+### Ingest metrics
+
+`dw ingest` validates and sends athlete metrics to an event and
+dataset-datasource. Each metric requires `athletePublicId`, `metric`, `value`,
+and a positive integer `timestamp`. Pass either an inline JSON array, a
+`{ "metrics": [...] }` object, `@filename`, or `-` to read JSON from standard
+input.
+
+```sh
+# Inline JSON
+dw ingest --event event-123 --dataset-datasource ds-456 --metrics '[{"athletePublicId":"ath-1","metric":"heartrate_calculated","value":172,"timestamp":1700000000}]'
+
+# File input; strict validation rejects the whole batch if any metric is invalid
+dw ingest --event event-123 --dataset-datasource ds-456 --metrics @metrics.json
+
+# Send valid metrics, report dropped invalid metrics, and return stable JSON
+dw ingest --event event-123 --dataset-datasource ds-456 --metrics @metrics.json --best-effort --json
+```
+
+### Subscribe to realtime events
+
+Realtime metric channels use
+`dataworks/<dataset-datasource-id>/<event-id>/<metric-or-*>`. Use `*` to watch
+every metric for that dataset-datasource/event pair or a metric name to narrow
+the stream. A leading `/` is optional. Human output is tabular; add `--json` for
+NDJSON.
+
+Press `Ctrl+C` once to close the WebSocket subscription and return to the
+shell.
+
+```sh
+# Watch all metrics for dataset-datasource 1 and event 1
+dw events subscribe --channel dataworks/1/1/*
+
+# Watch only heart-rate metrics as NDJSON
+dw events subscribe --channel dataworks/1/1/heartrate --json
+```
+
+### Query Data Explorer
+
+`dw data data-explorer execute` queries metric storage with an explicit column
+list and metric category. Optional fields support Data Explorer filter rules,
+aggregation, grouping, ordering, limits, and polling an asynchronous
+`queryExecutionId`. The category must be `METRICS_TYPE_A`, `METRICS_TYPE_B`, or
+`METRICS_TYPE_C`; `--columns` is a JSON array.
+
+```sh
+# Keep a filtered GPS query in a reusable JSON file
+dw data data-explorer execute --input @gps-query.json --json
+
+# Return the latest 30 GPS positions for one athlete
+dw data data-explorer execute --columns '["timestamp","athletepublicid","current"]' --metric-category METRICS_TYPE_A --filter-rules '{"combinator":"and","rules":[{"field":"metric","operator":"in","value":"latlong"},{"field":"athletepublicid","operator":"in","value":"athlete-123"}]}' --limit 30 --order-by timestamp --order-direction DESC --json
+```
+
+The corresponding `gps-query.json` contains the same fields without CLI flag
+conversion:
+
+```json
+{
+  "columns": ["timestamp", "athletepublicid", "metric", "current"],
+  "metricCategory": "METRICS_TYPE_A",
+  "filterRules": "{\"combinator\":\"and\",\"rules\":[{\"field\":\"metric\",\"operator\":\"in\",\"value\":\"latlong\"},{\"field\":\"athletepublicid\",\"operator\":\"in\",\"value\":\"athlete-123\"}]}",
+  "limit": 30,
+  "orderBy": "timestamp",
+  "orderDirection": "DESC"
+}
+```
+
+`filterRules` is an AWSJSON string containing a top-level `combinator` and a
+`rules` array. Each rule has `field`, `operator`, and string `value`; supported
+operators include `=`, `!=`, `>`, `<`, `>=`, `<=`, `contains`, and `in`.
+Multiple values for `in` are comma-separated. GPS is metric `latlong` in
+`METRICS_TYPE_A`; the `current` value is a `latitude:longitude` string. Run
+`dw data data-explorer execute --help` for the complete flag list and examples.
+In `--json` output, `rows` is AWSJSON and may need JSON-decoding until it becomes
+an array; default table output performs that decoding for humans.
+
 ---
 
 ## Common Commands

package/bin/mcp.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+import { runDataworksMcpServer } from "../dist/mcp/main.js";
+
+runDataworksMcpServer().catch((error) => {
+  process.stderr.write(
+    `Dataworks MCP server failed: ${error instanceof Error ? error.message : String(error)}\n`,
+  );
+  process.exitCode = 1;
+});

package/bin/postinstall.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+import { spawnSync } from "node:child_process";
+import { fileURLToPath } from "node:url";
+
+// npm runs postinstall for both first-time global installs and global upgrades.
+// Avoid writing shell caches when this package is only a project dependency.
+if (
+  process.env.npm_config_global === "true" ||
+  process.env.npm_config_location === "global"
+) {
+  const runPath = fileURLToPath(new URL("./run.js", import.meta.url));
+  const result = spawnSync(process.execPath, [runPath, "autocomplete", "bash"], {
+    stdio: "inherit",
+  });
+  if (result.error || result.status !== 0) {
+    process.stderr.write(
+      "Dataworks CLI installed, but Bash autocomplete setup could not be prepared. Run `dw autocomplete bash` to retry.\n",
+    );
+  }
+  process.stdout.write(
+    "To use Dataworks from Codex or Claude Code, run `dw agents install` once.\n",
+  );
+}

package/dist/commands/agents/install.d.ts

@@ -0,0 +1,17 @@
+import { DataworksCommand } from "../../lib/command.js";
+export default class AgentsInstall extends DataworksCommand {
+    static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static args: {
+        client: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=install.d.ts.map

package/dist/commands/agents/install.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../../../src/commands/agents/install.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AASxD,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,gBAAgB;IACzD,OAAgB,WAAW,SAC2D;IACtF,OAAgB,QAAQ;;;QAiBtB;IACF,OAAgB,IAAI;;MAMlB;IACF,OAAgB,KAAK;;;MAKnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CA4BlC"}

package/dist/commands/agents/install.js

@@ -0,0 +1,57 @@
+import { Args, Flags } from "@oclif/core";
+import { DataworksCommand } from "../../lib/command.js";
+import { installAgentIntegration, supportedAgentClients, } from "../../lib/agent-install.js";
+import { writeResult } from "../../lib/output.js";
+import { configureAgentReminder } from "../../lib/agent-reminder.js";
+export default class AgentsInstall extends DataworksCommand {
+    static description = "Install the Dataworks skill and query_metrics MCP server for Codex or Claude Code";
+    static examples = [
+        {
+            description: "Set up every supported agent client found on this machine",
+            command: "dw agents install",
+        },
+        {
+            description: "Set up Codex only",
+            command: "dw agents install codex",
+        },
+        {
+            description: "Set up Claude Code only",
+            command: "dw agents install claude-code",
+        },
+        {
+            description: "Replace a stale Dataworks marketplace registration",
+            command: "dw agents install codex --force",
+        },
+    ];
+    static args = {
+        client: Args.string({
+            description: "Agent client to configure; omit to detect and configure both",
+            options: ["codex", "claude-code"],
+            required: false,
+        }),
+    };
+    static flags = {
+        force: Flags.boolean({
+            description: "Replace an existing Dataworks marketplace registration",
+        }),
+        json: Flags.boolean({ description: "Emit stable JSON output" }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(AgentsInstall);
+        const clients = args.client ? [args.client] : supportedAgentClients;
+        const results = clients.map((client) => installAgentIntegration(client, { force: flags.force }));
+        if (results.some(({ status }) => status === "installed" || status === "updated")) {
+            await configureAgentReminder("configured");
+        }
+        writeResult({ integrations: results }, {
+            json: flags.json,
+            meta: {
+                restartRequired: results.some(({ status }) => status === "installed" || status === "updated"),
+            },
+        });
+        if (results.every(({ status }) => status === "unavailable" || status === "failed")) {
+            process.exitCode = 1;
+        }
+    }
+}
+//# sourceMappingURL=install.js.map

package/dist/commands/agents/install.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.js","sourceRoot":"","sources":["../../../src/commands/agents/install.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,uBAAuB,EACvB,qBAAqB,GAEtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,gBAAgB;IACzD,MAAM,CAAU,WAAW,GACzB,mFAAmF,CAAC;IACtF,MAAM,CAAU,QAAQ,GAAG;QACzB;YACE,WAAW,EAAE,2DAA2D;YACxE,OAAO,EAAE,mBAAmB;SAC7B;QACD;YACE,WAAW,EAAE,mBAAmB;YAChC,OAAO,EAAE,yBAAyB;SACnC;QACD;YACE,WAAW,EAAE,yBAAyB;YACtC,OAAO,EAAE,+BAA+B;SACzC;QACD;YACE,WAAW,EAAE,oDAAoD;YACjE,OAAO,EAAE,iCAAiC;SAC3C;KACF,CAAC;IACF,MAAM,CAAU,IAAI,GAAG;QACrB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;YAClB,WAAW,EAAE,8DAA8D;YAC3E,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC;YACjC,QAAQ,EAAE,KAAK;SAChB,CAAC;KACH,CAAC;IACF,MAAM,CAAU,KAAK,GAAG;QACtB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,WAAW,EAAE,wDAAwD;SACtE,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;KAChE,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAqB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC;QACnF,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACrC,uBAAuB,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CACxD,CAAC;QACF,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,KAAK,SAAS,CAAC,EAAE,CAAC;YACjF,MAAM,sBAAsB,CAAC,YAAY,CAAC,CAAC;QAC7C,CAAC;QAED,WAAW,CACT,EAAE,YAAY,EAAE,OAAO,EAAE,EACzB;YACE,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE;gBACJ,eAAe,EAAE,OAAO,CAAC,IAAI,CAC3B,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,KAAK,SAAS,CAC/D;aACF;SACF,CACF,CAAC;QAEF,IACE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,KAAK,aAAa,IAAI,MAAM,KAAK,QAAQ,CAAC,EAC9E,CAAC;YACD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC"}

package/dist/commands/agents/reminder.d.ts

@@ -0,0 +1,16 @@
+import { DataworksCommand } from "../../lib/command.js";
+export default class AgentsReminder extends DataworksCommand {
+    static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static args: {
+        action: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=reminder.d.ts.map

package/dist/commands/agents/reminder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reminder.d.ts","sourceRoot":"","sources":["../../../src/commands/agents/reminder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AASxD,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,gBAAgB;IAC1D,OAAgB,WAAW,SACwC;IACnE,OAAgB,QAAQ;;;QAatB;IACF,OAAgB,IAAI;;MAMlB;IACF,OAAgB,KAAK;;MAEnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAiBlC"}

package/dist/commands/agents/reminder.js

@@ -0,0 +1,45 @@
+import { Args, Flags } from "@oclif/core";
+import { DataworksCommand } from "../../lib/command.js";
+import { configureAgentReminder, readAgentReminderPreferences, } from "../../lib/agent-reminder.js";
+import { writeResult } from "../../lib/output.js";
+export default class AgentsReminder extends DataworksCommand {
+    static description = "Inspect, disable, or enable the Dataworks agent setup reminder";
+    static examples = [
+        {
+            description: "Permanently hide the agent setup reminder",
+            command: "dw agents reminder disable",
+        },
+        {
+            description: "Show the reminder again when setup is incomplete",
+            command: "dw agents reminder enable",
+        },
+        {
+            description: "Inspect the current reminder state",
+            command: "dw agents reminder status --json",
+        },
+    ];
+    static args = {
+        action: Args.string({
+            description: "Reminder action",
+            options: ["status", "disable", "enable"],
+            default: "status",
+        }),
+    };
+    static flags = {
+        json: Flags.boolean({ description: "Emit stable JSON output" }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(AgentsReminder);
+        const action = args.action;
+        const reminder = action === "status"
+            ? await readAgentReminderPreferences()
+            : await configureAgentReminder(action);
+        writeResult({
+            reminder: {
+                ...reminder,
+                enabled: !reminder.disabled && !reminder.configured,
+            },
+        }, { json: flags.json });
+    }
+}
+//# sourceMappingURL=reminder.js.map

package/dist/commands/agents/reminder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reminder.js","sourceRoot":"","sources":["../../../src/commands/agents/reminder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,sBAAsB,EACtB,4BAA4B,GAC7B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAIlD,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,gBAAgB;IAC1D,MAAM,CAAU,WAAW,GACzB,gEAAgE,CAAC;IACnE,MAAM,CAAU,QAAQ,GAAG;QACzB;YACE,WAAW,EAAE,2CAA2C;YACxD,OAAO,EAAE,4BAA4B;SACtC;QACD;YACE,WAAW,EAAE,kDAAkD;YAC/D,OAAO,EAAE,2BAA2B;SACrC;QACD;YACE,WAAW,EAAE,oCAAoC;YACjD,OAAO,EAAE,kCAAkC;SAC5C;KACF,CAAC;IACF,MAAM,CAAU,IAAI,GAAG;QACrB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;YAClB,WAAW,EAAE,iBAAiB;YAC9B,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;YACxC,OAAO,EAAE,QAAQ;SAClB,CAAC;KACH,CAAC;IACF,MAAM,CAAU,KAAK,GAAG;QACtB,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;KAChE,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAwB,CAAC;QAC7C,MAAM,QAAQ,GACZ,MAAM,KAAK,QAAQ;YACjB,CAAC,CAAC,MAAM,4BAA4B,EAAE;YACtC,CAAC,CAAC,MAAM,sBAAsB,CAAC,MAAM,CAAC,CAAC;QAC3C,WAAW,CACT;YACE,QAAQ,EAAE;gBACR,GAAG,QAAQ;gBACX,OAAO,EAAE,CAAC,QAAQ,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,UAAU;aACpD;SACF,EACD,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CACrB,CAAC;IACJ,CAAC"}

package/dist/commands/auth/login.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"login.d.ts","sourceRoot":"","sources":["../../../src/commands/auth/login.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAUxD,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,gBAAgB;IACrD,OAAgB,WAAW,SAA2D;IACtF,OAAgB,QAAQ;;;QAStB;IACF,OAAgB,KAAK;;;;;MAUnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAiClC"}
+{"version":3,"file":"login.d.ts","sourceRoot":"","sources":["../../../src/commands/auth/login.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAUxD,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,gBAAgB;IACrD,OAAgB,WAAW,SAA2D;IACtF,OAAgB,QAAQ;;;QAStB;IACF,OAAgB,KAAK;;;;;MAUnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAqClC"}

package/dist/commands/auth/login.js

@@ -37,7 +37,7 @@ export default class AuthLogin extends DataworksCommand {
         if (!environment && process.stdin.isTTY)
             environment = await prompt("Environment (uat/live)");
         if (!environment || !isEnvironment(environment)) {
-            throw new CliError("Specify --environment uat|live", "ENVIRONMENT_REQUIRED", 2);
+            throw new CliError("Specify either --environment uat or --environment live", "ENVIRONMENT_REQUIRED", 2);
         }
         const config = resolveEnvironment(environment, flags["client-id"]);
         const session = await loginWithBrowser(config, {

package/dist/commands/auth/login.js.map

@@ -1 +1 @@
-{"version":3,"file":"login.js","sourceRoot":"","sources":["../../../src/commands/auth/login.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,gBAAgB;IACrD,MAAM,CAAU,WAAW,GAAG,uDAAuD,CAAC;IACtF,MAAM,CAAU,QAAQ,GAAG;QACzB;YACE,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,iCAAiC;SAC3C;QACD;YACE,WAAW,EAAE,mEAAmE;YAChF,OAAO,EAAE,8CAA8C;SACxD;KACF,CAAC;IACF,MAAM,CAAU,KAAK,GAAG;QACtB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,4BAA4B,EAAE,CAAC;QACxE,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;YACxB,WAAW,EAAE,uBAAuB;SACrC,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;QAC/D,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC;YAC1B,WAAW,EAAE,kDAAkD;SAChE,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK;YACrC,WAAW,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,QAAQ,CAAC,gCAAgC,EAAE,sBAAsB,EAAE,CAAC,CAAC,CAAC;QAClF,CAAC;QACD,MAAM,MAAM,GAAG,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE;YAC7C,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC;YAC9B,kBAAkB,EAAE,CAAC,GAAG,EAAE,gBAAgB,EAAE,EAAE;gBAC5C,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,gBAAgB;oBACd,CAAC,CAAC,yEAAyE,GAAG,IAAI;oBAClF,CAAC,CAAC,iDAAiD,GAAG,IAAI,CAC7D,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;QACH,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3B,MAAM,cAAc,GAAG,MAAM,UAAU,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,MAAM,CAAC;QAClE,MAAM,WAAW,CAAC;YAChB,WAAW;YACX,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC;YAC5B,MAAM,EAAE,MAAM,IAAI,SAAS;SAC5B,CAAC,CAAC;QACH,WAAW,CACT,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,EAC7D,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,CAC5C,CAAC;IACJ,CAAC"}
+{"version":3,"file":"login.js","sourceRoot":"","sources":["../../../src/commands/auth/login.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,gBAAgB;IACrD,MAAM,CAAU,WAAW,GAAG,uDAAuD,CAAC;IACtF,MAAM,CAAU,QAAQ,GAAG;QACzB;YACE,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,iCAAiC;SAC3C;QACD;YACE,WAAW,EAAE,mEAAmE;YAChF,OAAO,EAAE,8CAA8C;SACxD;KACF,CAAC;IACF,MAAM,CAAU,KAAK,GAAG;QACtB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,4BAA4B,EAAE,CAAC;QACxE,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;YACxB,WAAW,EAAE,uBAAuB;SACrC,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;QAC/D,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC;YAC1B,WAAW,EAAE,kDAAkD;SAChE,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK;YACrC,WAAW,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,QAAQ,CAChB,wDAAwD,EACxD,sBAAsB,EACtB,CAAC,CACF,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE;YAC7C,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC;YAC9B,kBAAkB,EAAE,CAAC,GAAG,EAAE,gBAAgB,EAAE,EAAE;gBAC5C,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,gBAAgB;oBACd,CAAC,CAAC,yEAAyE,GAAG,IAAI;oBAClF,CAAC,CAAC,iDAAiD,GAAG,IAAI,CAC7D,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;QACH,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3B,MAAM,cAAc,GAAG,MAAM,UAAU,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,MAAM,CAAC;QAClE,MAAM,WAAW,CAAC;YAChB,WAAW;YACX,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC;YAC5B,MAAM,EAAE,MAAM,IAAI,SAAS;SAC5B,CAAC,CAAC;QACH,WAAW,CACT,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,EAC7D,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,CAC5C,CAAC;IACJ,CAAC"}

package/dist/commands/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/commands/commands.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAkBrD,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,gBAAgB;IACpD,OAAgB,WAAW,SACgC;IAC3D,OAAgB,KAAK;;MAEnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAiBlC"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/commands/commands.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAsBrD,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,gBAAgB;IACpD,OAAgB,WAAW,SACgC;IAC3D,OAAgB,KAAK;;MAEnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAiBlC"}

package/dist/commands/commands.js

@@ -3,9 +3,12 @@ import { DataworksCommand } from "../lib/command.js";
 import { operations } from "../generated/operations.js";
 import { writeResult } from "../lib/output.js";
 const builtIns = [
+    "agents install",
+    "agents reminder",
     "auth login",
     "auth logout",
     "auth status",
+    "autocomplete",
     "commands",
     "events subscribe",
     "graphql mutate",
@@ -13,6 +16,7 @@ const builtIns = [
     "graphql subscribe",
     "ingest",
     "report-error",
+    "tenant list",
     "tenant select",
 ];
 export default class Commands extends DataworksCommand {

package/dist/commands/commands.js.map

@@ -1 +1 @@
-{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../src/commands/commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,QAAQ,GAAG;IACf,YAAY;IACZ,aAAa;IACb,aAAa;IACb,UAAU;IACV,kBAAkB;IAClB,gBAAgB;IAChB,eAAe;IACf,mBAAmB;IACnB,QAAQ;IACR,cAAc;IACd,eAAe;CAChB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,gBAAgB;IACpD,MAAM,CAAU,WAAW,GACzB,wDAAwD,CAAC;IAC3D,MAAM,CAAU,KAAK,GAAG;QACtB,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;KAChE,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG;YACX,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,EAAE,EAAE,CAAC,CAAC;YACnE,SAAS,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;gBACxC,OAAO,EAAE,MAAM,SAAS,CAAC,OAAO,EAAE;gBAClC,SAAS,EAAE,SAAS,CAAC,IAAI;gBACzB,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,SAAS,EAAE,SAAS,CAAC,SAAS;aAC/B,CAAC,CAAC;SACJ,CAAC;QACF,WAAW,CAAC,IAAI,EAAE;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,EAAE,cAAc,EAAE,UAAU,CAAC,MAAM,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC"}
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../src/commands/commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,QAAQ,GAAG;IACf,gBAAgB;IAChB,iBAAiB;IACjB,YAAY;IACZ,aAAa;IACb,aAAa;IACb,cAAc;IACd,UAAU;IACV,kBAAkB;IAClB,gBAAgB;IAChB,eAAe;IACf,mBAAmB;IACnB,QAAQ;IACR,cAAc;IACd,aAAa;IACb,eAAe;CAChB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,gBAAgB;IACpD,MAAM,CAAU,WAAW,GACzB,wDAAwD,CAAC;IAC3D,MAAM,CAAU,KAAK,GAAG;QACtB,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;KAChE,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG;YACX,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,EAAE,EAAE,CAAC,CAAC;YACnE,SAAS,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;gBACxC,OAAO,EAAE,MAAM,SAAS,CAAC,OAAO,EAAE;gBAClC,SAAS,EAAE,SAAS,CAAC,IAAI;gBACzB,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,SAAS,EAAE,SAAS,CAAC,SAAS;aAC/B,CAAC,CAAC;SACJ,CAAC;QACF,WAAW,CAAC,IAAI,EAAE;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,EAAE,cAAc,EAAE,UAAU,CAAC,MAAM,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC"}

package/dist/commands/events/subscribe.d.ts

@@ -1,9 +1,15 @@
 import { DataworksCommand } from "../../lib/command.js";
+import { CliError } from "../../lib/errors.js";
+export declare function channelRequiredError(): CliError;
 export default class EventsSubscribe extends DataworksCommand {
     static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     static flags: {
         "api-key": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        channel: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        channel: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;

package/dist/commands/events/subscribe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subscribe.d.ts","sourceRoot":"","sources":["../../../src/commands/events/subscribe.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAIxD,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,gBAAgB;IAC3D,OAAgB,WAAW,SAAqD;IAChF,OAAgB,KAAK;;;;MAInB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAQlC"}
+{"version":3,"file":"subscribe.d.ts","sourceRoot":"","sources":["../../../src/commands/events/subscribe.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAGxD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAI/C,wBAAgB,oBAAoB,IAAI,QAAQ,CAqC/C;AAED,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,gBAAgB;IAC3D,OAAgB,WAAW,SACgE;IAC3F,OAAgB,QAAQ;;;QAatB;IACF,OAAgB,KAAK;;;;MAOnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CASlC"}

package/dist/commands/events/subscribe.js

@@ -2,16 +2,69 @@ import { Flags } from "@oclif/core";
 import { DataworksCommand } from "../../lib/command.js";
 import { subscribeEvents } from "../../lib/http-transport.js";
 import { writeResult } from "../../lib/output.js";
+import { CliError } from "../../lib/errors.js";
+const channelExamples = ["dataworks/1/1/*", "dataworks/1/1/heartrate"];
+export function channelRequiredError() {
+    const examples = [
+        `dw events subscribe --channel ${channelExamples[0]}`,
+        `dw events subscribe --channel ${channelExamples[1]}`,
+        `dw events subscribe --channel ${channelExamples[1]} --json`,
+    ];
+    return new CliError([
+        "Missing required flag --channel.",
+        "",
+        "Channel format:",
+        "  dataworks/<dataset-datasource-id>/<event-id>/<metric-or-*>",
+        "",
+        "Examples:",
+        ...examples.map((example) => `  ${example}`),
+        "",
+        "Use * for all metrics, a metric name such as heartrate to filter, and --json for NDJSON output.",
+        "A leading slash is optional.",
+        "",
+        "More help: dw events subscribe --help",
+    ].join("\n"), "ARGUMENT_REQUIRED", 2, {
+        command: "dw events subscribe",
+        requiredArguments: [
+            {
+                flag: "--channel",
+                type: "channel path",
+                description: "dataworks/<dataset-datasource-id>/<event-id>/<metric-or-*>",
+                example: channelExamples[0],
+            },
+        ],
+        examples,
+        help: "dw events subscribe --help",
+    });
+}
 export default class EventsSubscribe extends DataworksCommand {
-    static description = "Subscribe to a Dataworks AppSync Events channel";
+    static description = "Subscribe to live Dataworks metrics on an AppSync Events channel; press Ctrl+C to stop";
+    static examples = [
+        {
+            description: "Watch all metrics for dataset-datasource 1 and event 1 as tables",
+            command: `dw events subscribe --channel ${channelExamples[0]}`,
+        },
+        {
+            description: "Watch only heart-rate metrics",
+            command: `dw events subscribe --channel ${channelExamples[1]}`,
+        },
+        {
+            description: "Emit heart-rate events as NDJSON for scripts and agents",
+            command: `dw events subscribe --channel ${channelExamples[1]} --json`,
+        },
+    ];
     static flags = {
         "api-key": Flags.string({ description: "AppSync Events API key" }),
-        channel: Flags.string({ required: true, description: "Channel path" }),
+        channel: Flags.string({
+            description: "Channel: dataworks/<dataset-datasource-id>/<event-id>/<metric-or-*>",
+        }),
         json: Flags.boolean({ description: "Emit NDJSON events" }),
     };
     async run() {
         const { flags } = await this.parse(EventsSubscribe);
-        await subscribeEvents(flags.channel, (data) => writeResult(data, { stream: true }), flags["api-key"]);
+        if (!flags.channel)
+            throw channelRequiredError();
+        await subscribeEvents(flags.channel, (data) => writeResult(data, { json: flags.json, stream: true }), flags["api-key"]);
     }
 }
 //# sourceMappingURL=subscribe.js.map