@dataworks-technology/cli 1.6.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +1 -1
- package/README.md +5 -5
- package/oclif.manifest.json +1 -1
- package/package.json +1 -2
- package/plugins/dataworks/.claude-plugin/plugin.json +2 -2
- package/plugins/dataworks/.codex-plugin/plugin.json +3 -3
- package/{skills → plugins/dataworks/skills}/dataworks-cli/SKILL.md +13 -6
- package/plugins/dataworks/skills/query-dataworks-metrics/SKILL.md +15 -2
- /package/{skills → plugins/dataworks/skills}/dataworks-cli/agents/openai.yaml +0 -0
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
{
|
|
11
11
|
"name": "dataworks",
|
|
12
12
|
"source": "./plugins/dataworks",
|
|
13
|
-
"description": "Query Dataworks athlete metrics using the authenticated local CLI session"
|
|
13
|
+
"description": "Query Dataworks athlete metrics and operate the Dataworks platform using the authenticated local CLI session."
|
|
14
14
|
}
|
|
15
15
|
]
|
|
16
16
|
}
|
package/README.md
CHANGED
|
@@ -339,7 +339,7 @@ Files under `src/generated/`, `src/commands/data/`, and `docs/commands/` are gen
|
|
|
339
339
|
|
|
340
340
|
Canonical metric names are generated the same way. [`scripts/generate-metrics.ts`](./scripts/generate-metrics.ts) reads `metricConfig` from the private `@dataworks/sdk` devDependency and emits `src/generated/metrics.ts` and the catalogue block in the `query-dataworks-metrics` skill. To add a metric, change the SDK — not the generated files, and not the alias layer in `src/lib/metric-names.ts`.
|
|
341
341
|
|
|
342
|
-
The daily SDK maintenance workflow checks for new `@dataworks-technology/data` and `@dataworks/sdk` versions. Deterministic generation runs first; if compatibility work is required, a constrained LiteLLM maintenance agent
|
|
342
|
+
The daily SDK maintenance workflow checks for new `@dataworks-technology/data` and `@dataworks/sdk` versions. Deterministic generation runs first; if compatibility work is required, a constrained LiteLLM maintenance agent repairs it. The repository workflow verifies the exact update with full CI, merges successful updates automatically, and starts a CLI release. Failed repairs remain draft PRs for human review.
|
|
343
343
|
|
|
344
344
|
See [architecture](./docs/architecture.md), [contributing](./docs/contributing.md), [automated SDK maintenance](./docs/maintenance.md), [security](./docs/security.md), and [releasing](./docs/releasing.md) for details.
|
|
345
345
|
|
|
@@ -350,11 +350,11 @@ See [architecture](./docs/architecture.md), [contributing](./docs/contributing.m
|
|
|
350
350
|
| Trigger | Workflow | Description |
|
|
351
351
|
| --------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
352
352
|
| Pull request or push to `main` | `ci.yml` | Verifies generation, formatting, types, tests, builds, and packaging on the labelled self-hosted runner with Node 22 and 24 |
|
|
353
|
-
| Daily schedule or manual dispatch | `sdk-sync.yml` | Updates
|
|
353
|
+
| Daily schedule or manual dispatch | `sdk-sync.yml` | Updates SDKs, verifies and automatically merges successful maintenance PRs |
|
|
354
354
|
| Manual dispatch | `uat-e2e.yml` | Authenticates against UAT and reads the public Data manifest |
|
|
355
|
-
| Push to `main`
|
|
355
|
+
| Push to `main` or manual dispatch | `release.yml` | Runs release-please on the self-hosted runner, then publishes with npm trusted publishing and notifies Slack |
|
|
356
356
|
|
|
357
|
-
|
|
357
|
+
Successful SDK maintenance and release-please PRs are verified and merged automatically. Failed SDK repairs remain draft PRs for human review. Successful npm publication notifies Slack through `SLACK_WEBHOOK_URL`.
|
|
358
358
|
|
|
359
359
|
---
|
|
360
360
|
|
|
@@ -374,7 +374,7 @@ Automated SDK update pull requests remain drafts until a human reviews and marks
|
|
|
374
374
|
- Depends on **Dataworks-Data** for the public GraphQL schema and `@dataworks-technology/data` package
|
|
375
375
|
- Uses the same public contract that generates the Data SDK Docusaurus reference
|
|
376
376
|
- Authenticates against the UAT or Live Cognito and Data Engine endpoints at runtime
|
|
377
|
-
- New SDK versions are consumed through
|
|
377
|
+
- New SDK versions are consumed through verified automated pull requests rather than manual schema copying
|
|
378
378
|
|
|
379
379
|
---
|
|
380
380
|
|
package/oclif.manifest.json
CHANGED
|
@@ -11719,5 +11719,5 @@
|
|
|
11719
11719
|
]
|
|
11720
11720
|
}
|
|
11721
11721
|
},
|
|
11722
|
-
"version": "1.
|
|
11722
|
+
"version": "1.7.0"
|
|
11723
11723
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dataworks-technology/cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.0",
|
|
4
4
|
"description": "The official command-line interface for the Dataworks Data Engine",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -22,7 +22,6 @@
|
|
|
22
22
|
"dist",
|
|
23
23
|
"plugins",
|
|
24
24
|
"schema",
|
|
25
|
-
"skills",
|
|
26
25
|
"oclif.manifest.json",
|
|
27
26
|
"README.md",
|
|
28
27
|
"LICENSE"
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dataworks",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "Query athlete metrics
|
|
3
|
+
"version": "1.7.0",
|
|
4
|
+
"description": "Query Dataworks athlete metrics and operate the Dataworks platform using the authenticated local CLI session.",
|
|
5
5
|
"author": { "name": "Dataworks Technology" },
|
|
6
6
|
"homepage": "https://github.com/Dataworks-Technology/Dataworks-CLI",
|
|
7
7
|
"repository": "https://github.com/Dataworks-Technology/Dataworks-CLI",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dataworks",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "Query athlete metrics
|
|
3
|
+
"version": "1.7.0",
|
|
4
|
+
"description": "Query Dataworks athlete metrics and operate the Dataworks platform using the authenticated local CLI session.",
|
|
5
5
|
"author": { "name": "Dataworks Technology", "url": "https://dataworks.live/" },
|
|
6
6
|
"homepage": "https://github.com/Dataworks-Technology/Dataworks-CLI",
|
|
7
7
|
"repository": "https://github.com/Dataworks-Technology/Dataworks-CLI",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"interface": {
|
|
13
13
|
"displayName": "Dataworks",
|
|
14
14
|
"shortDescription": "Query athlete metrics safely",
|
|
15
|
-
"longDescription": "Resolve athletes and return normalized
|
|
15
|
+
"longDescription": "Resolve athletes and events, return normalized metric values and server-side aggregates through read-only tools, and drive the full Dataworks CLI for everything else.",
|
|
16
16
|
"developerName": "Dataworks Technology",
|
|
17
17
|
"category": "Data",
|
|
18
18
|
"capabilities": ["Read"],
|
|
@@ -5,11 +5,16 @@ description: Route operational requests to inspect, query, create, update, delet
|
|
|
5
5
|
|
|
6
6
|
# Dataworks CLI
|
|
7
7
|
|
|
8
|
-
Use `dw` as the operational interface for Dataworks actions.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
8
|
+
Use `dw` as the operational interface for Dataworks actions. Do not call a
|
|
9
|
+
Dataworks HTTP or GraphQL endpoint directly, or use an SDK, when the CLI or the
|
|
10
|
+
Dataworks MCP tools can perform the action.
|
|
11
|
+
|
|
12
|
+
The MCP tools, when available, own a narrow slice: `query_metrics` for historical
|
|
13
|
+
metric values and aggregates, and `list_athletes` / `list_events` for resolving
|
|
14
|
+
the IDs those queries need. Everything else is the CLI's job — full entity
|
|
15
|
+
records, teams, datasets, participants, ingestion, subscriptions, and every
|
|
16
|
+
create, update or delete. Use the CLI for those directly; it is not a fallback
|
|
17
|
+
for when a tool fails.
|
|
13
18
|
|
|
14
19
|
If a request needs `query_metrics` but the tool is unavailable, tell the user to
|
|
15
20
|
run `dw agents install` once, then start a new Codex thread or run
|
|
@@ -23,7 +28,9 @@ the restarted or reloaded agent exposes the tool.
|
|
|
23
28
|
2. Run `dw commands --json` to discover the installed command contract.
|
|
24
29
|
3. Run `dw <command> --help` before constructing the exact call.
|
|
25
30
|
4. Prefer the narrowest matching command:
|
|
26
|
-
- Historical
|
|
31
|
+
- Historical metric values or aggregates: `query_metrics` when available
|
|
32
|
+
- An athlete or event ID for such a query: `list_athletes` / `list_events`
|
|
33
|
+
- A full athlete, event, dataset or participant record: `dw data ...`
|
|
27
34
|
- Data Engine entities: `dw data ...`
|
|
28
35
|
- Authentication and session state: `dw auth ...`
|
|
29
36
|
- Tenant discovery and persistence: `dw tenant list` and `dw tenant select ...`
|
|
@@ -11,6 +11,17 @@ Three read-only tools use the current authenticated `dw` session and tenant:
|
|
|
11
11
|
- `list_athletes` — find an athlete ID, or confirm someone is not in this tenant.
|
|
12
12
|
- `list_events` — find an event ID for a race, by name.
|
|
13
13
|
|
|
14
|
+
These cover historical metrics and the IDs needed to ask for them, and nothing
|
|
15
|
+
else. They are deliberately narrow: `list_athletes` returns only an ID, a name
|
|
16
|
+
and an external ID. For anything beyond that — an athlete's full record, teams,
|
|
17
|
+
datasets, participants, events as entities, ingestion, live subscriptions, or any
|
|
18
|
+
create, update or delete — use the `dw` CLI, which covers the whole Data Engine
|
|
19
|
+
API. See the `dataworks-cli` skill, and run `dw commands --json` to discover the
|
|
20
|
+
exact command rather than exploring with `dw help`.
|
|
21
|
+
|
|
22
|
+
Reach for the CLI as readily as these tools; it is the same authenticated
|
|
23
|
+
session, not a fallback.
|
|
24
|
+
|
|
14
25
|
If `query_metrics` is unavailable, tell the user to run `dw agents install`
|
|
15
26
|
once in their terminal, then start a new Codex thread or run `/reload-plugins`
|
|
16
27
|
in Claude Code. Do not substitute raw GraphQL or guess that setup succeeded.
|
|
@@ -104,8 +115,10 @@ environment, tenant, canonical metric, order, and returned count. GPS rows inclu
|
|
|
104
115
|
decoded `position.latitude` and `position.longitude`; heart-rate values are
|
|
105
116
|
numeric with unit `bpm` when the source value is valid.
|
|
106
117
|
|
|
107
|
-
Every error carries a `recovery` field. Follow it rather than improvising
|
|
108
|
-
|
|
118
|
+
Every error carries a `recovery` field. Follow it rather than improvising. Do not
|
|
119
|
+
reach for raw GraphQL to work around a metric failure — but the `dw` CLI is a
|
|
120
|
+
first-class route for anything these tools do not cover, and the `dataworks-cli`
|
|
121
|
+
skill explains how to drive it.
|
|
109
122
|
|
|
110
123
|
- `ATHLETE_AMBIGUOUS` — present the candidates and ask the user to choose.
|
|
111
124
|
- `ATHLETE_NOT_FOUND` — the athlete is not in this tenant. Do not retry with
|
|
File without changes
|