@dataworks-technology/cli 1.0.1 → 1.1.0

package/README.md

@@ -2,9 +2,9 @@
 
 <div align="center">
   <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://unpkg.com/@dataworks-technology/cli@latest/.github/.assets/dataworks-light.svg">
-    <source media="(prefers-color-scheme: light)" srcset="https://unpkg.com/@dataworks-technology/cli@latest/.github/.assets/dataworks-dark.svg">
-    <img alt="Dataworks Logo" src="https://unpkg.com/@dataworks-technology/cli@latest/.github/.assets/dataworks-dark.svg" width="200">
+    <source media="(prefers-color-scheme: dark)" srcset="https://cdn.jsdelivr.net/npm/@dataworks-technology/cli@latest/.github/.assets/dataworks-light.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://cdn.jsdelivr.net/npm/@dataworks-technology/cli@latest/.github/.assets/dataworks-dark.svg">
+    <img alt="Dataworks Logo" src="https://cdn.jsdelivr.net/npm/@dataworks-technology/cli@latest/.github/.assets/dataworks-dark.svg" width="200">
   </picture>
 </div>
 
@@ -36,7 +36,7 @@ The `dw` binary turns the public GraphQL contract published by `@dataworks-techn
 ## Prerequisites
 
 - [Node.js](https://nodejs.org/) 22 or newer to run the published CLI
-- A Dataworks account and Cognito client ID for the target environment
+- A Dataworks account
 - [Bun](https://bun.sh/) for repository development
 
 ---
@@ -53,13 +53,16 @@ The `dw` binary turns the public GraphQL contract published by `@dataworks-techn
 2. **Authenticate:**
 
    ```sh
-   export DW_UAT_CLIENT_ID=<uat-cognito-client-id>
    dw auth login --environment uat
    dw auth status --json
    ```
 
    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.
 
