@roarkanalytics/cli 0.35.0 → 0.37.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 +8 -0
- package/commands.js +153 -0
- package/completions.js +4 -4
- package/man/roark-call-list.1 +12 -0
- package/man/roark-credential-create.1 +105 -0
- package/man/roark-credential-list.1 +93 -0
- package/man/roark-credential-revoke.1 +93 -0
- package/man/roark.1 +9 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +5 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/man/roark-call-list.1
CHANGED
|
@@ -31,6 +31,18 @@ Search text to filter calls by title, summary, or transcript Optional.
|
|
|
31
31
|
.TP
|
|
32
32
|
\fB\-\-simulation\-run\-plan\-job\-id\fR \fI<value>\fR
|
|
33
33
|
Filter by simulation run plan job ID to get all calls from a specific simulation batch Optional.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-simulation\-run\-plan\-job\-ids\fR \fI<value>\fR
|
|
36
|
+
Calls from any of these simulation runs (run plan job ids), comma\-separated, at most 100 Optional.
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-simulation\-run\-plan\-ids\fR \fI<value>\fR
|
|
39
|
+
Calls from every run of any of these run plans, comma\-separated, at most 100 Optional.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-counted\-in\-results\fR \fI<value>\fR
|
|
42
|
+
true: only simulated calls their run's results count (not invalidated, for example because the agent never spoke). false: only the simulated calls the results leave out, each invalidated. Live calls, and calls removed from their run, match neither. One of: true, false. Optional.
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-\-exclude\-hidden\-runs\fR \fI<value>\fR
|
|
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.
|
|
34
46
|
.SH "GLOBAL OPTIONS"
|
|
35
47
|
.TP
|
|
36
48
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CREDENTIAL\-CREATE" "1" "" "roark-credential-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-credential\-create \- Create a personal credential
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark credential create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Mints a credential that acts as you, for a CLI or an automation. The key value is returned exactly once, in the `key` field: capture it now, it is unreadable afterwards. Requires a personal credential (a project API key is refused) and admin on the project the credential defaults to. The new credential can never exceed the one that created it: not in scope, not in permissions, and not in lifetime. Omit a field to copy it from the calling credential.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/me/api\-keys
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
15
|
+
A label you will recognise later. It is the only thing that tells two credentials apart in the list you revoke from. Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-project\-id\fR \fI<value>\fR
|
|
18
|
+
Project the credential assumes when a request sends no X\-Roark\-Project\-Id header. Defaults to the calling credential's own default project. You must be an admin of whichever project is used. Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-scopes\fR \fI<value>\fR
|
|
21
|
+
Coarse tier. Defaults to the calling credential's own tier, and can never exceed it: a READ credential cannot mint a WRITE one. One of: READ, WRITE. Repeatable. Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-permissions\fR \fI<value>\fR
|
|
24
|
+
Granular 'resource:action' permissions. Defaults to the calling credential's own set, and can never exceed it. A ceiling, not an entitlement: the holder still only reaches what their project membership allows. Repeatable. Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-expires\-at\fR \fI<value>\fR
|
|
27
|
+
ISO 8601 expiry. Defaults to the calling credential's own expiry (no expiry, for a `roark auth login` credential) and may not outlive it, so a short\-lived connector credential cannot mint a permanent one. Optional.
|
|
28
|
+
.SH "GLOBAL OPTIONS"
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
31
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
34
|
+
Skip confirmation prompts.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-no\-input\fR
|
|
37
|
+
Never prompt; fail instead.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
40
|
+
API base URL.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
43
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
46
|
+
Request timeout in milliseconds.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
49
|
+
Retries for retryable failures.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
52
|
+
Output format: auto, json, jsonl, plain.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-json\fR
|
|
55
|
+
Shorthand for \-\-format json.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-no\-color\fR
|
|
58
|
+
Disable colour.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
61
|
+
Suppress non\-essential output.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
64
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
65
|
+
.SH "EXAMPLES"
|
|
66
|
+
.PP
|
|
67
|
+
.RS 4
|
|
68
|
+
.nf
|
|
69
|
+
roark credential create \-\-name <value>
|
|
70
|
+
.fi
|
|
71
|
+
.RE
|
|
72
|
+
.SH "ENVIRONMENT"
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
75
|
+
Bearer token used when \-\-token is not given.
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_BASE_URL\fR
|
|
78
|
+
API base URL.
|
|
79
|
+
.TP
|
|
80
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
81
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
82
|
+
.TP
|
|
83
|
+
\fBNO_COLOR\fR
|
|
84
|
+
Disables colour when set to any value.
|
|
85
|
+
.SH "EXIT STATUS"
|
|
86
|
+
.TP
|
|
87
|
+
\fB0\fR
|
|
88
|
+
The command succeeded.
|
|
89
|
+
.TP
|
|
90
|
+
\fB1\fR
|
|
91
|
+
The API rejected the request.
|
|
92
|
+
.TP
|
|
93
|
+
\fB2\fR
|
|
94
|
+
The command line was wrong.
|
|
95
|
+
.TP
|
|
96
|
+
\fB3\fR
|
|
97
|
+
No credential, or the credential was refused.
|
|
98
|
+
.TP
|
|
99
|
+
\fB4\fR
|
|
100
|
+
The addressed resource does not exist.
|
|
101
|
+
.TP
|
|
102
|
+
\fB5\fR
|
|
103
|
+
The request never completed: connection, timeout, or abort.
|
|
104
|
+
.SH "SEE ALSO"
|
|
105
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CREDENTIAL\-LIST" "1" "" "roark-credential-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-credential\-list \- List your personal credentials
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark credential list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns the credentials that act as you: the ones created in the dashboard, from `roark auth login`, and MCP connectors. Requires a personal credential; a project API key is refused. Defaults to ACTIVE, pass ?status=REVOKED to see revoked ones. The key value itself is never returned.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/me/api\-keys
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-status\fR \fI<value>\fR
|
|
15
|
+
Filter by status. Defaults to ACTIVE. One of: ACTIVE, REVOKED. Optional.
|
|
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 credential list
|
|
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\-CREDENTIAL\-REVOKE" "1" "" "roark-credential-revoke" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-credential\-revoke \- Revoke one of your personal credentials
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark credential revoke
|
|
7
|
+
\fIcredential\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Revokes a credential that acts as you. It stops working immediately. A credential may revoke itself, which is what `roark auth logout` does. Repeating the call is safe; an unknown id, or one belonging to someone else, answers 404.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/me/api\-keys/{id}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcredential\-id\fR
|
|
15
|
+
The credential\-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 credential revoke <credential\-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
|
@@ -183,6 +183,15 @@ Reconcile the project to a config directory (or bundle). Previews and confirms f
|
|
|
183
183
|
\fBroark config diff\fR
|
|
184
184
|
Preview the changes a config directory (or bundle) would make. No writes. See roark\-config\-diff(1).
|
|
185
185
|
.TP
|
|
186
|
+
\fBroark credential create\fR
|
|
187
|
+
Create a personal credential See roark\-credential\-create(1).
|
|
188
|
+
.TP
|
|
189
|
+
\fBroark credential list\fR
|
|
190
|
+
List your personal credentials See roark\-credential\-list(1).
|
|
191
|
+
.TP
|
|
192
|
+
\fBroark credential revoke\fR
|
|
193
|
+
Revoke one of your personal credentials See roark\-credential\-revoke(1).
|
|
194
|
+
.TP
|
|
186
195
|
\fBroark customer\-flow create\fR
|
|
187
196
|
Create a customer flow See roark\-customer\-flow\-create(1).
|
|
188
197
|
.TP
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.37.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.37.1",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@roarkanalytics/sdk": "^4.
|
|
12
|
+
"@roarkanalytics/sdk": "^4.23.0",
|
|
13
13
|
"commander": "^14.0.3",
|
|
14
14
|
"yaml": "^2.9.0"
|
|
15
15
|
},
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
}
|
|
22
22
|
},
|
|
23
23
|
"node_modules/@roarkanalytics/sdk": {
|
|
24
|
-
"version": "4.
|
|
25
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.
|
|
26
|
-
"integrity": "sha512-
|
|
24
|
+
"version": "4.23.0",
|
|
25
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.23.0.tgz",
|
|
26
|
+
"integrity": "sha512-2UFFMYoUvIp44e1NG8Jk8DiJIa06gqMwygp1nMn3fhegQqSRUE9tsLkQC74SdfDSKtvvpykWX1bsrHf3DGlo6Q==",
|
|
27
27
|
"license": "Apache-2.0"
|
|
28
28
|
},
|
|
29
29
|
"node_modules/commander": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.37.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": "^4.
|
|
32
|
+
"@roarkanalytics/sdk": "^4.23.0",
|
|
33
33
|
"commander": "^14.0.3",
|
|
34
34
|
"yaml": "^2.9.0"
|
|
35
35
|
},
|
|
@@ -76,6 +76,9 @@
|
|
|
76
76
|
"./man/roark-call-transcript-get.1",
|
|
77
77
|
"./man/roark-config-apply.1",
|
|
78
78
|
"./man/roark-config-diff.1",
|
|
79
|
+
"./man/roark-credential-create.1",
|
|
80
|
+
"./man/roark-credential-list.1",
|
|
81
|
+
"./man/roark-credential-revoke.1",
|
|
79
82
|
"./man/roark-customer-flow-create.1",
|
|
80
83
|
"./man/roark-customer-flow-delete.1",
|
|
81
84
|
"./man/roark-customer-flow-duplicate.1",
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.37.1";
|
package/version.js
CHANGED