@roarkanalytics/cli 0.5.0 → 0.7.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.
Files changed (20) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +16 -8
  3. package/commands.js +536 -1
  4. package/completions.js +4 -4
  5. package/man/roark-call-tool-invocation-append.1 +100 -0
  6. package/man/roark-metric-definition-update.1 +169 -0
  7. package/man/roark-metric-variant-create.1 +97 -0
  8. package/man/roark-metric-variant-delete.1 +96 -0
  9. package/man/roark-metric-variant-get.1 +96 -0
  10. package/man/roark-metric-variant-list.1 +93 -0
  11. package/man/roark-metric-variant-update.1 +121 -0
  12. package/man/roark-simulation-plan-create.1 +3 -0
  13. package/man/roark-simulation-plan-update.1 +3 -0
  14. package/man/roark-simulation-run.1 +4 -1
  15. package/man/roark-simulation-template-list.1 +89 -0
  16. package/man/roark.1 +24 -0
  17. package/npm-shrinkwrap.json +5 -5
  18. package/package.json +9 -1
  19. package/version.d.ts +1 -1
  20. package/version.js +1 -1
package/man/roark-call-tool-invocation-append.1 ADDED
@@ -0,0 +1,100 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CALL\-TOOL\-INVOCATION\-APPEND" "1" "" "roark-call-tool-invocation-append" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-call\-tool\-invocation\-append \- Append tool invocations to a call
5
+ .SH "SYNOPSIS"
6
+ .B roark call tool\-invocation append
7
+ \fIcall\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Attach tool invocations that fired during a call to an already\-existing call, asynchronously after the call was created. Use this when the tool\-call data becomes available later than the call itself (e.g. a Roark simulation, or a call submitted via POST /v1/call before its tools were ready). Writes are idempotent: re\-sending an invocation already present on the call (same tool name and timing) is skipped, so retries converge instead of double\-counting. Optionally pass `metrics` to (re)score metrics over the newly attached tools, which triggers a billed metric collection job and requires the `metric:create` permission.
10
+ .SH "API"
11
+ POST /v1/call/{callId}/tool\-invocations
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIcall\-id\fR
15
+ The call\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-tool\-invocations\fR \fI<value>\fR
19
+ Tool invocations that fired during the call, to attach to it. Max 500 per request. Re\-sending an invocation already present on the call (same tool name and timing) is skipped, so retries are safe. Required.
20
+ .TP
21
+ \fB\-\-metrics\fR \fI<value>\fR
22
+ Optional. Metric definitions to (re)score on this call after the tool invocations are attached, e.g. the Tool Invocation Analysis metrics. Triggers a metric collection job (billed, credit\-gated) and requires the 'metric:create' permission. Omit to attach tools without scoring. Max 20. 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 call tool\-invocation append <call\-id> \-\-tool\-invocations <value>
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)
package/man/roark-metric-definition-update.1 ADDED
@@ -0,0 +1,169 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-DEFINITION\-UPDATE" "1" "" "roark-metric-definition-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-definition\-update \- Update a metric definition
5
+ .SH "SYNOPSIS"
6
+ .B roark metric definition update
7
+ \fIid\-or\-slug\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Update the editable subset of a custom metric definition, addressed by its UUID or its stable `slug`. Only the supplied fields are changed; omitted fields are left unchanged. Every update creates a new immutable version; the response carries the advanced `versionId`. Immutable fields (scope, outputType, calcType, …) are rejected, and which fields are editable depends on the metric (e.g. derived metrics only allow `name`). Roark's own metrics are rejected here: this endpoint edits the shared definition, which every workspace sees. To change one for your workspace alone, edit its variant with PUT /v1/metric/definitions/{idOrSlug}/variants/{variantId}, which forks it for you and leaves every other workspace on the original.
10
+ .SH "API"
11
+ PUT /v1/metric/definitions/{idOrSlug}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIid\-or\-slug\fR
15
+ The metric definition's Roark ID (UUID) or its stable `slug` (e.g. `customer_satisfaction`).
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-name\fR \fI<value>\fR
19
+ New name (only for metrics whose name is editable) Optional.
20
+ .TP
21
+ \fB\-\-llm\-prompt\fR \fI<value>\fR
22
+ New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable) Optional.
23
+ .TP
24
+ \fB\-\-scale\-min\fR \fI<value>\fR
25
+ New scale minimum (SCALE output only) Optional.
26
+ .TP
27
+ \fB\-\-scale\-max\fR \fI<value>\fR
28
+ New scale maximum (SCALE output only) Optional.
29
+ .TP
30
+ \fB\-\-scale\-labels\fR \fI<value>\fR
31
+ Replacement set of scale\-range labels (SCALE output only) Optional.
32
+ .TP
33
+ \fB\-\-boolean\-true\-label\fR \fI<value>\fR
34
+ New label for the true case (BOOLEAN output only) Optional.
35
+ .TP
36
+ \fB\-\-boolean\-false\-label\fR \fI<value>\fR
37
+ New label for the false case (BOOLEAN output only) Optional.
38
+ .TP
39
+ \fB\-\-classification\-options\fR \fI<value>\fR
40
+ Replacement set of classification options (CLASSIFICATION output only) Optional.
41
+ .TP
42
+ \fB\-\-max\-classifications\fR \fI<value>\fR
43
+ New maximum number of classifications (CLASSIFICATION output only) Optional.
44
+ .TP
45
+ \fB\-\-tool\-definition\-ids\fR \fI<value>\fR
46
+ Replacement set of scoped tool\-definition ids (only for metrics whose tool scoping is editable) Repeatable. Optional.
47
+ .TP
48
+ \fB\-\-supported\-contexts\fR \fI<value>\fR
49
+ Replacement set of supported contexts. Omit to leave unchanged. One of: CALL, SEGMENT, TURN. Repeatable. Optional.
50
+ .TP
51
+ \fB\-\-formula\fR \fI<value>\fR
52
+ New formula expression (FORMULA only). Pass `sources` alongside if the referenced metrics change. Optional.
53
+ .TP
54
+ \fB\-\-sources\fR \fI<value>\fR
55
+ Replacement formula sources, required when `formula` changes the referenced metrics (FORMULA only). Optional.
56
+ .TP
57
+ \fB\-\-change\-reason\fR \fI<value>\fR
58
+ Optional free\-text audit note recorded on the new version. Optional.
59
+ .TP
60
+ \fB\-\-slug\fR \fI<value>\fR
61
+ Optional.
62
+ .TP
63
+ \fB\-\-metric\-id\fR \fI<value>\fR
64
+ Optional.
65
+ .TP
66
+ \fB\-\-source\fR \fI<value>\fR
67
+ Optional.
68
+ .TP
69
+ \fB\-\-organization\-id\fR \fI<value>\fR
70
+ Optional.
71
+ .TP
72
+ \fB\-\-project\-id\fR \fI<value>\fR
73
+ Optional.
74
+ .TP
75
+ \fB\-\-output\-type\fR \fI<value>\fR
76
+ Optional.
77
+ .TP
78
+ \fB\-\-scope\fR \fI<value>\fR
79
+ Optional.
80
+ .TP
81
+ \fB\-\-participant\-role\fR \fI<value>\fR
82
+ Optional.
83
+ .TP
84
+ \fB\-\-calc\-type\fR \fI<value>\fR
85
+ Optional.
86
+ .TP
87
+ \fB\-\-supports\-multiple\-variants\fR \fI<value>\fR
88
+ Optional.
89
+ .TP
90
+ \fB\-\-analysis\-package\-id\fR \fI<value>\fR
91
+ Optional.
92
+ .SH "GLOBAL OPTIONS"
93
+ .TP
94
+ \fB\-\-data\fR \fI<json>\fR
95
+ Request body as JSON, or @file to read one (@\- for stdin).
96
+ .TP
97
+ \fB\-y\fR, \fB\-\-yes\fR
98
+ Skip confirmation prompts.
99
+ .TP
100
+ \fB\-\-no\-input\fR
101
+ Never prompt; fail instead.
102
+ .TP
103
+ \fB\-\-base\-url\fR \fI<url>\fR
104
+ API base URL.
105
+ .TP
106
+ \fB\-\-token\fR \fI<token>\fR
107
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
108
+ .TP
109
+ \fB\-\-timeout\fR \fI<ms>\fR
110
+ Request timeout in milliseconds.
111
+ .TP
112
+ \fB\-\-max\-retries\fR \fI<count>\fR
113
+ Retries for retryable failures.
114
+ .TP
115
+ \fB\-\-format\fR \fI<format>\fR
116
+ Output format: auto, json, jsonl, plain.
117
+ .TP
118
+ \fB\-\-json\fR
119
+ Shorthand for \-\-format json.
120
+ .TP
121
+ \fB\-\-no\-color\fR
122
+ Disable colour.
123
+ .TP
124
+ \fB\-q\fR, \fB\-\-quiet\fR
125
+ Suppress non\-essential output.
126
+ .TP
127
+ \fB\-\-allow\-project\-base\-url\fR
128
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
129
+ .SH "EXAMPLES"
130
+ .PP
131
+ .RS 4
132
+ .nf
133
+ roark metric definition update <id\-or\-slug>
134
+ .fi
135
+ .RE
136
+ .SH "ENVIRONMENT"
137
+ .TP
138
+ \fBROARK_API_BEARER_TOKEN\fR
139
+ Bearer token used when \-\-token is not given.
140
+ .TP
141
+ \fBROARK_BASE_URL\fR
142
+ API base URL.
143
+ .TP
144
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
145
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
146
+ .TP
147
+ \fBNO_COLOR\fR
148
+ Disables colour when set to any value.
149
+ .SH "EXIT STATUS"
150
+ .TP
151
+ \fB0\fR
152
+ The command succeeded.
153
+ .TP
154
+ \fB1\fR
155
+ The API rejected the request.
156
+ .TP
157
+ \fB2\fR
158
+ The command line was wrong.
159
+ .TP
160
+ \fB3\fR
161
+ No credential, or the credential was refused.
162
+ .TP
163
+ \fB4\fR
164
+ The addressed resource does not exist.
165
+ .TP
166
+ \fB5\fR
167
+ The request never completed: connection, timeout, or abort.
168
+ .SH "SEE ALSO"
169
+ .BR roark (1)
package/man/roark-metric-variant-create.1 ADDED
@@ -0,0 +1,97 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-VARIANT\-CREATE" "1" "" "roark-metric-variant-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-variant\-create \- Create a metric variant
5
+ .SH "SYNOPSIS"
6
+ .B roark metric variant create
7
+ \fIid\-or\-slug\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Add a configuration of this metric for your organization, seeded from its Default. Edit it with PUT to change what it measures, then pin it where you want it used. Threshold metrics have no variants: their configuration comes from the metric they derive from. Metrics in a package that manages its own variants reject this too.
10
+ .SH "API"
11
+ POST /v1/metric/definitions/{idOrSlug}/variants
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIid\-or\-slug\fR
15
+ Metric definition UUID or its stable slug.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-name\fR \fI<value>\fR
19
+ Name for the new variant. Must be unique for this metric within your organization and cannot be `Default`. Required.
20
+ .SH "GLOBAL OPTIONS"
21
+ .TP
22
+ \fB\-\-data\fR \fI<json>\fR
23
+ Request body as JSON, or @file to read one (@\- for stdin).
24
+ .TP
25
+ \fB\-y\fR, \fB\-\-yes\fR
26
+ Skip confirmation prompts.
27
+ .TP
28
+ \fB\-\-no\-input\fR
29
+ Never prompt; fail instead.
30
+ .TP
31
+ \fB\-\-base\-url\fR \fI<url>\fR
32
+ API base URL.
33
+ .TP
34
+ \fB\-\-token\fR \fI<token>\fR
35
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
36
+ .TP
37
+ \fB\-\-timeout\fR \fI<ms>\fR
38
+ Request timeout in milliseconds.
39
+ .TP
40
+ \fB\-\-max\-retries\fR \fI<count>\fR
41
+ Retries for retryable failures.
42
+ .TP
43
+ \fB\-\-format\fR \fI<format>\fR
44
+ Output format: auto, json, jsonl, plain.
45
+ .TP
46
+ \fB\-\-json\fR
47
+ Shorthand for \-\-format json.
48
+ .TP
49
+ \fB\-\-no\-color\fR
50
+ Disable colour.
51
+ .TP
52
+ \fB\-q\fR, \fB\-\-quiet\fR
53
+ Suppress non\-essential output.
54
+ .TP
55
+ \fB\-\-allow\-project\-base\-url\fR
56
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
57
+ .SH "EXAMPLES"
58
+ .PP
59
+ .RS 4
60
+ .nf
61
+ roark metric variant create <id\-or\-slug> \-\-name <value>
62
+ .fi
63
+ .RE
64
+ .SH "ENVIRONMENT"
65
+ .TP
66
+ \fBROARK_API_BEARER_TOKEN\fR
67
+ Bearer token used when \-\-token is not given.
68
+ .TP
69
+ \fBROARK_BASE_URL\fR
70
+ API base URL.
71
+ .TP
72
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
73
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
74
+ .TP
75
+ \fBNO_COLOR\fR
76
+ Disables colour when set to any value.
77
+ .SH "EXIT STATUS"
78
+ .TP
79
+ \fB0\fR
80
+ The command succeeded.
81
+ .TP
82
+ \fB1\fR
83
+ The API rejected the request.
84
+ .TP
85
+ \fB2\fR
86
+ The command line was wrong.
87
+ .TP
88
+ \fB3\fR
89
+ No credential, or the credential was refused.
90
+ .TP
91
+ \fB4\fR
92
+ The addressed resource does not exist.
93
+ .TP
94
+ \fB5\fR
95
+ The request never completed: connection, timeout, or abort.
96
+ .SH "SEE ALSO"
97
+ .BR roark (1)
package/man/roark-metric-variant-delete.1 ADDED
@@ -0,0 +1,96 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-VARIANT\-DELETE" "1" "" "roark-metric-variant-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-variant\-delete \- Delete a metric variant
5
+ .SH "SYNOPSIS"
6
+ .B roark metric variant delete
7
+ \fIid\-or\-slug\fR \fIvariant\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Remove one of your organization’s variants. Anything pinned to it falls back to the Default, so deleting a fork of a Roark variant returns you to Roark’s configuration. Roark’s own variants cannot be deleted, and neither can a Default. Values already collected under the deleted variant are retained.
10
+ .SH "API"
11
+ DELETE /v1/metric/definitions/{idOrSlug}/variants/{variantId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIid\-or\-slug\fR
15
+ Metric definition UUID or its stable slug.
16
+ .TP
17
+ \fIvariant\-id\fR
18
+ Variant UUID.
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 metric variant delete <id\-or\-slug> <variant\-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)
package/man/roark-metric-variant-get.1 ADDED
@@ -0,0 +1,96 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-VARIANT\-GET" "1" "" "roark-metric-variant-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-variant\-get \- Get a metric variant
5
+ .SH "SYNOPSIS"
6
+ .B roark metric variant get
7
+ \fIid\-or\-slug\fR \fIvariant\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ One configuration of this metric, by id.
10
+ .SH "API"
11
+ GET /v1/metric/definitions/{idOrSlug}/variants/{variantId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIid\-or\-slug\fR
15
+ Metric definition UUID or its stable slug.
16
+ .TP
17
+ \fIvariant\-id\fR
18
+ Variant UUID.
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 metric variant get <id\-or\-slug> <variant\-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)
package/man/roark-metric-variant-list.1 ADDED
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-VARIANT\-LIST" "1" "" "roark-metric-variant-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-variant\-list \- List a metric’s variants
5
+ .SH "SYNOPSIS"
6
+ .B roark metric variant list
7
+ \fIid\-or\-slug\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Every configuration of this metric your organization can use: Roark’s own variants and any your organization has added or forked. `isDefault` marks the one the metric is scored with when nothing pins another; pass any variant’s `id` as `sourceVariantId` to pin it on a derived metric. Auto\-managed variants (the ones a package materializes for you) are not listed: they are engine state, not configuration you author.
10
+ .SH "API"
11
+ GET /v1/metric/definitions/{idOrSlug}/variants
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIid\-or\-slug\fR
15
+ Metric definition UUID or its stable slug.
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 variant list <id\-or\-slug>
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)