+   The public UAT and Live Cognito client IDs are built in. Override them with
+   `--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.
 

package/dist/lib/environment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../src/lib/environment.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,MAAM,CAAC;AAElD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;AAEvE,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,oBAAoB,CAE1E;AAED,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,oBAAoB,EACjC,gBAAgB,CAAC,EAAE,MAAM,GACxB,iBAAiB,CAmBnB;AAED,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,oBAAoB,GAChC,oBAAoB,CAWtB"}
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../src/lib/environment.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,MAAM,CAAC;AAOlD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;AAEvE,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,oBAAoB,CAE1E;AAED,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,oBAAoB,EACjC,gBAAgB,CAAC,EAAE,MAAM,GACxB,iBAAiB,CAWnB;AAED,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,oBAAoB,GAChC,oBAAoB,CAWtB"}

package/dist/lib/environment.js

@@ -1,4 +1,7 @@
-import { CliError } from "./errors.js";
+const defaultClientIds = {
+    uat: "4hldq2bchmkumaf2jibm719jq2",
+    live: "7oug1a58uuof6vg56tg0hbdf58",
+};
 export function isEnvironment(value) {
     return value === "uat" || value === "live";
 }
@@ -6,10 +9,7 @@ export function resolveEnvironment(environment, clientIdOverride) {
     const clientId = clientIdOverride?.trim() ||
         process.env[`DW_${environment.toUpperCase()}_CLIENT_ID`]?.trim() ||
         process.env.DW_CLIENT_ID?.trim() ||
-        "";
-    if (!clientId) {
-        throw new CliError(`No Cognito client ID is configured for ${environment}. Set DW_${environment.toUpperCase()}_CLIENT_ID or DW_CLIENT_ID.`, "CLIENT_ID_REQUIRED", 2);
-    }
+        defaultClientIds[environment];
     return {
         ...resolveEndpoints(environment),
         clientId,

package/dist/lib/environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/lib/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAiBvC,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,OAAO,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,WAAiC,EACjC,gBAAyB;IAEzB,MAAM,QAAQ,GACZ,gBAAgB,EAAE,IAAI,EAAE;QACxB,OAAO,CAAC,GAAG,CAAC,MAAM,WAAW,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,IAAI,EAAE;QAChE,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,EAAE;QAChC,EAAE,CAAC;IAEL,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,QAAQ,CAChB,0CAA0C,WAAW,YAAY,WAAW,CAAC,WAAW,EAAE,6BAA6B,EACvH,oBAAoB,EACpB,CAAC,CACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,gBAAgB,CAAC,WAAW,CAAC;QAChC,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,WAAiC;IAEjC,MAAM,MAAM,GAAG,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC;IAC/D,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,eAAe,EAAE,8CAA8C;QAC/D,WAAW,EAAE,0BAA0B,WAAW,mCAAmC;QACrF,SAAS,EAAE,mBAAmB,MAAM,kBAAkB;QACtD,QAAQ,EAAE,mBAAmB,MAAM,wBAAwB;QAC3D,WAAW,EAAE,oBAAoB,MAAM,kBAAkB;QACzD,UAAU,EAAE,kBAAkB,MAAM,yBAAyB;KAC9D,CAAC;AACJ,CAAC"}
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/lib/environment.ts"],"names":[],"mappings":"AAEA,MAAM,gBAAgB,GAAyC;IAC7D,GAAG,EAAE,4BAA4B;IACjC,IAAI,EAAE,4BAA4B;CACnC,CAAC;AAeF,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,OAAO,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,WAAiC,EACjC,gBAAyB;IAEzB,MAAM,QAAQ,GACZ,gBAAgB,EAAE,IAAI,EAAE;QACxB,OAAO,CAAC,GAAG,CAAC,MAAM,WAAW,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,IAAI,EAAE;QAChE,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,EAAE;QAChC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAEhC,OAAO;QACL,GAAG,gBAAgB,CAAC,WAAW,CAAC;QAChC,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,WAAiC;IAEjC,MAAM,MAAM,GAAG,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC;IAC/D,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,eAAe,EAAE,8CAA8C;QAC/D,WAAW,EAAE,0BAA0B,WAAW,mCAAmC;QACrF,SAAS,EAAE,mBAAmB,MAAM,kBAAkB;QACtD,QAAQ,EAAE,mBAAmB,MAAM,wBAAwB;QAC3D,WAAW,EAAE,oBAAoB,MAAM,kBAAkB;QACzD,UAAU,EAAE,kBAAkB,MAAM,yBAAyB;KAC9D,CAAC;AACJ,CAAC"}

package/oclif.manifest.json

@@ -11514,5 +11514,5 @@
       ]
     }
   },
-  "version": "1.0.1"
+  "version": "1.1.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dataworks-technology/cli",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "The official command-line interface for the Dataworks Data Engine",
   "type": "module",
   "license": "MIT",

package/skills/dataworks-cli/SKILL.md

@@ -1,17 +1,46 @@
 ---
 name: dataworks-cli
-description: Use the Dataworks `dw` CLI safely for public Data Engine queries, mutations, ingest, error reporting, and subscriptions.
+description: Route every request to inspect, query, create, update, delete, ingest, monitor, subscribe to, or otherwise act on Dataworks through the `dw` CLI. Use whenever a user asks for any action involving Dataworks data, tenants, authentication, the Data Engine API, events, adaptors, datasets, or related resources.
 ---
 
 # Dataworks CLI
 
-Use `dw commands --json` to discover the installed command contract and
-`dw <command> --help` before constructing a call. Prefer generated `dw data ...`
-commands over raw GraphQL.
+Use `dw` as the operational interface for every Dataworks action. Do not call a
+Dataworks HTTP or GraphQL endpoint directly, or use an SDK instead, when the CLI
+can perform the action.
 
-Authenticate with `dw auth login --environment uat|live`. Never print, log, or
-write `DW_PASSWORD`, `DW_SESSION_JSON`, tokens, or API keys. Use `--json` for
-finite machine-readable results; parse subscriptions as NDJSON.
+## Route the request
+
+1. Run `dw --version` to verify the CLI is available. If it is missing, ask to
+   install it with `npm install --global @dataworks-technology/cli`.
+2. Run `dw commands --json` to discover the installed command contract.
+3. Run `dw <command> --help` before constructing the exact call.
+4. Prefer the narrowest matching command:
+   - Data Engine entities: `dw data ...`
+   - Authentication and session state: `dw auth ...`
+   - Tenant discovery and persistence: `dw tenant select ...`
+   - Metric ingestion: `dw ingest`
+   - Realtime events: `dw events subscribe`
+   - Datasource errors: `dw report-error`
+   - Raw GraphQL: `dw graphql ...`, only when no generated command exists
+5. If no CLI command supports the request, report the missing capability and
+   ask before using any non-CLI alternative.
+
+## Authenticate and select a tenant
+
+Authenticate with `dw auth login --environment uat|live` and inspect the session
+with `dw auth status --json`. Never print, log, or write `DW_PASSWORD`,
+`DW_SESSION_JSON`, tokens, or API keys.
+
+Use `dw tenant select --json` to list authorized tenants, `dw tenant select` for
+interactive selection, or `dw tenant select <id>` for a direct selection. The
+selected tenant persists for subsequent commands. Use `--tenant` only for an
+explicit one-command override.
+
+## Execute safely
+
+Use `--json` for finite machine-readable results. Treat subscription output as
+NDJSON and process it incrementally.
 
 Before any mutation:
 
@@ -21,6 +50,8 @@ Before any mutation:
 3. Add `--yes` only after approval. Never infer approval from the presence of
    credentials.
 
-Use `--tenant` only when the user explicitly requests an authorized tenant
-override. For bulk ingest, default to strict validation; use `--best-effort`
-only when dropping invalid metrics is acceptable and report all dropped items.
+For bulk ingest, default to strict validation. Use `--best-effort` only when
+dropping invalid metrics is acceptable, and report every dropped item.
+
+Report the command used, the selected environment and tenant when relevant, and
+the result without exposing credentials or unredacted sensitive values.