@roarkanalytics/cli 0.48.0 → 0.51.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 +35 -0
- package/README.md +5 -0
- package/commands.js +129 -1
- package/completions.js +4 -4
- package/man/roark-call-batch-delete.1 +93 -0
- package/man/roark-call-cost-get.1 +93 -0
- package/man/roark-call-delete.1 +93 -0
- package/man/roark-call-list.1 +3 -0
- package/man/roark-metric-collection-job-cancel.1 +93 -0
- package/man/roark-simulation-plan-job-cost-get.1 +93 -0
- package/man/roark-usage-get.1 +1 -1
- package/man/roark.1 +15 -0
- package/npm-shrinkwrap.json +3 -3
- package/package.json +7 -2
- 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\-CALL\-BATCH\-DELETE" "1" "" "roark-call-batch-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-call\-batch\-delete \- Delete calls in batch
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark call batch delete
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deletes up to 100 calls by ID in one request. Each deleted call, its metrics and its analysis are hidden from every read, and any analysis still running on it is cancelled. IDs that do not exist in this project, or were already deleted, are returned in notFoundCallIds and left untouched. The request succeeds even when none of the calls are found. IDs are returned lowercase, each once.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/call/batch\-delete
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-call\-ids\fR \fI<value>\fR
|
|
15
|
+
IDs of the calls to delete, at most 100. Repeated IDs are counted once. Repeatable. Required.
|
|
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 call batch delete \-\-call\-ids <value>
|
|
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)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CALL\-COST\-GET" "1" "" "roark-call-cost-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-call\-cost\-get \- Get call cost
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark call cost get
|
|
7
|
+
\fIcall\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
The billable spend attributed to one call, split by cost type, with every cost line behind it. Simulated calls include the costs their simulation incurred before the call connected. Amounts are billable spend only, in exact micro\-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/call/{callId}/cost
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcall\-id\fR
|
|
15
|
+
The call\-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 call cost get <call\-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)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CALL\-DELETE" "1" "" "roark-call-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-call\-delete \- Delete a call
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark call delete
|
|
7
|
+
\fIcall\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deletes a call by its ID. The call, its metrics and its analysis are hidden from every read, and any analysis still running on it is cancelled. Returns 404 when the call does not exist in this project or was already deleted.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/call/{callId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcall\-id\fR
|
|
15
|
+
The call\-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 call delete <call\-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-call-list.1
CHANGED
|
@@ -43,6 +43,9 @@ true: only simulated calls their run's results count (not invalidated, for examp
|
|
|
43
43
|
.TP
|
|
44
44
|
\fB\-\-exclude\-hidden\-runs\fR \fI<value>\fR
|
|
45
45
|
true: leave out calls from runs hidden from the runs list. Live calls stay in. false is the same as leaving it out. One of: true, false. Optional.
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-properties\fR \fI<value>\fR
|
|
48
|
+
Filter on custom properties, one entry per property name: properties[<name>][exists]=true keeps calls that have the property set (whatever the value), properties[<name>][exists]=false keeps calls missing it (never sent, sent as null, or removed). A property the project has never seen is missing on every call. Names match the way properties are stored, so planTier and plan_tier are one property. At most 20 properties; a name taken by a built\-in call filter, such as status, is rejected with 400. Optional.
|
|
46
49
|
.SH "GLOBAL OPTIONS"
|
|
47
50
|
.TP
|
|
48
51
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-METRIC\-COLLECTION\-JOB\-CANCEL" "1" "" "roark-metric-collection-job-cancel" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-metric\-collection\-job\-cancel \- Cancel a metric collection job
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark metric collection\-job cancel
|
|
7
|
+
\fIjob\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Stops a metric collection job that has not finished. No further conversations are processed and the job ends in CANCELED. Items the job had not reached are marked SKIPPED. Metric values already produced are kept, and items that were mid\-computation when the cancel arrived may still complete. Only the items that completed are billed. Safe to call more than once: a job that has already finished (COMPLETED, FAILED, or CANCELED) is returned unchanged.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/metric/collection\-jobs/{jobId}/cancel
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIjob\-id\fR
|
|
15
|
+
The ID of the metric collection job to cancel
|
|
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 metric collection\-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)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-PLAN\-JOB\-COST\-GET" "1" "" "roark-simulation-plan-job-cost-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-plan\-job\-cost\-get \- Get simulation run cost
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation plan job cost get
|
|
7
|
+
\fIjob\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
The billable spend for one simulation run (run plan job), split by cost type, with the spend of each simulated call in it. Safe to call while the run is in progress: totals reflect the costs recorded so far. Amounts are billable spend only, in exact micro\-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/simulation/plan/job/{jobId}/cost
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIjob\-id\fR
|
|
15
|
+
The 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 cost get <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-usage-get.1
CHANGED
|
@@ -6,7 +6,7 @@ roark\-usage\-get \- Get usage & cost
|
|
|
6
6
|
.B roark usage get
|
|
7
7
|
[\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
|
-
Report billable usage and cost for the organization over a time window, broken down by project (highest spend first). Pass `from`/`to` as ISO 8601 timestamps; optionally pass `projectId` to scope the report to one project. Amounts are billable spend only (what we absorb is never included). Authenticated by an organization API key with the `usage:read` permission.
|
|
9
|
+
Report billable usage and cost for the organization over a time window, broken down by project (highest spend first). Pass `from`/`to` as ISO 8601 timestamps; optionally pass `projectId` to scope the report to one project. Amounts are billable spend only (what we absorb is never included). Authenticated by either an organization API key with the `usage:read` permission (any project in the organization), or a project API key with the `billing:read` permission (that key's own project only; any other `projectId` is a 403).
|
|
10
10
|
.SH "API"
|
|
11
11
|
GET /v1/usage
|
|
12
12
|
.SH "OPTIONS"
|
package/man/roark.1
CHANGED
|
@@ -162,9 +162,18 @@ List a target’s published generations See roark\-benchmark\-target\-history\-l
|
|
|
162
162
|
\fBroark benchmark target score\-sample list\fR
|
|
163
163
|
List score samples for a target See roark\-benchmark\-target\-score\-sample\-list(1).
|
|
164
164
|
.TP
|
|
165
|
+
\fBroark call batch delete\fR
|
|
166
|
+
Delete calls in batch See roark\-call\-batch\-delete(1).
|
|
167
|
+
.TP
|
|
168
|
+
\fBroark call cost get\fR
|
|
169
|
+
Get call cost See roark\-call\-cost\-get(1).
|
|
170
|
+
.TP
|
|
165
171
|
\fBroark call create\fR
|
|
166
172
|
Create a call See roark\-call\-create(1).
|
|
167
173
|
.TP
|
|
174
|
+
\fBroark call delete\fR
|
|
175
|
+
Delete a call See roark\-call\-delete(1).
|
|
176
|
+
.TP
|
|
168
177
|
\fBroark call get\fR
|
|
169
178
|
Get a call by ID See roark\-call\-get(1).
|
|
170
179
|
.TP
|
|
@@ -282,6 +291,9 @@ List HTTP request definitions See roark\-http\-request\-definition\-list(1).
|
|
|
282
291
|
\fBroark http\-request\-definition update\fR
|
|
283
292
|
Update HTTP request definition See roark\-http\-request\-definition\-update(1).
|
|
284
293
|
.TP
|
|
294
|
+
\fBroark metric collection\-job cancel\fR
|
|
295
|
+
Cancel a metric collection job See roark\-metric\-collection\-job\-cancel(1).
|
|
296
|
+
.TP
|
|
285
297
|
\fBroark metric collection\-job create\fR
|
|
286
298
|
Create and run a metric collection job See roark\-metric\-collection\-job\-create(1).
|
|
287
299
|
.TP
|
|
@@ -399,6 +411,9 @@ Get run plan by ID See roark\-simulation\-plan\-get(1).
|
|
|
399
411
|
\fBroark simulation plan job cancel\fR
|
|
400
412
|
Cancel a simulation plan job See roark\-simulation\-plan\-job\-cancel(1).
|
|
401
413
|
.TP
|
|
414
|
+
\fBroark simulation plan job cost get\fR
|
|
415
|
+
Get simulation run cost See roark\-simulation\-plan\-job\-cost\-get(1).
|
|
416
|
+
.TP
|
|
402
417
|
\fBroark simulation plan job debrief create\fR
|
|
403
418
|
Generate simulation run debrief See roark\-simulation\-plan\-job\-debrief\-create(1).
|
|
404
419
|
.TP
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.51.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.51.1",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@roarkanalytics/sdk": "^5.
|
|
12
|
+
"@roarkanalytics/sdk": "^5.12.0",
|
|
13
13
|
"commander": "^14.0.3",
|
|
14
14
|
"yaml": "^2.9.0"
|
|
15
15
|
},
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.51.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": "^5.
|
|
32
|
+
"@roarkanalytics/sdk": "^5.12.0",
|
|
33
33
|
"commander": "^14.0.3",
|
|
34
34
|
"yaml": "^2.9.0"
|
|
35
35
|
},
|
|
@@ -69,7 +69,10 @@
|
|
|
69
69
|
"./man/roark-benchmark-target-get.1",
|
|
70
70
|
"./man/roark-benchmark-target-history-list.1",
|
|
71
71
|
"./man/roark-benchmark-target-score-sample-list.1",
|
|
72
|
+
"./man/roark-call-batch-delete.1",
|
|
73
|
+
"./man/roark-call-cost-get.1",
|
|
72
74
|
"./man/roark-call-create.1",
|
|
75
|
+
"./man/roark-call-delete.1",
|
|
73
76
|
"./man/roark-call-get.1",
|
|
74
77
|
"./man/roark-call-list.1",
|
|
75
78
|
"./man/roark-call-metric-list.1",
|
|
@@ -109,6 +112,7 @@
|
|
|
109
112
|
"./man/roark-http-request-definition-get.1",
|
|
110
113
|
"./man/roark-http-request-definition-list.1",
|
|
111
114
|
"./man/roark-http-request-definition-update.1",
|
|
115
|
+
"./man/roark-metric-collection-job-cancel.1",
|
|
112
116
|
"./man/roark-metric-collection-job-create.1",
|
|
113
117
|
"./man/roark-metric-collection-job-get.1",
|
|
114
118
|
"./man/roark-metric-collection-job-list.1",
|
|
@@ -148,6 +152,7 @@
|
|
|
148
152
|
"./man/roark-simulation-plan-delete.1",
|
|
149
153
|
"./man/roark-simulation-plan-get.1",
|
|
150
154
|
"./man/roark-simulation-plan-job-cancel.1",
|
|
155
|
+
"./man/roark-simulation-plan-job-cost-get.1",
|
|
151
156
|
"./man/roark-simulation-plan-job-debrief-create.1",
|
|
152
157
|
"./man/roark-simulation-plan-job-get.1",
|
|
153
158
|
"./man/roark-simulation-plan-job-list.1",
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.51.1";
|
package/version.js
CHANGED