@roarkanalytics/cli 0.39.0 → 0.41.1
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 +21 -0
- package/README.md +7 -0
- package/commands.js +218 -0
- package/completions.js +4 -4
- package/man/roark-simulation-plan-job-debrief-create.1 +97 -0
- package/man/roark-simulation-plan-job-result-get.1 +97 -0
- package/man/roark-simulation-run-group-create.1 +99 -0
- package/man/roark-simulation-run-group-delete.1 +93 -0
- package/man/roark-simulation-run-group-get.1 +93 -0
- package/man/roark-simulation-run-group-list.1 +96 -0
- package/man/roark-simulation-run-group-report-regenerate.1 +93 -0
- package/man/roark.1 +21 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +9 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.41.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.41.0...v0.41.1) (2026-10-12)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* **deps:** raise the @roarkanalytics/sdk floor to 5.3.0 ([#103](https://github.com/roarkhq/cli-roark-analytics/issues/103)) ([0148563](https://github.com/roarkhq/cli-roark-analytics/commit/0148563a7619a6275f76077643d05830570dd32d))
|
|
9
|
+
|
|
10
|
+
## [0.41.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.40.0...v0.41.0) (2026-10-12)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **cli:** cli update ([#101](https://github.com/roarkhq/cli-roark-analytics/issues/101)) ([77715f6](https://github.com/roarkhq/cli-roark-analytics/commit/77715f623719fdf28ad6acea7ff24b732fe25790))
|
|
16
|
+
|
|
17
|
+
## [0.40.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.39.0...v0.40.0) (2026-10-11)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* **cli:** cli update ([#99](https://github.com/roarkhq/cli-roark-analytics/issues/99)) ([0e7671a](https://github.com/roarkhq/cli-roark-analytics/commit/0e7671a8eb1c6849a66b2c470abf872495b8a7ed))
|
|
23
|
+
|
|
3
24
|
## [0.39.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.38.0...v0.39.0) (2026-10-08)
|
|
4
25
|
|
|
5
26
|
|
package/README.md
CHANGED
|
@@ -264,12 +264,19 @@ roark completion fish | source
|
|
|
264
264
|
| `roark simulation plan delete <plan-id>` | Delete a run plan |
|
|
265
265
|
| `roark simulation plan get <plan-id>` | Get run plan by ID |
|
|
266
266
|
| `roark simulation plan job cancel <job-id>` | Cancel a simulation plan job |
|
|
267
|
+
| `roark simulation plan job debrief create <job-id>` | Generate simulation run debrief |
|
|
267
268
|
| `roark simulation plan job get <job-id>` | Get simulation plan job |
|
|
268
269
|
| `roark simulation plan job list` | List simulation plan jobs |
|
|
270
|
+
| `roark simulation plan job result get <job-id>` | Get simulation run results |
|
|
269
271
|
| `roark simulation plan job start <plan-id>` | Run a simulation plan |
|
|
270
272
|
| `roark simulation plan list` | List run plans |
|
|
271
273
|
| `roark simulation plan update <plan-id>` | Update a run plan |
|
|
272
274
|
| `roark simulation run --data '{ ... }'` | Run a simulation |
|
|
275
|
+
| `roark simulation run-group create` | Create a run group |
|
|
276
|
+
| `roark simulation run-group delete <group-id>` | Delete a run group |
|
|
277
|
+
| `roark simulation run-group get <group-id>` | Get a run group |
|
|
278
|
+
| `roark simulation run-group list` | List run groups |
|
|
279
|
+
| `roark simulation run-group report regenerate <group-id>` | Regenerate a run group report |
|
|
273
280
|
| `roark simulation template list` | List simulation templates |
|
|
274
281
|
| `roark simulation tool mock --simulation-job-id <value> --tool-name <value>` | Mock a tool call during a test call |
|
|
275
282
|
| `roark simulation tool-fixture create --tool-name <value>` | Set a tool fixture |
|
package/commands.js
CHANGED
|
@@ -49,6 +49,10 @@ exports.GROUPS = {
|
|
|
49
49
|
'simulation persona': 'Manage simulation personas',
|
|
50
50
|
'simulation plan': 'Manage simulation plans',
|
|
51
51
|
'simulation plan job': 'Manage simulation plan jobs',
|
|
52
|
+
'simulation plan job debrief': 'Manage simulation plan job debrief',
|
|
53
|
+
'simulation plan job result': 'Read simulation plan job result',
|
|
54
|
+
'simulation run-group': 'Manage simulation run groups',
|
|
55
|
+
'simulation run-group report': 'Read simulation run group report',
|
|
52
56
|
'simulation template': 'Read simulation templates',
|
|
53
57
|
'simulation tool': 'Read simulation tool',
|
|
54
58
|
'simulation tool-fixture': 'Manage simulation tool fixtures',
|
|
@@ -4889,6 +4893,38 @@ exports.COMMANDS = [
|
|
|
4889
4893
|
acceptsBody: false,
|
|
4890
4894
|
requiresAuth: true,
|
|
4891
4895
|
},
|
|
4896
|
+
{
|
|
4897
|
+
commandPath: ['simulation', 'plan', 'job', 'debrief', 'create'],
|
|
4898
|
+
clientProperty: 'simulationRunPlanJob',
|
|
4899
|
+
methodName: 'createDebrief',
|
|
4900
|
+
httpMethod: 'post',
|
|
4901
|
+
httpPath: '/v1/simulation/plan/job/{jobId}/debrief',
|
|
4902
|
+
summary: 'Generate simulation run debrief',
|
|
4903
|
+
description: 'Request the written debrief for a settled run: executive summary, failure themes and recommendations. Runs with graded calls get one automatically, so this is for regenerating one (`regenerate: true`) or retrying one that failed. Returns immediately. Generation takes a few minutes: poll GET /v1/simulation/plan/job/{jobId}/results until `debrief.status` is READY or FAILED. Without `regenerate`, a debrief that is ready or already being written is returned as-is.',
|
|
4904
|
+
positionals: [
|
|
4905
|
+
{
|
|
4906
|
+
name: 'job-id',
|
|
4907
|
+
paramKey: 'jobId',
|
|
4908
|
+
},
|
|
4909
|
+
],
|
|
4910
|
+
flags: [
|
|
4911
|
+
{
|
|
4912
|
+
name: 'regenerate',
|
|
4913
|
+
path: ['regenerate'],
|
|
4914
|
+
location: 'body',
|
|
4915
|
+
required: false,
|
|
4916
|
+
description: 'Generate a new debrief even when a ready one exists. Without it, an existing ready or in-progress debrief is returned as-is.',
|
|
4917
|
+
valueKind: 'boolean',
|
|
4918
|
+
repeatable: false,
|
|
4919
|
+
},
|
|
4920
|
+
],
|
|
4921
|
+
hasParams: true,
|
|
4922
|
+
paramsAllOptional: true,
|
|
4923
|
+
bodyOpaque: false,
|
|
4924
|
+
bodyVariants: [],
|
|
4925
|
+
acceptsBody: true,
|
|
4926
|
+
requiresAuth: true,
|
|
4927
|
+
},
|
|
4892
4928
|
{
|
|
4893
4929
|
commandPath: ['simulation', 'plan', 'job', 'get'],
|
|
4894
4930
|
clientProperty: 'simulationRunPlanJob',
|
|
@@ -4998,6 +5034,38 @@ exports.COMMANDS = [
|
|
|
4998
5034
|
acceptsBody: false,
|
|
4999
5035
|
requiresAuth: true,
|
|
5000
5036
|
},
|
|
5037
|
+
{
|
|
5038
|
+
commandPath: ['simulation', 'plan', 'job', 'result', 'get'],
|
|
5039
|
+
clientProperty: 'simulationRunPlanJob',
|
|
5040
|
+
methodName: 'getResults',
|
|
5041
|
+
httpMethod: 'get',
|
|
5042
|
+
httpPath: '/v1/simulation/plan/job/{jobId}/results',
|
|
5043
|
+
summary: 'Get simulation run results',
|
|
5044
|
+
description: 'Everything the run report shows, in one request: the summary and score, the pass/fail verdict, per-metric aggregates, every simulation with its check results, breakdowns by agent and persona, the comparison against the previous run (or `compareToJobId`), the sweep attribution, and the written debrief with its executive summary, failure themes and recommendations. Safe to call while the run is in progress: counts reflect what has landed so far. `verdict` and `sweepAttribution` stay null until the run ends. The debrief is generated automatically a few minutes after a run with graded calls settles; poll until `debrief.status` is READY, or request one with POST /v1/simulation/plan/job/{jobId}/debrief.',
|
|
5045
|
+
positionals: [
|
|
5046
|
+
{
|
|
5047
|
+
name: 'job-id',
|
|
5048
|
+
paramKey: 'jobId',
|
|
5049
|
+
},
|
|
5050
|
+
],
|
|
5051
|
+
flags: [
|
|
5052
|
+
{
|
|
5053
|
+
name: 'compare-to-job-id',
|
|
5054
|
+
path: ['compareToJobId'],
|
|
5055
|
+
location: 'query',
|
|
5056
|
+
required: false,
|
|
5057
|
+
description: "Simulation run plan job to compare this run against, e.g. the last run on your main branch. Defaults to the plan's previous settled run. Any run in the project works, including another plan's: checks are matched by metric, and a check only one run graded reads null on the other side.",
|
|
5058
|
+
valueKind: 'string',
|
|
5059
|
+
repeatable: false,
|
|
5060
|
+
},
|
|
5061
|
+
],
|
|
5062
|
+
hasParams: true,
|
|
5063
|
+
paramsAllOptional: true,
|
|
5064
|
+
bodyOpaque: false,
|
|
5065
|
+
bodyVariants: [],
|
|
5066
|
+
acceptsBody: false,
|
|
5067
|
+
requiresAuth: true,
|
|
5068
|
+
},
|
|
5001
5069
|
{
|
|
5002
5070
|
commandPath: ['simulation', 'plan', 'job', 'start'],
|
|
5003
5071
|
clientProperty: 'simulationRunPlanJob',
|
|
@@ -5373,6 +5441,156 @@ exports.COMMANDS = [
|
|
|
5373
5441
|
acceptsBody: true,
|
|
5374
5442
|
requiresAuth: true,
|
|
5375
5443
|
},
|
|
5444
|
+
{
|
|
5445
|
+
commandPath: ['simulation', 'run-group', 'create'],
|
|
5446
|
+
clientProperty: 'simulationRunGroup',
|
|
5447
|
+
methodName: 'create',
|
|
5448
|
+
httpMethod: 'post',
|
|
5449
|
+
httpPath: '/v1/simulation/run-group',
|
|
5450
|
+
summary: 'Create a run group',
|
|
5451
|
+
description: 'Groups several simulation runs so they read as one, and starts generating the group report: one document across every run, with a scorecard summed across them and the issues found, each merged from the per-run debriefs. Send `simulationRunPlanJobIds` to group runs that already exist (runs still in progress are fine: the report waits for them). Send `simulationRunPlanIds` to start one run of each plan and group those; this places real calls, exactly as starting each plan would. Poll GET /v1/simulation/run-group/{groupId} until `latestReport.status` is READY.',
|
|
5452
|
+
positionals: [],
|
|
5453
|
+
flags: [
|
|
5454
|
+
{
|
|
5455
|
+
name: 'name',
|
|
5456
|
+
path: ['name'],
|
|
5457
|
+
location: 'body',
|
|
5458
|
+
required: false,
|
|
5459
|
+
description: "What to call the group. Defaults to the plans' names when starting plans, and to the runs' plan names when grouping existing runs.",
|
|
5460
|
+
valueKind: 'string',
|
|
5461
|
+
repeatable: false,
|
|
5462
|
+
},
|
|
5463
|
+
{
|
|
5464
|
+
name: 'simulation-run-plan-job-ids',
|
|
5465
|
+
path: ['simulationRunPlanJobIds'],
|
|
5466
|
+
location: 'body',
|
|
5467
|
+
required: false,
|
|
5468
|
+
description: 'Runs that already exist, in display order (2 to 20). Runs still in progress are fine: the group report waits for them. Send this or `simulationRunPlanIds`, not both.',
|
|
5469
|
+
valueKind: 'array',
|
|
5470
|
+
repeatable: true,
|
|
5471
|
+
},
|
|
5472
|
+
{
|
|
5473
|
+
name: 'simulation-run-plan-ids',
|
|
5474
|
+
path: ['simulationRunPlanIds'],
|
|
5475
|
+
location: 'body',
|
|
5476
|
+
required: false,
|
|
5477
|
+
description: 'Plans to run once each, in display order (2 to 20). Each plan starts a run, exactly as POST /v1/simulation/plan/{planId}/job would. Send this or `simulationRunPlanJobIds`, not both.',
|
|
5478
|
+
valueKind: 'array',
|
|
5479
|
+
repeatable: true,
|
|
5480
|
+
},
|
|
5481
|
+
],
|
|
5482
|
+
hasParams: true,
|
|
5483
|
+
paramsAllOptional: true,
|
|
5484
|
+
bodyOpaque: false,
|
|
5485
|
+
bodyVariants: [],
|
|
5486
|
+
acceptsBody: true,
|
|
5487
|
+
requiresAuth: true,
|
|
5488
|
+
},
|
|
5489
|
+
{
|
|
5490
|
+
commandPath: ['simulation', 'run-group', 'delete'],
|
|
5491
|
+
clientProperty: 'simulationRunGroup',
|
|
5492
|
+
methodName: 'delete',
|
|
5493
|
+
httpMethod: 'delete',
|
|
5494
|
+
httpPath: '/v1/simulation/run-group/{groupId}',
|
|
5495
|
+
summary: 'Delete a run group',
|
|
5496
|
+
description: 'Deletes a run group. Its runs, and their results, are untouched.',
|
|
5497
|
+
positionals: [
|
|
5498
|
+
{
|
|
5499
|
+
name: 'group-id',
|
|
5500
|
+
paramKey: 'groupId',
|
|
5501
|
+
description: 'The run group ID',
|
|
5502
|
+
},
|
|
5503
|
+
],
|
|
5504
|
+
flags: [],
|
|
5505
|
+
hasParams: false,
|
|
5506
|
+
paramsAllOptional: true,
|
|
5507
|
+
bodyOpaque: false,
|
|
5508
|
+
bodyVariants: [],
|
|
5509
|
+
acceptsBody: false,
|
|
5510
|
+
requiresAuth: true,
|
|
5511
|
+
},
|
|
5512
|
+
{
|
|
5513
|
+
commandPath: ['simulation', 'run-group', 'get'],
|
|
5514
|
+
clientProperty: 'simulationRunGroup',
|
|
5515
|
+
methodName: 'getByID',
|
|
5516
|
+
httpMethod: 'get',
|
|
5517
|
+
httpPath: '/v1/simulation/run-group/{groupId}',
|
|
5518
|
+
summary: 'Get a run group',
|
|
5519
|
+
description: 'Returns a run group with its runs in group order and its latest group report, including the report document once READY.',
|
|
5520
|
+
positionals: [
|
|
5521
|
+
{
|
|
5522
|
+
name: 'group-id',
|
|
5523
|
+
paramKey: 'groupId',
|
|
5524
|
+
description: 'The run group ID',
|
|
5525
|
+
},
|
|
5526
|
+
],
|
|
5527
|
+
flags: [],
|
|
5528
|
+
hasParams: false,
|
|
5529
|
+
paramsAllOptional: true,
|
|
5530
|
+
bodyOpaque: false,
|
|
5531
|
+
bodyVariants: [],
|
|
5532
|
+
acceptsBody: false,
|
|
5533
|
+
requiresAuth: true,
|
|
5534
|
+
},
|
|
5535
|
+
{
|
|
5536
|
+
commandPath: ['simulation', 'run-group', 'list'],
|
|
5537
|
+
clientProperty: 'simulationRunGroup',
|
|
5538
|
+
methodName: 'list',
|
|
5539
|
+
httpMethod: 'get',
|
|
5540
|
+
httpPath: '/v1/simulation/run-group',
|
|
5541
|
+
summary: 'List run groups',
|
|
5542
|
+
description: 'Returns the run groups in the project, newest first, with their runs and where each group report stands. Read a report document from GET /v1/simulation/run-group/{groupId}.',
|
|
5543
|
+
positionals: [],
|
|
5544
|
+
flags: [
|
|
5545
|
+
{
|
|
5546
|
+
name: 'limit',
|
|
5547
|
+
path: ['limit'],
|
|
5548
|
+
location: 'query',
|
|
5549
|
+
required: false,
|
|
5550
|
+
description: 'Maximum number of run groups to return (default: 20, max: 100)',
|
|
5551
|
+
valueKind: 'integer',
|
|
5552
|
+
repeatable: false,
|
|
5553
|
+
},
|
|
5554
|
+
{
|
|
5555
|
+
name: 'offset',
|
|
5556
|
+
path: ['offset'],
|
|
5557
|
+
location: 'query',
|
|
5558
|
+
required: false,
|
|
5559
|
+
description: 'Pagination offset',
|
|
5560
|
+
valueKind: 'integer',
|
|
5561
|
+
repeatable: false,
|
|
5562
|
+
},
|
|
5563
|
+
],
|
|
5564
|
+
hasParams: true,
|
|
5565
|
+
paramsAllOptional: true,
|
|
5566
|
+
bodyOpaque: false,
|
|
5567
|
+
bodyVariants: [],
|
|
5568
|
+
acceptsBody: false,
|
|
5569
|
+
requiresAuth: true,
|
|
5570
|
+
},
|
|
5571
|
+
{
|
|
5572
|
+
commandPath: ['simulation', 'run-group', 'report', 'regenerate'],
|
|
5573
|
+
clientProperty: 'simulationRunGroup',
|
|
5574
|
+
methodName: 'regenerateReport',
|
|
5575
|
+
httpMethod: 'post',
|
|
5576
|
+
httpPath: '/v1/simulation/run-group/{groupId}/report',
|
|
5577
|
+
summary: 'Regenerate a run group report',
|
|
5578
|
+
description: 'Generates the group report again over the latest state of its runs. Returns the report generation; if one is already in flight it is returned instead of starting another. Poll GET /v1/simulation/run-group/{groupId} until `latestReport.status` is READY.',
|
|
5579
|
+
positionals: [
|
|
5580
|
+
{
|
|
5581
|
+
name: 'group-id',
|
|
5582
|
+
paramKey: 'groupId',
|
|
5583
|
+
description: 'The run group ID',
|
|
5584
|
+
},
|
|
5585
|
+
],
|
|
5586
|
+
flags: [],
|
|
5587
|
+
hasParams: false,
|
|
5588
|
+
paramsAllOptional: true,
|
|
5589
|
+
bodyOpaque: false,
|
|
5590
|
+
bodyVariants: [],
|
|
5591
|
+
acceptsBody: false,
|
|
5592
|
+
requiresAuth: true,
|
|
5593
|
+
},
|
|
5376
5594
|
{
|
|
5377
5595
|
commandPath: ['simulation', 'template', 'list'],
|
|
5378
5596
|
clientProperty: 'simulationTemplate',
|