@roarkanalytics/cli 0.59.1 → 0.61.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.
@@ -0,0 +1,96 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-LIVE\-REPORT\-LIST" "1" "" "roark-live-report-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-list \- List live reports
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Lists the project's saved live call reports, newest first.
10
+ .SH "API"
11
+ GET /v1/live\-report
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-limit\fR \fI<value>\fR
15
+ Page size, at most 100. Optional.
16
+ .TP
17
+ \fB\-\-offset\fR \fI<value>\fR
18
+ Optional.
19
+ .SH "GLOBAL OPTIONS"
20
+ .TP
21
+ \fB\-\-data\fR \fI<json>\fR
22
+ Request body as JSON, or @file to read one (@\- for stdin).
23
+ .TP
24
+ \fB\-y\fR, \fB\-\-yes\fR
25
+ Skip confirmation prompts.
26
+ .TP
27
+ \fB\-\-no\-input\fR
28
+ Never prompt; fail instead.
29
+ .TP
30
+ \fB\-\-base\-url\fR \fI<url>\fR
31
+ API base URL.
32
+ .TP
33
+ \fB\-\-token\fR \fI<token>\fR
34
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
35
+ .TP
36
+ \fB\-\-timeout\fR \fI<ms>\fR
37
+ Request timeout in milliseconds.
38
+ .TP
39
+ \fB\-\-max\-retries\fR \fI<count>\fR
40
+ Retries for retryable failures.
41
+ .TP
42
+ \fB\-\-format\fR \fI<format>\fR
43
+ Output format: auto, json, jsonl, plain.
44
+ .TP
45
+ \fB\-\-json\fR
46
+ Shorthand for \-\-format json.
47
+ .TP
48
+ \fB\-\-no\-color\fR
49
+ Disable colour.
50
+ .TP
51
+ \fB\-q\fR, \fB\-\-quiet\fR
52
+ Suppress non\-essential output.
53
+ .TP
54
+ \fB\-\-allow\-project\-base\-url\fR
55
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
56
+ .SH "EXAMPLES"
57
+ .PP
58
+ .RS 4
59
+ .nf
60
+ roark live\-report list
61
+ .fi
62
+ .RE
63
+ .SH "ENVIRONMENT"
64
+ .TP
65
+ \fBROARK_API_BEARER_TOKEN\fR
66
+ Bearer token used when \-\-token is not given.
67
+ .TP
68
+ \fBROARK_BASE_URL\fR
69
+ API base URL.
70
+ .TP
71
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
72
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
73
+ .TP
74
+ \fBNO_COLOR\fR
75
+ Disables colour when set to any value.
76
+ .SH "EXIT STATUS"
77
+ .TP
78
+ \fB0\fR
79
+ The command succeeded.
80
+ .TP
81
+ \fB1\fR
82
+ The API rejected the request.
83
+ .TP
84
+ \fB2\fR
85
+ The command line was wrong.
86
+ .TP
87
+ \fB3\fR
88
+ No credential, or the credential was refused.
89
+ .TP
90
+ \fB4\fR
91
+ The addressed resource does not exist.
92
+ .TP
93
+ \fB5\fR
94
+ The request never completed: connection, timeout, or abort.
95
+ .SH "SEE ALSO"
96
+ .BR roark (1)
@@ -0,0 +1,100 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-LIVE\-REPORT\-RUN" "1" "" "roark-live-report-run" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-run \- Generate a live report document
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report run
7
+ \fIreport\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Writes the report now, for its latest closed period or a custom window (`periodStart` + `periodEnd`, at most 92 days, ended). Returns 202 with the document in PENDING; poll GET /v1/live\-report/{reportId}/document/{documentId} until `status` is READY or FAILED (typically a few minutes). An identical request already in flight is returned as\-is. A generated document is not emailed.
10
+ .SH "API"
11
+ POST /v1/live\-report/{reportId}/generate
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIreport\-id\fR
15
+ The live report ID
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-period\-start\fR \fI<value>\fR
19
+ ISO 8601 start of a custom window. Omit both for the latest closed period. Optional.
20
+ .TP
21
+ \fB\-\-period\-end\fR \fI<value>\fR
22
+ ISO 8601 end (exclusive) of a custom window. Requires periodStart. Optional.
23
+ .SH "GLOBAL OPTIONS"
24
+ .TP
25
+ \fB\-\-data\fR \fI<json>\fR
26
+ Request body as JSON, or @file to read one (@\- for stdin).
27
+ .TP
28
+ \fB\-y\fR, \fB\-\-yes\fR
29
+ Skip confirmation prompts.
30
+ .TP
31
+ \fB\-\-no\-input\fR
32
+ Never prompt; fail instead.
33
+ .TP
34
+ \fB\-\-base\-url\fR \fI<url>\fR
35
+ API base URL.
36
+ .TP
37
+ \fB\-\-token\fR \fI<token>\fR
38
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
39
+ .TP
40
+ \fB\-\-timeout\fR \fI<ms>\fR
41
+ Request timeout in milliseconds.
42
+ .TP
43
+ \fB\-\-max\-retries\fR \fI<count>\fR
44
+ Retries for retryable failures.
45
+ .TP
46
+ \fB\-\-format\fR \fI<format>\fR
47
+ Output format: auto, json, jsonl, plain.
48
+ .TP
49
+ \fB\-\-json\fR
50
+ Shorthand for \-\-format json.
51
+ .TP
52
+ \fB\-\-no\-color\fR
53
+ Disable colour.
54
+ .TP
55
+ \fB\-q\fR, \fB\-\-quiet\fR
56
+ Suppress non\-essential output.
57
+ .TP
58
+ \fB\-\-allow\-project\-base\-url\fR
59
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
60
+ .SH "EXAMPLES"
61
+ .PP
62
+ .RS 4
63
+ .nf
64
+ roark live\-report run <report\-id>
65
+ .fi
66
+ .RE
67
+ .SH "ENVIRONMENT"
68
+ .TP
69
+ \fBROARK_API_BEARER_TOKEN\fR
70
+ Bearer token used when \-\-token is not given.
71
+ .TP
72
+ \fBROARK_BASE_URL\fR
73
+ API base URL.
74
+ .TP
75
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
76
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
77
+ .TP
78
+ \fBNO_COLOR\fR
79
+ Disables colour when set to any value.
80
+ .SH "EXIT STATUS"
81
+ .TP
82
+ \fB0\fR
83
+ The command succeeded.
84
+ .TP
85
+ \fB1\fR
86
+ The API rejected the request.
87
+ .TP
88
+ \fB2\fR
89
+ The command line was wrong.
90
+ .TP
91
+ \fB3\fR
92
+ No credential, or the credential was refused.
93
+ .TP
94
+ \fB4\fR
95
+ The addressed resource does not exist.
96
+ .TP
97
+ \fB5\fR
98
+ The request never completed: connection, timeout, or abort.
99
+ .SH "SEE ALSO"
100
+ .BR roark (1)
@@ -0,0 +1,136 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-LIVE\-REPORT\-UPDATE" "1" "" "roark-live-report-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-update \- Update a live report
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report update
7
+ \fIreport\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Changes the fields sent. Set `status` to PAUSED to stop scheduled reports.
10
+ .SH "API"
11
+ PATCH /v1/live\-report/{reportId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIreport\-id\fR
15
+ The live report ID
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-name\fR \fI<value>\fR
19
+ Optional.
20
+ .TP
21
+ \fB\-\-description\fR \fI<value>\fR
22
+ Optional.
23
+ .TP
24
+ \fB\-\-agent\-id\fR \fI<value>\fR
25
+ Optional.
26
+ .TP
27
+ \fB\-\-filters\fR \fI<value>\fR
28
+ Optional.
29
+ .TP
30
+ \fB\-\-targets\fR \fI<value>\fR
31
+ Optional.
32
+ .TP
33
+ \fB\-\-dashboard\-id\fR \fI<value>\fR
34
+ Optional.
35
+ .TP
36
+ \fB\-\-cadence\fR \fI<value>\fR
37
+ One of: DAILY, WEEKLY, MONTHLY. Optional.
38
+ .TP
39
+ \fB\-\-timezone\fR \fI<value>\fR
40
+ Optional.
41
+ .TP
42
+ \fB\-\-delivery\-hour\fR \fI<value>\fR
43
+ Optional.
44
+ .TP
45
+ \fB\-\-status\fR \fI<value>\fR
46
+ One of: ACTIVE, PAUSED. Optional.
47
+ .TP
48
+ \fB\-\-notifications\fR \fI<value>\fR
49
+ Optional.
50
+ .TP
51
+ \fB\-\-notifications.email\fR \fI<value>\fR
52
+ Required.
53
+ .TP
54
+ \fB\-\-notifications.slack\fR \fI<value>\fR
55
+ Required.
56
+ .TP
57
+ \fB\-\-include\-transcript\-excerpts\fR
58
+ Optional.
59
+ .SH "GLOBAL OPTIONS"
60
+ .TP
61
+ \fB\-\-data\fR \fI<json>\fR
62
+ Request body as JSON, or @file to read one (@\- for stdin).
63
+ .TP
64
+ \fB\-y\fR, \fB\-\-yes\fR
65
+ Skip confirmation prompts.
66
+ .TP
67
+ \fB\-\-no\-input\fR
68
+ Never prompt; fail instead.
69
+ .TP
70
+ \fB\-\-base\-url\fR \fI<url>\fR
71
+ API base URL.
72
+ .TP
73
+ \fB\-\-token\fR \fI<token>\fR
74
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
75
+ .TP
76
+ \fB\-\-timeout\fR \fI<ms>\fR
77
+ Request timeout in milliseconds.
78
+ .TP
79
+ \fB\-\-max\-retries\fR \fI<count>\fR
80
+ Retries for retryable failures.
81
+ .TP
82
+ \fB\-\-format\fR \fI<format>\fR
83
+ Output format: auto, json, jsonl, plain.
84
+ .TP
85
+ \fB\-\-json\fR
86
+ Shorthand for \-\-format json.
87
+ .TP
88
+ \fB\-\-no\-color\fR
89
+ Disable colour.
90
+ .TP
91
+ \fB\-q\fR, \fB\-\-quiet\fR
92
+ Suppress non\-essential output.
93
+ .TP
94
+ \fB\-\-allow\-project\-base\-url\fR
95
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
96
+ .SH "EXAMPLES"
97
+ .PP
98
+ .RS 4
99
+ .nf
100
+ roark live\-report update <report\-id> \-\-notifications.email <value> \-\-notifications.slack <value>
101
+ .fi
102
+ .RE
103
+ .SH "ENVIRONMENT"
104
+ .TP
105
+ \fBROARK_API_BEARER_TOKEN\fR
106
+ Bearer token used when \-\-token is not given.
107
+ .TP
108
+ \fBROARK_BASE_URL\fR
109
+ API base URL.
110
+ .TP
111
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
112
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
113
+ .TP
114
+ \fBNO_COLOR\fR
115
+ Disables colour when set to any value.
116
+ .SH "EXIT STATUS"
117
+ .TP
118
+ \fB0\fR
119
+ The command succeeded.
120
+ .TP
121
+ \fB1\fR
122
+ The API rejected the request.
123
+ .TP
124
+ \fB2\fR
125
+ The command line was wrong.
126
+ .TP
127
+ \fB3\fR
128
+ No credential, or the credential was refused.
129
+ .TP
130
+ \fB4\fR
131
+ The addressed resource does not exist.
132
+ .TP
133
+ \fB5\fR
134
+ The request never completed: connection, timeout, or abort.
135
+ .SH "SEE ALSO"
136
+ .BR roark (1)
package/man/roark.1 CHANGED
@@ -117,8 +117,8 @@ Get an agent version See roark\-agent\-version\-get(1).
117
117
  \fBroark agent version list\fR
118
118
  List an agent's versions See roark\-agent\-version\-list(1).
119
119
  .TP
120
- \fBroark agent version restore\fR
121
- Restore an agent version See roark\-agent\-version\-restore(1).
120
+ \fBroark agent version rollback\fR
121
+ Roll an agent back to a version See roark\-agent\-version\-rollback(1).
122
122
  .TP
123
123
  \fBroark agent\-config get\fR
124
124
  Get a managed config See roark\-agent\-config\-get(1).
@@ -315,6 +315,30 @@ List HTTP request definitions See roark\-http\-request\-definition\-list(1).
315
315
  \fBroark http\-request\-definition update\fR
316
316
  Update HTTP request definition See roark\-http\-request\-definition\-update(1).
317
317
  .TP
318
+ \fBroark live\-report create\fR
319
+ Create a live report See roark\-live\-report\-create(1).
320
+ .TP
321
+ \fBroark live\-report delete\fR
322
+ Delete a live report See roark\-live\-report\-delete(1).
323
+ .TP
324
+ \fBroark live\-report document get\fR
325
+ Get a report document See roark\-live\-report\-document\-get(1).
326
+ .TP
327
+ \fBroark live\-report document list\fR
328
+ List report documents See roark\-live\-report\-document\-list(1).
329
+ .TP
330
+ \fBroark live\-report get\fR
331
+ Get a live report See roark\-live\-report\-get(1).
332
+ .TP
333
+ \fBroark live\-report list\fR
334
+ List live reports See roark\-live\-report\-list(1).
335
+ .TP
336
+ \fBroark live\-report run\fR
337
+ Generate a live report document See roark\-live\-report\-run(1).
338
+ .TP
339
+ \fBroark live\-report update\fR
340
+ Update a live report See roark\-live\-report\-update(1).
341
+ .TP
318
342
  \fBroark metric collection\-job cancel\fR
319
343
  Cancel a metric collection job See roark\-metric\-collection\-job\-cancel(1).
320
344
  .TP
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.59.1",
3
+ "version": "0.61.1",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.59.1",
9
+ "version": "0.61.1",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
- "@roarkanalytics/sdk": "^5.22.0",
12
+ "@roarkanalytics/sdk": "^6.2.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": "5.22.0",
26
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.22.0.tgz",
27
- "integrity": "sha512-KzujXZZZD4Wsjek8EweWYTXRWdKb2UMK84y37OZCOfU8bbCvgzIqpXMxow6GHFNFlbNpC+aKtOfeVLOhdGEA7g==",
25
+ "version": "6.2.0",
26
+ "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-6.2.0.tgz",
27
+ "integrity": "sha512-zPoo0o2f4ruygNG940nb8WfI5504ZnN9uHsyZLxNhNtlfXJtAeIbMgDihB2qzdCWeAsZKun6cQyKk9C503H/gw==",
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.59.1",
3
+ "version": "0.61.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.22.0",
32
+ "@roarkanalytics/sdk": "^6.2.0",
33
33
  "commander": "^14.0.3",
34
34
  "jiti": "^2.4.2",
35
35
  "yaml": "^2.9.0"
@@ -55,7 +55,7 @@
55
55
  "./man/roark-agent-update.1",
56
56
  "./man/roark-agent-version-get.1",
57
57
  "./man/roark-agent-version-list.1",
58
- "./man/roark-agent-version-restore.1",
58
+ "./man/roark-agent-version-rollback.1",
59
59
  "./man/roark-agent-config-get.1",
60
60
  "./man/roark-agent-config-list.1",
61
61
  "./man/roark-agent-config-promote.1",
@@ -121,6 +121,14 @@
121
121
  "./man/roark-http-request-definition-get.1",
122
122
  "./man/roark-http-request-definition-list.1",
123
123
  "./man/roark-http-request-definition-update.1",
124
+ "./man/roark-live-report-create.1",
125
+ "./man/roark-live-report-delete.1",
126
+ "./man/roark-live-report-document-get.1",
127
+ "./man/roark-live-report-document-list.1",
128
+ "./man/roark-live-report-get.1",
129
+ "./man/roark-live-report-list.1",
130
+ "./man/roark-live-report-run.1",
131
+ "./man/roark-live-report-update.1",
124
132
  "./man/roark-metric-collection-job-cancel.1",
125
133
  "./man/roark-metric-collection-job-create.1",
126
134
  "./man/roark-metric-collection-job-get.1",
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "0.59.1";
1
+ export declare const version = "0.61.1";
package/version.js CHANGED
@@ -10,4 +10,4 @@ exports.version = void 0;
10
10
  //
11
11
  // Do not edit: an edit here is overwritten, and the published number is whatever
12
12
  // package.json says.
13
- exports.version = '0.59.1'; // x-release-please-version
13
+ exports.version = '0.61.1'; // x-release-please-version