@roarkanalytics/cli 0.32.1 → 0.34.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/CHANGELOG.md +14 -0
- package/README.md +30 -30
- package/commands.js +3 -3
- package/man/roark-metric-definition-update.1 +1 -1
- package/man/roark-simulation-plan-create.1 +2 -2
- package/npm-shrinkwrap.json +5 -5
- package/package.json +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.34.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.33.0...v0.34.0) (2026-10-02)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **cli:** cli update ([#85](https://github.com/roarkhq/cli-roark-analytics/issues/85)) ([69d2886](https://github.com/roarkhq/cli-roark-analytics/commit/69d28866a8e168039072c32fddfea20389dd43b0))
|
|
9
|
+
|
|
10
|
+
## [0.33.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.32.1...v0.33.0) (2026-10-02)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **cli:** cli update ([#83](https://github.com/roarkhq/cli-roark-analytics/issues/83)) ([441c878](https://github.com/roarkhq/cli-roark-analytics/commit/441c878ba6ddd5549ec4570a36ed8e41a2d5c609))
|
|
16
|
+
|
|
3
17
|
## [0.32.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.32.0...v0.32.1) (2026-09-30)
|
|
4
18
|
|
|
5
19
|
|
package/README.md
CHANGED
|
@@ -238,36 +238,36 @@ roark completion fish | source
|
|
|
238
238
|
|
|
239
239
|
### simulation
|
|
240
240
|
|
|
241
|
-
| Command
|
|
242
|
-
|
|
|
243
|
-
| `roark simulation environment create --name <value> --background-noise <value>`
|
|
244
|
-
| `roark simulation environment delete <environment-id>`
|
|
245
|
-
| `roark simulation environment get <environment-id>`
|
|
246
|
-
| `roark simulation environment list`
|
|
247
|
-
| `roark simulation environment update <environment-id>`
|
|
248
|
-
| `roark simulation job get <job-id>`
|
|
249
|
-
| `roark simulation job lookup --roark-phone-number <value>`
|
|
250
|
-
| `roark simulation job tool-mock list <job-id>`
|
|
251
|
-
| `roark simulation persona create --name <value> --language <value> --accent <value> --gender <value>`
|
|
252
|
-
| `roark simulation persona get <persona-id>`
|
|
253
|
-
| `roark simulation persona list`
|
|
254
|
-
| `roark simulation persona update <persona-id>`
|
|
255
|
-
| `roark simulation plan create --name <value> --direction <value> --max-simulation-duration-seconds <value> --agent-endpoints <value
|
|
256
|
-
| `roark simulation plan delete <plan-id>`
|
|
257
|
-
| `roark simulation plan get <plan-id>`
|
|
258
|
-
| `roark simulation plan job cancel <job-id>`
|
|
259
|
-
| `roark simulation plan job get <job-id>`
|
|
260
|
-
| `roark simulation plan job list`
|
|
261
|
-
| `roark simulation plan job start <plan-id>`
|
|
262
|
-
| `roark simulation plan list`
|
|
263
|
-
| `roark simulation plan update <plan-id>`
|
|
264
|
-
| `roark simulation run --data '{ ... }'`
|
|
265
|
-
| `roark simulation template list`
|
|
266
|
-
| `roark simulation tool mock --simulation-job-id <value> --tool-name <value>`
|
|
267
|
-
| `roark simulation tool-fixture create --tool-name <value>`
|
|
268
|
-
| `roark simulation tool-fixture delete <fixture-id>`
|
|
269
|
-
| `roark simulation tool-fixture list`
|
|
270
|
-
| `roark simulation tool-fixture update <fixture-id>`
|
|
241
|
+
| Command | Description |
|
|
242
|
+
| ------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
|
|
243
|
+
| `roark simulation environment create --name <value> --background-noise <value>` | Create an environment |
|
|
244
|
+
| `roark simulation environment delete <environment-id>` | Delete an environment |
|
|
245
|
+
| `roark simulation environment get <environment-id>` | Get environment by ID |
|
|
246
|
+
| `roark simulation environment list` | List environments |
|
|
247
|
+
| `roark simulation environment update <environment-id>` | Update an environment |
|
|
248
|
+
| `roark simulation job get <job-id>` | Get simulation by ID |
|
|
249
|
+
| `roark simulation job lookup --roark-phone-number <value>` | Lookup by phone number |
|
|
250
|
+
| `roark simulation job tool-mock list <job-id>` | List mocked tool invocations |
|
|
251
|
+
| `roark simulation persona create --name <value> --language <value> --accent <value> --gender <value>` | Create a new persona |
|
|
252
|
+
| `roark simulation persona get <persona-id>` | Get persona by ID |
|
|
253
|
+
| `roark simulation persona list` | List personas |
|
|
254
|
+
| `roark simulation persona update <persona-id>` | Update a persona |
|
|
255
|
+
| `roark simulation plan create --name <value> --direction <value> --max-simulation-duration-seconds <value> --agent-endpoints <value>` | Create a run plan |
|
|
256
|
+
| `roark simulation plan delete <plan-id>` | Delete a run plan |
|
|
257
|
+
| `roark simulation plan get <plan-id>` | Get run plan by ID |
|
|
258
|
+
| `roark simulation plan job cancel <job-id>` | Cancel a simulation plan job |
|
|
259
|
+
| `roark simulation plan job get <job-id>` | Get simulation plan job |
|
|
260
|
+
| `roark simulation plan job list` | List simulation plan jobs |
|
|
261
|
+
| `roark simulation plan job start <plan-id>` | Run a simulation plan |
|
|
262
|
+
| `roark simulation plan list` | List run plans |
|
|
263
|
+
| `roark simulation plan update <plan-id>` | Update a run plan |
|
|
264
|
+
| `roark simulation run --data '{ ... }'` | Run a simulation |
|
|
265
|
+
| `roark simulation template list` | List simulation templates |
|
|
266
|
+
| `roark simulation tool mock --simulation-job-id <value> --tool-name <value>` | Mock a tool call during a test call |
|
|
267
|
+
| `roark simulation tool-fixture create --tool-name <value>` | Set a tool fixture |
|
|
268
|
+
| `roark simulation tool-fixture delete <fixture-id>` | Delete a tool fixture |
|
|
269
|
+
| `roark simulation tool-fixture list` | List tool fixtures |
|
|
270
|
+
| `roark simulation tool-fixture update <fixture-id>` | Update a tool fixture |
|
|
271
271
|
|
|
272
272
|
### webhook
|
|
273
273
|
|
package/commands.js
CHANGED
|
@@ -3004,7 +3004,7 @@ exports.COMMANDS = [
|
|
|
3004
3004
|
path: ['supportedContexts'],
|
|
3005
3005
|
location: 'body',
|
|
3006
3006
|
required: false,
|
|
3007
|
-
description: 'Replacement set of supported contexts. Omit to leave unchanged.',
|
|
3007
|
+
description: 'Replacement set of supported contexts. Omit to leave unchanged. Scope and participantRole cannot change after create, so moving to SEGMENT or TURN grading only works on a PER_PARTICIPANT metric (see create).',
|
|
3008
3008
|
valueKind: 'array',
|
|
3009
3009
|
enumValues: ['CALL', 'SEGMENT', 'TURN'],
|
|
3010
3010
|
repeatable: true,
|
|
@@ -4782,8 +4782,8 @@ exports.COMMANDS = [
|
|
|
4782
4782
|
name: 'metrics',
|
|
4783
4783
|
path: ['metrics'],
|
|
4784
4784
|
location: 'body',
|
|
4785
|
-
required:
|
|
4786
|
-
description: 'Metric definitions to include in this run plan. Reference each by `id` (UUID) or `slug`.',
|
|
4785
|
+
required: false,
|
|
4786
|
+
description: 'Metric definitions to include in this run plan. Reference each by `id` (UUID) or `slug`. Optional when the attached `flows` carry the grading: metrics a flow declares itself (with `includeFlowMetrics`), or the Agent Expectations and Keypad Entry metrics a run adds for flows with expectations or expected keypad entries (with `includeAutomaticMetrics`). A plan with nothing to grade is rejected with a 400.',
|
|
4787
4787
|
valueKind: 'array',
|
|
4788
4788
|
repeatable: false,
|
|
4789
4789
|
},
|
|
@@ -46,7 +46,7 @@ New maximum number of classifications (CLASSIFICATION output only) Optional.
|
|
|
46
46
|
Replacement set of scoped tool\-definition ids (only for metrics whose tool scoping is editable) Repeatable. Optional.
|
|
47
47
|
.TP
|
|
48
48
|
\fB\-\-supported\-contexts\fR \fI<value>\fR
|
|
49
|
-
Replacement set of supported contexts. Omit to leave unchanged. One of: CALL, SEGMENT, TURN. Repeatable. Optional.
|
|
49
|
+
Replacement set of supported contexts. Omit to leave unchanged. Scope and participantRole cannot change after create, so moving to SEGMENT or TURN grading only works on a PER_PARTICIPANT metric (see create). One of: CALL, SEGMENT, TURN. Repeatable. Optional.
|
|
50
50
|
.TP
|
|
51
51
|
\fB\-\-formula\fR \fI<value>\fR
|
|
52
52
|
New formula expression (FORMULA only). Pass `sources` alongside if the referenced metrics change. Optional.
|
|
@@ -54,7 +54,7 @@ Personas to include in this run plan. Required with `scenarios`; ignored with `f
|
|
|
54
54
|
Agent endpoints to include in this run plan Required.
|
|
55
55
|
.TP
|
|
56
56
|
\fB\-\-metrics\fR \fI<value>\fR
|
|
57
|
-
Metric definitions to include in this run plan. Reference each by `id` (UUID) or `slug`.
|
|
57
|
+
Metric definitions to include in this run plan. Reference each by `id` (UUID) or `slug`. Optional when the attached `flows` carry the grading: metrics a flow declares itself (with `includeFlowMetrics`), or the Agent Expectations and Keypad Entry metrics a run adds for flows with expectations or expected keypad entries (with `includeAutomaticMetrics`). A plan with nothing to grade is rejected with a 400. Optional.
|
|
58
58
|
.TP
|
|
59
59
|
\fB\-\-include\-flow\-metrics\fR
|
|
60
60
|
Also collect each attached flow's own metrics, on top of the `metrics` named here. Default true, which is what you want when you brought your own flows and their graders. Set false for a run whose metric list is meant to be exhaustive: a template like Load Testing or Voicemail deliberately grades a narrow set, and inheriting every flow metric on top multiplies analysis cost across the volume without adding signal. GET /v1/simulation/template returns the value each template expects. Optional.
|
|
@@ -117,7 +117,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
|
|
|
117
117
|
.PP
|
|
118
118
|
.RS 4
|
|
119
119
|
.nf
|
|
120
|
-
roark simulation plan create \-\-name <value> \-\-direction <value> \-\-max\-simulation\-duration\-seconds <value> \-\-agent\-endpoints <value>
|
|
120
|
+
roark simulation plan create \-\-name <value> \-\-direction <value> \-\-max\-simulation\-duration\-seconds <value> \-\-agent\-endpoints <value>
|
|
121
121
|
.fi
|
|
122
122
|
.RE
|
|
123
123
|
.SH "ENVIRONMENT"
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.34.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@roarkanalytics/cli",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.34.0",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@roarkanalytics/sdk": "^4.15.0",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
}
|
|
22
22
|
},
|
|
23
23
|
"node_modules/@roarkanalytics/sdk": {
|
|
24
|
-
"version": "4.
|
|
25
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.
|
|
26
|
-
"integrity": "sha512
|
|
24
|
+
"version": "4.19.0",
|
|
25
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.19.0.tgz",
|
|
26
|
+
"integrity": "sha512-m9y4PKaC7pn2CFpWCOHJFSDruyOYlcEK4QQdLU0semjNqZcW9ZRCrMAN+XctPC5ulEfq0W8zmi8bKyMrYbXzyg==",
|
|
27
27
|
"license": "Apache-2.0"
|
|
28
28
|
},
|
|
29
29
|
"node_modules/commander": {
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.34.0";
|
package/version.js
CHANGED