@roarkanalytics/cli 0.6.0 → 0.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/CHANGELOG.md +7 -0
- package/commands.js +5 -1
- package/man/roark-simulation-run.1 +4 -1
- package/npm-shrinkwrap.json +2 -2
- package/package.json +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.7.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.6.0...v0.7.0) (2026-09-08)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **cli:** cli update ([#21](https://github.com/roarkhq/cli-roark-analytics/issues/21)) ([5ae1ec8](https://github.com/roarkhq/cli-roark-analytics/commit/5ae1ec8f65f63e07ecdd54427de9f5232bb26c2c))
|
|
9
|
+
|
|
3
10
|
## [0.6.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.5.0...v0.6.0) (2026-09-08)
|
|
4
11
|
|
|
5
12
|
|
package/commands.js
CHANGED
|
@@ -3943,7 +3943,7 @@ exports.COMMANDS = [
|
|
|
3943
3943
|
httpMethod: 'post',
|
|
3944
3944
|
httpPath: '/v1/simulation/run',
|
|
3945
3945
|
summary: 'Run a simulation',
|
|
3946
|
-
description: 'Starts a simulation and returns the run. Send `plan` to describe a simulation and run it once.
|
|
3946
|
+
description: 'Starts a simulation and returns the run. Send `template` to run one of the built-in templates: it supplies the metrics and checks, and for some templates the flows too, so the request only names the agent and the direction. Send `plan` to describe a simulation yourself and run it once. Send `planId` to run a plan you already have. `template` and `plan` both resolve to a run plan, returned as `simulationRunPlanId`. Add `saveAsPlan` to keep it, or read it back to see exactly what ran. A plan built from a template is a snapshot: retuning the template later never changes what that plan runs, which is what makes a saved one safe to pin in CI.',
|
|
3947
3947
|
positionals: [],
|
|
3948
3948
|
flags: [],
|
|
3949
3949
|
hasParams: true,
|
|
@@ -3958,6 +3958,10 @@ exports.COMMANDS = [
|
|
|
3958
3958
|
name: 'RunSimulationFromPlanId',
|
|
3959
3959
|
required: ['planId'],
|
|
3960
3960
|
},
|
|
3961
|
+
{
|
|
3962
|
+
name: 'RunSimulationFromTemplate',
|
|
3963
|
+
required: ['template', 'agentEndpoints', 'direction'],
|
|
3964
|
+
},
|
|
3961
3965
|
],
|
|
3962
3966
|
acceptsBody: true,
|
|
3963
3967
|
requiresAuth: true,
|
|
@@ -6,7 +6,7 @@ roark\-simulation\-run \- Run a simulation
|
|
|
6
6
|
.B roark simulation run
|
|
7
7
|
[\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
|
-
Starts a simulation and returns the run. Send `plan` to describe a simulation and run it once.
|
|
9
|
+
Starts a simulation and returns the run. Send `template` to run one of the built\-in templates: it supplies the metrics and checks, and for some templates the flows too, so the request only names the agent and the direction. Send `plan` to describe a simulation yourself and run it once. Send `planId` to run a plan you already have. `template` and `plan` both resolve to a run plan, returned as `simulationRunPlanId`. Add `saveAsPlan` to keep it, or read it back to see exactly what ran. A plan built from a template is a snapshot: retuning the template later never changes what that plan runs, which is what makes a saved one safe to pin in CI.
|
|
10
10
|
.SH "API"
|
|
11
11
|
POST /v1/simulation/run
|
|
12
12
|
.SH "REQUEST BODY"
|
|
@@ -17,6 +17,9 @@ Requires plan.
|
|
|
17
17
|
.TP
|
|
18
18
|
\fBRunSimulationFromPlanId\fR
|
|
19
19
|
Requires planId.
|
|
20
|
+
.TP
|
|
21
|
+
\fBRunSimulationFromTemplate\fR
|
|
22
|
+
Requires template, agentEndpoints, direction.
|
|
20
23
|
.SH "GLOBAL OPTIONS"
|
|
21
24
|
.TP
|
|
22
25
|
\fB\-\-data\fR \fI<json>\fR
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.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.7.0",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@roarkanalytics/sdk": "^3.2.1",
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.7.0";
|
package/version.js
CHANGED