@roarkanalytics/cli 0.60.0 → 0.67.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 +63 -0
- package/README.md +36 -0
- package/commands.js +1054 -9
- package/completions.js +4 -4
- package/man/roark-calendar-connection-check.1 +93 -0
- package/man/roark-calendar-connection-create.1 +102 -0
- package/man/roark-calendar-connection-delete.1 +93 -0
- package/man/roark-calendar-connection-get.1 +93 -0
- package/man/roark-calendar-connection-list.1 +93 -0
- package/man/roark-calendar-connection-target-get.1 +96 -0
- package/man/roark-calendar-connection-target-list.1 +93 -0
- package/man/roark-calendar-connection-update.1 +103 -0
- package/man/roark-live-report-create.1 +135 -0
- package/man/roark-live-report-delete.1 +93 -0
- package/man/roark-live-report-document-get.1 +96 -0
- package/man/roark-live-report-document-list.1 +100 -0
- package/man/roark-live-report-get.1 +93 -0
- package/man/roark-live-report-list.1 +96 -0
- package/man/roark-live-report-run.1 +100 -0
- package/man/roark-live-report-update.1 +136 -0
- package/man/roark-metric-definition-update.1 +3 -0
- package/man/roark-metric-variant-update.1 +3 -0
- package/man/roark-tool-create.1 +123 -0
- package/man/roark-tool-delete.1 +93 -0
- package/man/roark-tool-get.1 +93 -0
- package/man/roark-tool-list.1 +96 -0
- package/man/roark-tool-update.1 +127 -0
- package/man/roark.1 +63 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +23 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-TOOL\-UPDATE" "1" "" "roark-tool-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-tool\-update \- Update a tool
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark tool update
|
|
7
|
+
\fItool\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Replaces the tool: its name, scope, inputs, description, grading hints and runtime. A field left out is cleared, so omitting agentId makes the tool project\-wide. A change declares a new version; agent versions pinned to an older one keep it.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PUT /v1/tool/{toolId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fItool\-id\fR
|
|
15
|
+
The tool\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
19
|
+
Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
22
|
+
When the agent should use the tool Required.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-agent\-id\fR \fI<value>\fR
|
|
25
|
+
Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-inputs\fR \fI<value>\fR
|
|
28
|
+
Optional.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-invocation\-criteria\fR \fI<value>\fR
|
|
31
|
+
Optional.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-expected\-result\fR \fI<value>\fR
|
|
34
|
+
Optional.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-runtime\fR \fI<value>\fR
|
|
37
|
+
Omit or null for a tool that is only graded Optional.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-runtime.request\fR \fI<value>\fR
|
|
40
|
+
Required.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-runtime.changes\-data\fR
|
|
43
|
+
Optional.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-runtime.response\-fields\fR \fI<value>\fR
|
|
46
|
+
Repeatable. Optional.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-runtime.messages\fR \fI<value>\fR
|
|
49
|
+
Optional.
|
|
50
|
+
.SH "GLOBAL OPTIONS"
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
53
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
56
|
+
Skip confirmation prompts.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-no\-input\fR
|
|
59
|
+
Never prompt; fail instead.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
62
|
+
API base URL.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
65
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
68
|
+
Request timeout in milliseconds.
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
71
|
+
Retries for retryable failures.
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
74
|
+
Output format: auto, json, jsonl, plain.
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-json\fR
|
|
77
|
+
Shorthand for \-\-format json.
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-\-no\-color\fR
|
|
80
|
+
Disable colour.
|
|
81
|
+
.TP
|
|
82
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
83
|
+
Suppress non\-essential output.
|
|
84
|
+
.TP
|
|
85
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
86
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
87
|
+
.SH "EXAMPLES"
|
|
88
|
+
.PP
|
|
89
|
+
.RS 4
|
|
90
|
+
.nf
|
|
91
|
+
roark tool update <tool\-id> \-\-name <value> \-\-description <value> \-\-runtime.request <value>
|
|
92
|
+
.fi
|
|
93
|
+
.RE
|
|
94
|
+
.SH "ENVIRONMENT"
|
|
95
|
+
.TP
|
|
96
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
97
|
+
Bearer token used when \-\-token is not given.
|
|
98
|
+
.TP
|
|
99
|
+
\fBROARK_BASE_URL\fR
|
|
100
|
+
API base URL.
|
|
101
|
+
.TP
|
|
102
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
103
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
104
|
+
.TP
|
|
105
|
+
\fBNO_COLOR\fR
|
|
106
|
+
Disables colour when set to any value.
|
|
107
|
+
.SH "EXIT STATUS"
|
|
108
|
+
.TP
|
|
109
|
+
\fB0\fR
|
|
110
|
+
The command succeeded.
|
|
111
|
+
.TP
|
|
112
|
+
\fB1\fR
|
|
113
|
+
The API rejected the request.
|
|
114
|
+
.TP
|
|
115
|
+
\fB2\fR
|
|
116
|
+
The command line was wrong.
|
|
117
|
+
.TP
|
|
118
|
+
\fB3\fR
|
|
119
|
+
No credential, or the credential was refused.
|
|
120
|
+
.TP
|
|
121
|
+
\fB4\fR
|
|
122
|
+
The addressed resource does not exist.
|
|
123
|
+
.TP
|
|
124
|
+
\fB5\fR
|
|
125
|
+
The request never completed: connection, timeout, or abort.
|
|
126
|
+
.SH "SEE ALSO"
|
|
127
|
+
.BR roark (1)
|
package/man/roark.1
CHANGED
|
@@ -186,6 +186,30 @@ List a target’s published generations See roark\-benchmark\-target\-history\-l
|
|
|
186
186
|
\fBroark benchmark target score\-sample list\fR
|
|
187
187
|
List score samples for a target See roark\-benchmark\-target\-score\-sample\-list(1).
|
|
188
188
|
.TP
|
|
189
|
+
\fBroark calendar\-connection check\fR
|
|
190
|
+
Check a calendar connection See roark\-calendar\-connection\-check(1).
|
|
191
|
+
.TP
|
|
192
|
+
\fBroark calendar\-connection create\fR
|
|
193
|
+
Connect a calendar account See roark\-calendar\-connection\-create(1).
|
|
194
|
+
.TP
|
|
195
|
+
\fBroark calendar\-connection delete\fR
|
|
196
|
+
Delete a calendar connection See roark\-calendar\-connection\-delete(1).
|
|
197
|
+
.TP
|
|
198
|
+
\fBroark calendar\-connection get\fR
|
|
199
|
+
Get a calendar connection See roark\-calendar\-connection\-get(1).
|
|
200
|
+
.TP
|
|
201
|
+
\fBroark calendar\-connection list\fR
|
|
202
|
+
List calendar connections See roark\-calendar\-connection\-list(1).
|
|
203
|
+
.TP
|
|
204
|
+
\fBroark calendar\-connection target get\fR
|
|
205
|
+
Read one bookable target See roark\-calendar\-connection\-target\-get(1).
|
|
206
|
+
.TP
|
|
207
|
+
\fBroark calendar\-connection target list\fR
|
|
208
|
+
List what can be booked on a calendar See roark\-calendar\-connection\-target\-list(1).
|
|
209
|
+
.TP
|
|
210
|
+
\fBroark calendar\-connection update\fR
|
|
211
|
+
Update a calendar connection See roark\-calendar\-connection\-update(1).
|
|
212
|
+
.TP
|
|
189
213
|
\fBroark call batch delete\fR
|
|
190
214
|
Delete calls in batch See roark\-call\-batch\-delete(1).
|
|
191
215
|
.TP
|
|
@@ -315,6 +339,30 @@ List HTTP request definitions See roark\-http\-request\-definition\-list(1).
|
|
|
315
339
|
\fBroark http\-request\-definition update\fR
|
|
316
340
|
Update HTTP request definition See roark\-http\-request\-definition\-update(1).
|
|
317
341
|
.TP
|
|
342
|
+
\fBroark live\-report create\fR
|
|
343
|
+
Create a live report See roark\-live\-report\-create(1).
|
|
344
|
+
.TP
|
|
345
|
+
\fBroark live\-report delete\fR
|
|
346
|
+
Delete a live report See roark\-live\-report\-delete(1).
|
|
347
|
+
.TP
|
|
348
|
+
\fBroark live\-report document get\fR
|
|
349
|
+
Get a report document See roark\-live\-report\-document\-get(1).
|
|
350
|
+
.TP
|
|
351
|
+
\fBroark live\-report document list\fR
|
|
352
|
+
List report documents See roark\-live\-report\-document\-list(1).
|
|
353
|
+
.TP
|
|
354
|
+
\fBroark live\-report get\fR
|
|
355
|
+
Get a live report See roark\-live\-report\-get(1).
|
|
356
|
+
.TP
|
|
357
|
+
\fBroark live\-report list\fR
|
|
358
|
+
List live reports See roark\-live\-report\-list(1).
|
|
359
|
+
.TP
|
|
360
|
+
\fBroark live\-report run\fR
|
|
361
|
+
Generate a live report document See roark\-live\-report\-run(1).
|
|
362
|
+
.TP
|
|
363
|
+
\fBroark live\-report update\fR
|
|
364
|
+
Update a live report See roark\-live\-report\-update(1).
|
|
365
|
+
.TP
|
|
318
366
|
\fBroark metric collection\-job cancel\fR
|
|
319
367
|
Cancel a metric collection job See roark\-metric\-collection\-job\-cancel(1).
|
|
320
368
|
.TP
|
|
@@ -513,6 +561,21 @@ List tool fixtures See roark\-simulation\-tool\-fixture\-list(1).
|
|
|
513
561
|
\fBroark simulation tool\-fixture update\fR
|
|
514
562
|
Update a tool fixture See roark\-simulation\-tool\-fixture\-update(1).
|
|
515
563
|
.TP
|
|
564
|
+
\fBroark tool create\fR
|
|
565
|
+
Create a tool See roark\-tool\-create(1).
|
|
566
|
+
.TP
|
|
567
|
+
\fBroark tool delete\fR
|
|
568
|
+
Delete a tool See roark\-tool\-delete(1).
|
|
569
|
+
.TP
|
|
570
|
+
\fBroark tool get\fR
|
|
571
|
+
Get a tool See roark\-tool\-get(1).
|
|
572
|
+
.TP
|
|
573
|
+
\fBroark tool list\fR
|
|
574
|
+
List tools See roark\-tool\-list(1).
|
|
575
|
+
.TP
|
|
576
|
+
\fBroark tool update\fR
|
|
577
|
+
Update a tool See roark\-tool\-update(1).
|
|
578
|
+
.TP
|
|
516
579
|
\fBroark usage get\fR
|
|
517
580
|
Get usage & cost See roark\-usage\-get(1).
|
|
518
581
|
.TP
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.67.1",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@roarkanalytics/cli",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.67.1",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@roarkanalytics/sdk": "^
|
|
12
|
+
"@roarkanalytics/sdk": "^7.0.0",
|
|
13
13
|
"commander": "^14.0.3",
|
|
14
14
|
"jiti": "^2.4.2",
|
|
15
15
|
"yaml": "^2.9.0"
|
|
@@ -22,9 +22,9 @@
|
|
|
22
22
|
}
|
|
23
23
|
},
|
|
24
24
|
"node_modules/@roarkanalytics/sdk": {
|
|
25
|
-
"version": "
|
|
26
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-
|
|
27
|
-
"integrity": "sha512
|
|
25
|
+
"version": "7.0.0",
|
|
26
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-7.0.0.tgz",
|
|
27
|
+
"integrity": "sha512-/sTFJcJPj426aSvJZQd5+fk04d4V0ugjOyEVO95PvWaoTrIJffor9Y+yYyNTXlWvogi/iVaXv/w2oDUa4jtVeA==",
|
|
28
28
|
"license": "Apache-2.0"
|
|
29
29
|
},
|
|
30
30
|
"node_modules/commander": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.67.1",
|
|
4
4
|
"description": "The official command line interface for the Roark API",
|
|
5
5
|
"author": "Roark <james@roark.ai>",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"fix": "eslint --fix . && prettier --write ."
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@roarkanalytics/sdk": "^
|
|
32
|
+
"@roarkanalytics/sdk": "^7.0.0",
|
|
33
33
|
"commander": "^14.0.3",
|
|
34
34
|
"jiti": "^2.4.2",
|
|
35
35
|
"yaml": "^2.9.0"
|
|
@@ -78,6 +78,14 @@
|
|
|
78
78
|
"./man/roark-benchmark-target-get.1",
|
|
79
79
|
"./man/roark-benchmark-target-history-list.1",
|
|
80
80
|
"./man/roark-benchmark-target-score-sample-list.1",
|
|
81
|
+
"./man/roark-calendar-connection-check.1",
|
|
82
|
+
"./man/roark-calendar-connection-create.1",
|
|
83
|
+
"./man/roark-calendar-connection-delete.1",
|
|
84
|
+
"./man/roark-calendar-connection-get.1",
|
|
85
|
+
"./man/roark-calendar-connection-list.1",
|
|
86
|
+
"./man/roark-calendar-connection-target-get.1",
|
|
87
|
+
"./man/roark-calendar-connection-target-list.1",
|
|
88
|
+
"./man/roark-calendar-connection-update.1",
|
|
81
89
|
"./man/roark-call-batch-delete.1",
|
|
82
90
|
"./man/roark-call-cost-get.1",
|
|
83
91
|
"./man/roark-call-create.1",
|
|
@@ -121,6 +129,14 @@
|
|
|
121
129
|
"./man/roark-http-request-definition-get.1",
|
|
122
130
|
"./man/roark-http-request-definition-list.1",
|
|
123
131
|
"./man/roark-http-request-definition-update.1",
|
|
132
|
+
"./man/roark-live-report-create.1",
|
|
133
|
+
"./man/roark-live-report-delete.1",
|
|
134
|
+
"./man/roark-live-report-document-get.1",
|
|
135
|
+
"./man/roark-live-report-document-list.1",
|
|
136
|
+
"./man/roark-live-report-get.1",
|
|
137
|
+
"./man/roark-live-report-list.1",
|
|
138
|
+
"./man/roark-live-report-run.1",
|
|
139
|
+
"./man/roark-live-report-update.1",
|
|
124
140
|
"./man/roark-metric-collection-job-cancel.1",
|
|
125
141
|
"./man/roark-metric-collection-job-create.1",
|
|
126
142
|
"./man/roark-metric-collection-job-get.1",
|
|
@@ -187,6 +203,11 @@
|
|
|
187
203
|
"./man/roark-simulation-tool-fixture-delete.1",
|
|
188
204
|
"./man/roark-simulation-tool-fixture-list.1",
|
|
189
205
|
"./man/roark-simulation-tool-fixture-update.1",
|
|
206
|
+
"./man/roark-tool-create.1",
|
|
207
|
+
"./man/roark-tool-delete.1",
|
|
208
|
+
"./man/roark-tool-get.1",
|
|
209
|
+
"./man/roark-tool-list.1",
|
|
210
|
+
"./man/roark-tool-update.1",
|
|
190
211
|
"./man/roark-usage-get.1",
|
|
191
212
|
"./man/roark-webhook-create.1",
|
|
192
213
|
"./man/roark-webhook-delete.1",
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.67.1";
|
package/version.js
CHANGED