@roarkanalytics/cli 0.14.0 → 0.16.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 +35 -23
- package/commands.js +392 -7
- package/completions.js +4 -4
- package/man/roark-benchmark-leaderboard-get.1 +114 -0
- package/man/roark-benchmark-metric-list.1 +96 -0
- package/man/roark-benchmark-suite-list.1 +89 -0
- package/man/roark-benchmark-target-get.1 +103 -0
- package/man/roark-benchmark-target-history-list.1 +106 -0
- package/man/roark-benchmark-target-score-sample-list.1 +112 -0
- package/man/roark-customer-flow-duplicate.1 +7 -0
- package/man/roark-simulation-persona-create.1 +2 -2
- package/man/roark-simulation-persona-update.1 +2 -2
- package/man/roark-simulation-plan-job-cancel.1 +93 -0
- package/man/roark.1 +21 -0
- package/npm-shrinkwrap.json +8 -8
- package/package.json +8 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-PLAN\-JOB\-CANCEL" "1" "" "roark-simulation-plan-job-cancel" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-plan\-job\-cancel \- Cancel a simulation plan job
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation plan job cancel
|
|
7
|
+
\fIjob\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Stops a run that has not finished yet. Already\-finished runs are left alone. Intended for CI: when a pipeline is cancelled or superseded, cancelling the run stops it placing calls you no longer need. Safe to call more than once.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/simulation/plan/job/{jobId}/cancel
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIjob\-id\fR
|
|
15
|
+
Simulation run plan job ID
|
|
16
|
+
.SH "GLOBAL OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
19
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
22
|
+
Skip confirmation prompts.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-no\-input\fR
|
|
25
|
+
Never prompt; fail instead.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
28
|
+
API base URL.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
31
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
34
|
+
Request timeout in milliseconds.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
37
|
+
Retries for retryable failures.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
40
|
+
Output format: auto, json, jsonl, plain.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-json\fR
|
|
43
|
+
Shorthand for \-\-format json.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-color\fR
|
|
46
|
+
Disable colour.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
49
|
+
Suppress non\-essential output.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
52
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
53
|
+
.SH "EXAMPLES"
|
|
54
|
+
.PP
|
|
55
|
+
.RS 4
|
|
56
|
+
.nf
|
|
57
|
+
roark simulation plan job cancel <job\-id>
|
|
58
|
+
.fi
|
|
59
|
+
.RE
|
|
60
|
+
.SH "ENVIRONMENT"
|
|
61
|
+
.TP
|
|
62
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
63
|
+
Bearer token used when \-\-token is not given.
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_BASE_URL\fR
|
|
66
|
+
API base URL.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
69
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
70
|
+
.TP
|
|
71
|
+
\fBNO_COLOR\fR
|
|
72
|
+
Disables colour when set to any value.
|
|
73
|
+
.SH "EXIT STATUS"
|
|
74
|
+
.TP
|
|
75
|
+
\fB0\fR
|
|
76
|
+
The command succeeded.
|
|
77
|
+
.TP
|
|
78
|
+
\fB1\fR
|
|
79
|
+
The API rejected the request.
|
|
80
|
+
.TP
|
|
81
|
+
\fB2\fR
|
|
82
|
+
The command line was wrong.
|
|
83
|
+
.TP
|
|
84
|
+
\fB3\fR
|
|
85
|
+
No credential, or the credential was refused.
|
|
86
|
+
.TP
|
|
87
|
+
\fB4\fR
|
|
88
|
+
The addressed resource does not exist.
|
|
89
|
+
.TP
|
|
90
|
+
\fB5\fR
|
|
91
|
+
The request never completed: connection, timeout, or abort.
|
|
92
|
+
.SH "SEE ALSO"
|
|
93
|
+
.BR roark (1)
|
package/man/roark.1
CHANGED
|
@@ -93,6 +93,24 @@ List a prompt's versions See roark\-agent\-prompt\-version\-list(1).
|
|
|
93
93
|
\fBroark agent update\fR
|
|
94
94
|
Update an agent See roark\-agent\-update(1).
|
|
95
95
|
.TP
|
|
96
|
+
\fBroark benchmark leaderboard get\fR
|
|
97
|
+
Get the benchmark leaderboard See roark\-benchmark\-leaderboard\-get(1).
|
|
98
|
+
.TP
|
|
99
|
+
\fBroark benchmark metric list\fR
|
|
100
|
+
List benchmark metrics See roark\-benchmark\-metric\-list(1).
|
|
101
|
+
.TP
|
|
102
|
+
\fBroark benchmark suite list\fR
|
|
103
|
+
List benchmark suites See roark\-benchmark\-suite\-list(1).
|
|
104
|
+
.TP
|
|
105
|
+
\fBroark benchmark target get\fR
|
|
106
|
+
Get a benchmark target See roark\-benchmark\-target\-get(1).
|
|
107
|
+
.TP
|
|
108
|
+
\fBroark benchmark target history list\fR
|
|
109
|
+
List a target’s published generations See roark\-benchmark\-target\-history\-list(1).
|
|
110
|
+
.TP
|
|
111
|
+
\fBroark benchmark target score\-sample list\fR
|
|
112
|
+
List score samples for a target See roark\-benchmark\-target\-score\-sample\-list(1).
|
|
113
|
+
.TP
|
|
96
114
|
\fBroark call create\fR
|
|
97
115
|
Create a call See roark\-call\-create(1).
|
|
98
116
|
.TP
|
|
@@ -261,6 +279,9 @@ Delete a run plan See roark\-simulation\-plan\-delete(1).
|
|
|
261
279
|
\fBroark simulation plan get\fR
|
|
262
280
|
Get run plan by ID See roark\-simulation\-plan\-get(1).
|
|
263
281
|
.TP
|
|
282
|
+
\fBroark simulation plan job cancel\fR
|
|
283
|
+
Cancel a simulation plan job See roark\-simulation\-plan\-job\-cancel(1).
|
|
284
|
+
.TP
|
|
264
285
|
\fBroark simulation plan job get\fR
|
|
265
286
|
Get simulation plan job See roark\-simulation\-plan\-job\-get(1).
|
|
266
287
|
.TP
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.16.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.16.0",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@roarkanalytics/sdk": "^3.2.1",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
}
|
|
22
22
|
},
|
|
23
23
|
"node_modules/@roarkanalytics/sdk": {
|
|
24
|
-
"version": "3.
|
|
25
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-3.
|
|
26
|
-
"integrity": "sha512-
|
|
24
|
+
"version": "3.12.0",
|
|
25
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-3.12.0.tgz",
|
|
26
|
+
"integrity": "sha512-ASlEQSCV+aRE2jyyDoxb6r2ll5Co/oGReEhHPFEEl5oDE4d8IVCsHstvjnIkMZZtbCxye1r+WrU9vlCH4MLT+g==",
|
|
27
27
|
"license": "Apache-2.0"
|
|
28
28
|
},
|
|
29
29
|
"node_modules/commander": {
|
|
@@ -36,9 +36,9 @@
|
|
|
36
36
|
}
|
|
37
37
|
},
|
|
38
38
|
"node_modules/yaml": {
|
|
39
|
-
"version": "2.9.
|
|
40
|
-
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.
|
|
41
|
-
"integrity": "sha512-
|
|
39
|
+
"version": "2.9.1",
|
|
40
|
+
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.1.tgz",
|
|
41
|
+
"integrity": "sha512-3NxN8+78OdzbT7C/WjGsyfPAtJaN3FNDsWxv7Y7mcDsT/oOmgW8BpyQQFFBnvZE3j9Y2Sdz1ULFLezL7Eb2yFw==",
|
|
42
42
|
"license": "ISC",
|
|
43
43
|
"bin": {
|
|
44
44
|
"yaml": "bin.mjs"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.16.0",
|
|
4
4
|
"description": "The official command line interface for the Roark API",
|
|
5
5
|
"author": "Roark <james@roark.ai>",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -46,6 +46,12 @@
|
|
|
46
46
|
"./man/roark-agent-prompt-update.1",
|
|
47
47
|
"./man/roark-agent-prompt-version-list.1",
|
|
48
48
|
"./man/roark-agent-update.1",
|
|
49
|
+
"./man/roark-benchmark-leaderboard-get.1",
|
|
50
|
+
"./man/roark-benchmark-metric-list.1",
|
|
51
|
+
"./man/roark-benchmark-suite-list.1",
|
|
52
|
+
"./man/roark-benchmark-target-get.1",
|
|
53
|
+
"./man/roark-benchmark-target-history-list.1",
|
|
54
|
+
"./man/roark-benchmark-target-score-sample-list.1",
|
|
49
55
|
"./man/roark-call-create.1",
|
|
50
56
|
"./man/roark-call-get.1",
|
|
51
57
|
"./man/roark-call-list.1",
|
|
@@ -102,6 +108,7 @@
|
|
|
102
108
|
"./man/roark-simulation-plan-create.1",
|
|
103
109
|
"./man/roark-simulation-plan-delete.1",
|
|
104
110
|
"./man/roark-simulation-plan-get.1",
|
|
111
|
+
"./man/roark-simulation-plan-job-cancel.1",
|
|
105
112
|
"./man/roark-simulation-plan-job-get.1",
|
|
106
113
|
"./man/roark-simulation-plan-job-list.1",
|
|
107
114
|
"./man/roark-simulation-plan-job-start.1",
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.16.0";
|
package/version.js
CHANGED