@roarkanalytics/cli 0.46.0 → 0.48.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.
@@ -0,0 +1,112 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-DASHBOARD\-UPDATE" "1" "" "roark-dashboard-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-dashboard\-update \- Update a dashboard
5
+ .SH "SYNOPSIS"
6
+ .B roark dashboard update
7
+ \fIdashboard\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Edits a dashboard. Omitted fields keep their current value. `widgets`, when sent, replaces the list: widgets are matched by name, so a widget that keeps its name keeps its id; a new name adds a widget and a name no longer listed removes it. To change one widget, PUT /v1/dashboard/{dashboardId}/widget/{widgetId}.
10
+ .SH "API"
11
+ PUT /v1/dashboard/{dashboardId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIdashboard\-id\fR
15
+ The dashboard 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\-\-time\-range\fR \fI<value>\fR
25
+ The window: LAST n DAYS/WEEKS/MONTHS up to now, a CALENDAR_ALIGNED period (TODAY, YESTERDAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, THIS_YEAR, LAST_YEAR), FIXED from/to, or SINCE a date. At most 731 days (two years). Optional.
26
+ .TP
27
+ \fB\-\-filters\fR \fI<value>\fR
28
+ Optional.
29
+ .TP
30
+ \fB\-\-is\-default\fR
31
+ Optional.
32
+ .TP
33
+ \fB\-\-widgets\fR \fI<value>\fR
34
+ Optional.
35
+ .SH "GLOBAL OPTIONS"
36
+ .TP
37
+ \fB\-\-data\fR \fI<json>\fR
38
+ Request body as JSON, or @file to read one (@\- for stdin).
39
+ .TP
40
+ \fB\-y\fR, \fB\-\-yes\fR
41
+ Skip confirmation prompts.
42
+ .TP
43
+ \fB\-\-no\-input\fR
44
+ Never prompt; fail instead.
45
+ .TP
46
+ \fB\-\-base\-url\fR \fI<url>\fR
47
+ API base URL.
48
+ .TP
49
+ \fB\-\-token\fR \fI<token>\fR
50
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
51
+ .TP
52
+ \fB\-\-timeout\fR \fI<ms>\fR
53
+ Request timeout in milliseconds.
54
+ .TP
55
+ \fB\-\-max\-retries\fR \fI<count>\fR
56
+ Retries for retryable failures.
57
+ .TP
58
+ \fB\-\-format\fR \fI<format>\fR
59
+ Output format: auto, json, jsonl, plain.
60
+ .TP
61
+ \fB\-\-json\fR
62
+ Shorthand for \-\-format json.
63
+ .TP
64
+ \fB\-\-no\-color\fR
65
+ Disable colour.
66
+ .TP
67
+ \fB\-q\fR, \fB\-\-quiet\fR
68
+ Suppress non\-essential output.
69
+ .TP
70
+ \fB\-\-allow\-project\-base\-url\fR
71
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
72
+ .SH "EXAMPLES"
73
+ .PP
74
+ .RS 4
75
+ .nf
76
+ roark dashboard update <dashboard\-id>
77
+ .fi
78
+ .RE
79
+ .SH "ENVIRONMENT"
80
+ .TP
81
+ \fBROARK_API_BEARER_TOKEN\fR
82
+ Bearer token used when \-\-token is not given.
83
+ .TP
84
+ \fBROARK_BASE_URL\fR
85
+ API base URL.
86
+ .TP
87
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
88
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
89
+ .TP
90
+ \fBNO_COLOR\fR
91
+ Disables colour when set to any value.
92
+ .SH "EXIT STATUS"
93
+ .TP
94
+ \fB0\fR
95
+ The command succeeded.
96
+ .TP
97
+ \fB1\fR
98
+ The API rejected the request.
99
+ .TP
100
+ \fB2\fR
101
+ The command line was wrong.
102
+ .TP
103
+ \fB3\fR
104
+ No credential, or the credential was refused.
105
+ .TP
106
+ \fB4\fR
107
+ The addressed resource does not exist.
108
+ .TP
109
+ \fB5\fR
110
+ The request never completed: connection, timeout, or abort.
111
+ .SH "SEE ALSO"
112
+ .BR roark (1)
@@ -0,0 +1,121 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-DASHBOARD\-WIDGET\-CREATE" "1" "" "roark-dashboard-widget-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-dashboard\-widget\-create \- Add a widget
5
+ .SH "SYNOPSIS"
6
+ .B roark dashboard widget create
7
+ \fIdashboard\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Adds a widget to the top of a dashboard. Its name must be unique on the dashboard.
10
+ .SH "API"
11
+ POST /v1/dashboard/{dashboardId}/widget
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIdashboard\-id\fR
15
+ The dashboard ID
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-measures\fR \fI<value>\fR
19
+ What to aggregate: 1 to 10 measures. Required.
20
+ .TP
21
+ \fB\-\-filters\fR \fI<value>\fR
22
+ Applied to every measure, on top of each measure's own filters. Optional.
23
+ .TP
24
+ \fB\-\-interval\fR \fI<value>\fR
25
+ Bucket size. Defaults from the window's length and steps coarser when the window would exceed 500 buckets. One of: HOUR, DAY, WEEK, MONTH. Optional.
26
+ .TP
27
+ \fB\-\-comparison\-mode\fR \fI<value>\fR
28
+ PREVIOUS_PERIOD adds the preceding window of the same length to every series. One of: NONE, PREVIOUS_PERIOD. Optional.
29
+ .TP
30
+ \fB\-\-comparison\-groups\fR \fI<value>\fR
31
+ Run every measure once per named filter set, e.g. one group per agent. Optional.
32
+ .TP
33
+ \fB\-\-name\fR \fI<value>\fR
34
+ Unique on the dashboard: how the widget is matched on update. Required.
35
+ .TP
36
+ \fB\-\-description\fR \fI<value>\fR
37
+ Optional.
38
+ .TP
39
+ \fB\-\-display\fR \fI<value>\fR
40
+ Chart type. Defaults to LINE. One of: LINE, NUMBER, RADAR, STACKED_BAR, TABLE. Optional.
41
+ .TP
42
+ \fB\-\-size\fR \fI<value>\fR
43
+ Grid width. Defaults to MEDIUM. One of: SMALL, MEDIUM, LARGE, EXTRA_LARGE. Optional.
44
+ .SH "GLOBAL OPTIONS"
45
+ .TP
46
+ \fB\-\-data\fR \fI<json>\fR
47
+ Request body as JSON, or @file to read one (@\- for stdin).
48
+ .TP
49
+ \fB\-y\fR, \fB\-\-yes\fR
50
+ Skip confirmation prompts.
51
+ .TP
52
+ \fB\-\-no\-input\fR
53
+ Never prompt; fail instead.
54
+ .TP
55
+ \fB\-\-base\-url\fR \fI<url>\fR
56
+ API base URL.
57
+ .TP
58
+ \fB\-\-token\fR \fI<token>\fR
59
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
60
+ .TP
61
+ \fB\-\-timeout\fR \fI<ms>\fR
62
+ Request timeout in milliseconds.
63
+ .TP
64
+ \fB\-\-max\-retries\fR \fI<count>\fR
65
+ Retries for retryable failures.
66
+ .TP
67
+ \fB\-\-format\fR \fI<format>\fR
68
+ Output format: auto, json, jsonl, plain.
69
+ .TP
70
+ \fB\-\-json\fR
71
+ Shorthand for \-\-format json.
72
+ .TP
73
+ \fB\-\-no\-color\fR
74
+ Disable colour.
75
+ .TP
76
+ \fB\-q\fR, \fB\-\-quiet\fR
77
+ Suppress non\-essential output.
78
+ .TP
79
+ \fB\-\-allow\-project\-base\-url\fR
80
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
81
+ .SH "EXAMPLES"
82
+ .PP
83
+ .RS 4
84
+ .nf
85
+ roark dashboard widget create <dashboard\-id> \-\-measures <value> \-\-name <value>
86
+ .fi
87
+ .RE
88
+ .SH "ENVIRONMENT"
89
+ .TP
90
+ \fBROARK_API_BEARER_TOKEN\fR
91
+ Bearer token used when \-\-token is not given.
92
+ .TP
93
+ \fBROARK_BASE_URL\fR
94
+ API base URL.
95
+ .TP
96
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
97
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
98
+ .TP
99
+ \fBNO_COLOR\fR
100
+ Disables colour when set to any value.
101
+ .SH "EXIT STATUS"
102
+ .TP
103
+ \fB0\fR
104
+ The command succeeded.
105
+ .TP
106
+ \fB1\fR
107
+ The API rejected the request.
108
+ .TP
109
+ \fB2\fR
110
+ The command line was wrong.
111
+ .TP
112
+ \fB3\fR
113
+ No credential, or the credential was refused.
114
+ .TP
115
+ \fB4\fR
116
+ The addressed resource does not exist.
117
+ .TP
118
+ \fB5\fR
119
+ The request never completed: connection, timeout, or abort.
120
+ .SH "SEE ALSO"
121
+ .BR roark (1)
@@ -0,0 +1,106 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-DASHBOARD\-WIDGET\-DATA\-GET" "1" "" "roark-dashboard-widget-data-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-dashboard\-widget\-data\-get \- Get widget data
5
+ .SH "SYNOPSIS"
6
+ .B roark dashboard widget\-data get
7
+ \fIdashboard\-id\fR \fIwidget\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Runs one widget and returns its series, as it reads on its dashboard (the dashboard's window and filters). Accepts the same `from` / `to` / `timezone` overrides as GET /v1/dashboard/{dashboardId}/data.
10
+ .SH "API"
11
+ GET /v1/dashboard/{dashboardId}/widget/{widgetId}/data
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIdashboard\-id\fR
15
+ The dashboard\-id.
16
+ .TP
17
+ \fIwidget\-id\fR
18
+ The widget\-id.
19
+ .SH "OPTIONS"
20
+ .TP
21
+ \fB\-\-from\fR \fI<value>\fR
22
+ ISO 8601 start. Overrides the saved window; without `to`, runs until now. Optional.
23
+ .TP
24
+ \fB\-\-to\fR \fI<value>\fR
25
+ ISO 8601 end. Requires `from`. Optional.
26
+ .TP
27
+ \fB\-\-timezone\fR \fI<value>\fR
28
+ IANA zone buckets and calendar periods align to. Default UTC. Optional.
29
+ .SH "GLOBAL OPTIONS"
30
+ .TP
31
+ \fB\-\-data\fR \fI<json>\fR
32
+ Request body as JSON, or @file to read one (@\- for stdin).
33
+ .TP
34
+ \fB\-y\fR, \fB\-\-yes\fR
35
+ Skip confirmation prompts.
36
+ .TP
37
+ \fB\-\-no\-input\fR
38
+ Never prompt; fail instead.
39
+ .TP
40
+ \fB\-\-base\-url\fR \fI<url>\fR
41
+ API base URL.
42
+ .TP
43
+ \fB\-\-token\fR \fI<token>\fR
44
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
45
+ .TP
46
+ \fB\-\-timeout\fR \fI<ms>\fR
47
+ Request timeout in milliseconds.
48
+ .TP
49
+ \fB\-\-max\-retries\fR \fI<count>\fR
50
+ Retries for retryable failures.
51
+ .TP
52
+ \fB\-\-format\fR \fI<format>\fR
53
+ Output format: auto, json, jsonl, plain.
54
+ .TP
55
+ \fB\-\-json\fR
56
+ Shorthand for \-\-format json.
57
+ .TP
58
+ \fB\-\-no\-color\fR
59
+ Disable colour.
60
+ .TP
61
+ \fB\-q\fR, \fB\-\-quiet\fR
62
+ Suppress non\-essential output.
63
+ .TP
64
+ \fB\-\-allow\-project\-base\-url\fR
65
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
66
+ .SH "EXAMPLES"
67
+ .PP
68
+ .RS 4
69
+ .nf
70
+ roark dashboard widget\-data get <dashboard\-id> <widget\-id>
71
+ .fi
72
+ .RE
73
+ .SH "ENVIRONMENT"
74
+ .TP
75
+ \fBROARK_API_BEARER_TOKEN\fR
76
+ Bearer token used when \-\-token is not given.
77
+ .TP
78
+ \fBROARK_BASE_URL\fR
79
+ API base URL.
80
+ .TP
81
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
82
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
83
+ .TP
84
+ \fBNO_COLOR\fR
85
+ Disables colour when set to any value.
86
+ .SH "EXIT STATUS"
87
+ .TP
88
+ \fB0\fR
89
+ The command succeeded.
90
+ .TP
91
+ \fB1\fR
92
+ The API rejected the request.
93
+ .TP
94
+ \fB2\fR
95
+ The command line was wrong.
96
+ .TP
97
+ \fB3\fR
98
+ No credential, or the credential was refused.
99
+ .TP
100
+ \fB4\fR
101
+ The addressed resource does not exist.
102
+ .TP
103
+ \fB5\fR
104
+ The request never completed: connection, timeout, or abort.
105
+ .SH "SEE ALSO"
106
+ .BR roark (1)
@@ -0,0 +1,96 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-DASHBOARD\-WIDGET\-DELETE" "1" "" "roark-dashboard-widget-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-dashboard\-widget\-delete \- Remove a widget
5
+ .SH "SYNOPSIS"
6
+ .B roark dashboard widget delete
7
+ \fIdashboard\-id\fR \fIwidget\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Removes a widget from a dashboard.
10
+ .SH "API"
11
+ DELETE /v1/dashboard/{dashboardId}/widget/{widgetId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIdashboard\-id\fR
15
+ The dashboard ID
16
+ .TP
17
+ \fIwidget\-id\fR
18
+ The widget ID
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 dashboard widget delete <dashboard\-id> <widget\-id>
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,124 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-DASHBOARD\-WIDGET\-UPDATE" "1" "" "roark-dashboard-widget-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-dashboard\-widget\-update \- Replace a widget
5
+ .SH "SYNOPSIS"
6
+ .B roark dashboard widget update
7
+ \fIdashboard\-id\fR \fIwidget\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Replaces a widget's definition. It keeps its id and its place on the dashboard.
10
+ .SH "API"
11
+ PUT /v1/dashboard/{dashboardId}/widget/{widgetId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIdashboard\-id\fR
15
+ The dashboard ID
16
+ .TP
17
+ \fIwidget\-id\fR
18
+ The widget ID
19
+ .SH "OPTIONS"
20
+ .TP
21
+ \fB\-\-measures\fR \fI<value>\fR
22
+ What to aggregate: 1 to 10 measures. Required.
23
+ .TP
24
+ \fB\-\-filters\fR \fI<value>\fR
25
+ Applied to every measure, on top of each measure's own filters. Optional.
26
+ .TP
27
+ \fB\-\-interval\fR \fI<value>\fR
28
+ Bucket size. Defaults from the window's length and steps coarser when the window would exceed 500 buckets. One of: HOUR, DAY, WEEK, MONTH. Optional.
29
+ .TP
30
+ \fB\-\-comparison\-mode\fR \fI<value>\fR
31
+ PREVIOUS_PERIOD adds the preceding window of the same length to every series. One of: NONE, PREVIOUS_PERIOD. Optional.
32
+ .TP
33
+ \fB\-\-comparison\-groups\fR \fI<value>\fR
34
+ Run every measure once per named filter set, e.g. one group per agent. Optional.
35
+ .TP
36
+ \fB\-\-name\fR \fI<value>\fR
37
+ Unique on the dashboard: how the widget is matched on update. Required.
38
+ .TP
39
+ \fB\-\-description\fR \fI<value>\fR
40
+ Optional.
41
+ .TP
42
+ \fB\-\-display\fR \fI<value>\fR
43
+ Chart type. Defaults to LINE. One of: LINE, NUMBER, RADAR, STACKED_BAR, TABLE. Optional.
44
+ .TP
45
+ \fB\-\-size\fR \fI<value>\fR
46
+ Grid width. Defaults to MEDIUM. One of: SMALL, MEDIUM, LARGE, EXTRA_LARGE. Optional.
47
+ .SH "GLOBAL OPTIONS"
48
+ .TP
49
+ \fB\-\-data\fR \fI<json>\fR
50
+ Request body as JSON, or @file to read one (@\- for stdin).
51
+ .TP
52
+ \fB\-y\fR, \fB\-\-yes\fR
53
+ Skip confirmation prompts.
54
+ .TP
55
+ \fB\-\-no\-input\fR
56
+ Never prompt; fail instead.
57
+ .TP
58
+ \fB\-\-base\-url\fR \fI<url>\fR
59
+ API base URL.
60
+ .TP
61
+ \fB\-\-token\fR \fI<token>\fR
62
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
63
+ .TP
64
+ \fB\-\-timeout\fR \fI<ms>\fR
65
+ Request timeout in milliseconds.
66
+ .TP
67
+ \fB\-\-max\-retries\fR \fI<count>\fR
68
+ Retries for retryable failures.
69
+ .TP
70
+ \fB\-\-format\fR \fI<format>\fR
71
+ Output format: auto, json, jsonl, plain.
72
+ .TP
73
+ \fB\-\-json\fR
74
+ Shorthand for \-\-format json.
75
+ .TP
76
+ \fB\-\-no\-color\fR
77
+ Disable colour.
78
+ .TP
79
+ \fB\-q\fR, \fB\-\-quiet\fR
80
+ Suppress non\-essential output.
81
+ .TP
82
+ \fB\-\-allow\-project\-base\-url\fR
83
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
84
+ .SH "EXAMPLES"
85
+ .PP
86
+ .RS 4
87
+ .nf
88
+ roark dashboard widget update <dashboard\-id> <widget\-id> \-\-measures <value> \-\-name <value>
89
+ .fi
90
+ .RE
91
+ .SH "ENVIRONMENT"
92
+ .TP
93
+ \fBROARK_API_BEARER_TOKEN\fR
94
+ Bearer token used when \-\-token is not given.
95
+ .TP
96
+ \fBROARK_BASE_URL\fR
97
+ API base URL.
98
+ .TP
99
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
100
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
101
+ .TP
102
+ \fBNO_COLOR\fR
103
+ Disables colour when set to any value.
104
+ .SH "EXIT STATUS"
105
+ .TP
106
+ \fB0\fR
107
+ The command succeeded.
108
+ .TP
109
+ \fB1\fR
110
+ The API rejected the request.
111
+ .TP
112
+ \fB2\fR
113
+ The command line was wrong.
114
+ .TP
115
+ \fB3\fR
116
+ No credential, or the credential was refused.
117
+ .TP
118
+ \fB4\fR
119
+ The addressed resource does not exist.
120
+ .TP
121
+ \fB5\fR
122
+ The request never completed: connection, timeout, or abort.
123
+ .SH "SEE ALSO"
124
+ .BR roark (1)
@@ -0,0 +1,99 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-USAGE\-GET" "1" "" "roark-usage-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-usage\-get \- Get usage & cost
5
+ .SH "SYNOPSIS"
6
+ .B roark usage get
7
+ [\fIoptions\fR]
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.
10
+ .SH "API"
11
+ GET /v1/usage
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-from\fR \fI<value>\fR
15
+ Start of the window (inclusive), ISO 8601. Required.
16
+ .TP
17
+ \fB\-\-to\fR \fI<value>\fR
18
+ End of the window (exclusive), ISO 8601. Must be after `from`, and the window may not exceed 366 days. Required.
19
+ .TP
20
+ \fB\-\-project\-id\fR \fI<value>\fR
21
+ Limit the report to a single project. Omit for the whole organization. Optional.
22
+ .SH "GLOBAL OPTIONS"
23
+ .TP
24
+ \fB\-\-data\fR \fI<json>\fR
25
+ Request body as JSON, or @file to read one (@\- for stdin).
26
+ .TP
27
+ \fB\-y\fR, \fB\-\-yes\fR
28
+ Skip confirmation prompts.
29
+ .TP
30
+ \fB\-\-no\-input\fR
31
+ Never prompt; fail instead.
32
+ .TP
33
+ \fB\-\-base\-url\fR \fI<url>\fR
34
+ API base URL.
35
+ .TP
36
+ \fB\-\-token\fR \fI<token>\fR
37
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
38
+ .TP
39
+ \fB\-\-timeout\fR \fI<ms>\fR
40
+ Request timeout in milliseconds.
41
+ .TP
42
+ \fB\-\-max\-retries\fR \fI<count>\fR
43
+ Retries for retryable failures.
44
+ .TP
45
+ \fB\-\-format\fR \fI<format>\fR
46
+ Output format: auto, json, jsonl, plain.
47
+ .TP
48
+ \fB\-\-json\fR
49
+ Shorthand for \-\-format json.
50
+ .TP
51
+ \fB\-\-no\-color\fR
52
+ Disable colour.
53
+ .TP
54
+ \fB\-q\fR, \fB\-\-quiet\fR
55
+ Suppress non\-essential output.
56
+ .TP
57
+ \fB\-\-allow\-project\-base\-url\fR
58
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
59
+ .SH "EXAMPLES"
60
+ .PP
61
+ .RS 4
62
+ .nf
63
+ roark usage get \-\-from <value> \-\-to <value>
64
+ .fi
65
+ .RE
66
+ .SH "ENVIRONMENT"
67
+ .TP
68
+ \fBROARK_API_BEARER_TOKEN\fR
69
+ Bearer token used when \-\-token is not given.
70
+ .TP
71
+ \fBROARK_BASE_URL\fR
72
+ API base URL.
73
+ .TP
74
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
75
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
76
+ .TP
77
+ \fBNO_COLOR\fR
78
+ Disables colour when set to any value.
79
+ .SH "EXIT STATUS"
80
+ .TP
81
+ \fB0\fR
82
+ The command succeeded.
83
+ .TP
84
+ \fB1\fR
85
+ The API rejected the request.
86
+ .TP
87
+ \fB2\fR
88
+ The command line was wrong.
89
+ .TP
90
+ \fB3\fR
91
+ No credential, or the credential was refused.
92
+ .TP
93
+ \fB4\fR
94
+ The addressed resource does not exist.
95
+ .TP
96
+ \fB5\fR
97
+ The request never completed: connection, timeout, or abort.
98
+ .SH "SEE ALSO"
99
+ .BR roark (1)