@roarkanalytics/cli 0.1.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 (99) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +225 -0
  3. package/bin.d.ts +2 -0
  4. package/bin.js +14 -0
  5. package/commands.d.ts +5 -0
  6. package/commands.js +3553 -0
  7. package/completions.d.ts +1 -0
  8. package/completions.js +13 -0
  9. package/index.d.ts +6 -0
  10. package/index.js +26 -0
  11. package/man/roark-agent-create.1 +99 -0
  12. package/man/roark-agent-endpoint-create.1 +108 -0
  13. package/man/roark-agent-endpoint-get.1 +93 -0
  14. package/man/roark-agent-endpoint-list.1 +102 -0
  15. package/man/roark-agent-endpoint-update.1 +103 -0
  16. package/man/roark-agent-get.1 +93 -0
  17. package/man/roark-agent-list.1 +99 -0
  18. package/man/roark-agent-update.1 +100 -0
  19. package/man/roark-call-create.1 +150 -0
  20. package/man/roark-call-get.1 +93 -0
  21. package/man/roark-call-list.1 +111 -0
  22. package/man/roark-call-metric-list.1 +100 -0
  23. package/man/roark-call-sentiment-run-list.1 +93 -0
  24. package/man/roark-call-transcript-get.1 +97 -0
  25. package/man/roark-config-apply.1 +96 -0
  26. package/man/roark-config-diff.1 +96 -0
  27. package/man/roark-customer-flow-create.1 +97 -0
  28. package/man/roark-customer-flow-delete.1 +93 -0
  29. package/man/roark-customer-flow-edge-case-create.1 +112 -0
  30. package/man/roark-customer-flow-edge-case-delete.1 +96 -0
  31. package/man/roark-customer-flow-edge-case-promote.1 +96 -0
  32. package/man/roark-customer-flow-edge-case-update.1 +118 -0
  33. package/man/roark-customer-flow-get.1 +93 -0
  34. package/man/roark-customer-flow-graph-replace.1 +100 -0
  35. package/man/roark-customer-flow-happy-path-update.1 +115 -0
  36. package/man/roark-customer-flow-list.1 +105 -0
  37. package/man/roark-customer-flow-update.1 +109 -0
  38. package/man/roark-health.1 +89 -0
  39. package/man/roark-http-request-definition-create.1 +108 -0
  40. package/man/roark-http-request-definition-get.1 +93 -0
  41. package/man/roark-http-request-definition-list.1 +96 -0
  42. package/man/roark-http-request-definition-update.1 +109 -0
  43. package/man/roark-metric-collection-job-create.1 +99 -0
  44. package/man/roark-metric-collection-job-get.1 +93 -0
  45. package/man/roark-metric-collection-job-list.1 +99 -0
  46. package/man/roark-metric-definition-create.1 +100 -0
  47. package/man/roark-metric-definition-list.1 +89 -0
  48. package/man/roark-metric-policy-create.1 +105 -0
  49. package/man/roark-metric-policy-delete.1 +93 -0
  50. package/man/roark-metric-policy-get.1 +93 -0
  51. package/man/roark-metric-policy-list.1 +99 -0
  52. package/man/roark-metric-policy-update.1 +106 -0
  53. package/man/roark-simulation-environment-get.1 +93 -0
  54. package/man/roark-simulation-environment-list.1 +96 -0
  55. package/man/roark-simulation-job-get.1 +93 -0
  56. package/man/roark-simulation-job-lookup.1 +96 -0
  57. package/man/roark-simulation-persona-create.1 +156 -0
  58. package/man/roark-simulation-persona-get.1 +93 -0
  59. package/man/roark-simulation-persona-list.1 +99 -0
  60. package/man/roark-simulation-persona-update.1 +160 -0
  61. package/man/roark-simulation-plan-create.1 +138 -0
  62. package/man/roark-simulation-plan-delete.1 +93 -0
  63. package/man/roark-simulation-plan-get.1 +93 -0
  64. package/man/roark-simulation-plan-job-get.1 +93 -0
  65. package/man/roark-simulation-plan-job-list.1 +108 -0
  66. package/man/roark-simulation-plan-job-start.1 +97 -0
  67. package/man/roark-simulation-plan-list.1 +102 -0
  68. package/man/roark-simulation-plan-update.1 +142 -0
  69. package/man/roark-simulation-run.1 +97 -0
  70. package/man/roark-webhook-create.1 +102 -0
  71. package/man/roark-webhook-delete.1 +93 -0
  72. package/man/roark-webhook-get.1 +93 -0
  73. package/man/roark-webhook-list.1 +96 -0
  74. package/man/roark.1 +287 -0
  75. package/package.json +102 -0
  76. package/runtime/commands/api.d.ts +26 -0
  77. package/runtime/commands/api.js +85 -0
  78. package/runtime/commands/auth.d.ts +9 -0
  79. package/runtime/commands/auth.js +111 -0
  80. package/runtime/commands/completion.d.ts +9 -0
  81. package/runtime/commands/completion.js +42 -0
  82. package/runtime/commands/config.d.ts +15 -0
  83. package/runtime/commands/config.js +125 -0
  84. package/runtime/config.d.ts +65 -0
  85. package/runtime/config.js +163 -0
  86. package/runtime/confirm.d.ts +16 -0
  87. package/runtime/confirm.js +34 -0
  88. package/runtime/errors.d.ts +45 -0
  89. package/runtime/errors.js +91 -0
  90. package/runtime/input.d.ts +52 -0
  91. package/runtime/input.js +211 -0
  92. package/runtime/output.d.ts +41 -0
  93. package/runtime/output.js +90 -0
  94. package/runtime/program.d.ts +45 -0
  95. package/runtime/program.js +305 -0
  96. package/runtime/types.d.ts +53 -0
  97. package/runtime/types.js +10 -0
  98. package/version.d.ts +1 -0
  99. package/version.js +8 -0
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-HTTP\-REQUEST\-DEFINITION\-GET" "1" "" "roark-http-request-definition-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-http\-request\-definition\-get \- Get HTTP request definition by ID
5
+ .SH "SYNOPSIS"
6
+ .B roark http\-request\-definition get
7
+ \fIdefinition\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns a specific HTTP request definition by its ID.
10
+ .SH "API"
11
+ GET /v1/http\-request\-definition/{definitionId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIdefinition\-id\fR
15
+ The ID of the HTTP request definition to retrieve
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 http\-request\-definition get <definition\-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,96 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-HTTP\-REQUEST\-DEFINITION\-LIST" "1" "" "roark-http-request-definition-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-http\-request\-definition\-list \- List HTTP request definitions
5
+ .SH "SYNOPSIS"
6
+ .B roark http\-request\-definition list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns a paginated list of HTTP request definitions for the authenticated project.
10
+ .SH "API"
11
+ GET /v1/http\-request\-definition
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-limit\fR \fI<value>\fR
15
+ Maximum number of definitions to return (default: 20, max: 50) Optional.
16
+ .TP
17
+ \fB\-\-after\fR \fI<value>\fR
18
+ Cursor for pagination \- definition ID to start after 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 http\-request\-definition 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,109 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-HTTP\-REQUEST\-DEFINITION\-UPDATE" "1" "" "roark-http-request-definition-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-http\-request\-definition\-update \- Update HTTP request definition
5
+ .SH "SYNOPSIS"
6
+ .B roark http\-request\-definition update
7
+ \fIdefinition\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Updates an existing HTTP request definition.
10
+ .SH "API"
11
+ PUT /v1/http\-request\-definition/{definitionId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIdefinition\-id\fR
15
+ The ID of the HTTP request definition to update
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-url\fR \fI<value>\fR
19
+ URL for the HTTP request Optional.
20
+ .TP
21
+ \fB\-\-description\fR \fI<value>\fR
22
+ Description of the HTTP request definition Optional.
23
+ .TP
24
+ \fB\-\-method\fR \fI<value>\fR
25
+ HTTP method: POST, PUT, PATCH, or GET One of: POST, PUT, PATCH, GET. Optional.
26
+ .TP
27
+ \fB\-\-body\fR \fI<value>\fR
28
+ Request body template. Accepts a JSON object or a string with placeholders like {{phoneNumberToDial}}. Objects are serialized to JSON for storage. Optional.
29
+ .TP
30
+ \fB\-\-headers\fR \fI<value>\fR
31
+ Request headers as key\-value pairs Optional.
32
+ .SH "GLOBAL OPTIONS"
33
+ .TP
34
+ \fB\-\-data\fR \fI<json>\fR
35
+ Request body as JSON, or @file to read one (@\- for stdin).
36
+ .TP
37
+ \fB\-y\fR, \fB\-\-yes\fR
38
+ Skip confirmation prompts.
39
+ .TP
40
+ \fB\-\-no\-input\fR
41
+ Never prompt; fail instead.
42
+ .TP
43
+ \fB\-\-base\-url\fR \fI<url>\fR
44
+ API base URL.
45
+ .TP
46
+ \fB\-\-token\fR \fI<token>\fR
47
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
48
+ .TP
49
+ \fB\-\-timeout\fR \fI<ms>\fR
50
+ Request timeout in milliseconds.
51
+ .TP
52
+ \fB\-\-max\-retries\fR \fI<count>\fR
53
+ Retries for retryable failures.
54
+ .TP
55
+ \fB\-\-format\fR \fI<format>\fR
56
+ Output format: auto, json, jsonl, plain.
57
+ .TP
58
+ \fB\-\-json\fR
59
+ Shorthand for \-\-format json.
60
+ .TP
61
+ \fB\-\-no\-color\fR
62
+ Disable colour.
63
+ .TP
64
+ \fB\-q\fR, \fB\-\-quiet\fR
65
+ Suppress non\-essential output.
66
+ .TP
67
+ \fB\-\-allow\-project\-base\-url\fR
68
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
69
+ .SH "EXAMPLES"
70
+ .PP
71
+ .RS 4
72
+ .nf
73
+ roark http\-request\-definition update <definition\-id>
74
+ .fi
75
+ .RE
76
+ .SH "ENVIRONMENT"
77
+ .TP
78
+ \fBROARK_API_BEARER_TOKEN\fR
79
+ Bearer token used when \-\-token is not given.
80
+ .TP
81
+ \fBROARK_BASE_URL\fR
82
+ API base URL.
83
+ .TP
84
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
85
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
86
+ .TP
87
+ \fBNO_COLOR\fR
88
+ Disables colour when set to any value.
89
+ .SH "EXIT STATUS"
90
+ .TP
91
+ \fB0\fR
92
+ The command succeeded.
93
+ .TP
94
+ \fB1\fR
95
+ The API rejected the request.
96
+ .TP
97
+ \fB2\fR
98
+ The command line was wrong.
99
+ .TP
100
+ \fB3\fR
101
+ No credential, or the credential was refused.
102
+ .TP
103
+ \fB4\fR
104
+ The addressed resource does not exist.
105
+ .TP
106
+ \fB5\fR
107
+ The request never completed: connection, timeout, or abort.
108
+ .SH "SEE ALSO"
109
+ .BR roark (1)
@@ -0,0 +1,99 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-COLLECTION\-JOB\-CREATE" "1" "" "roark-metric-collection-job-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-collection\-job\-create \- Create and run a metric collection job
5
+ .SH "SYNOPSIS"
6
+ .B roark metric collection\-job create
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Creates a metric collection job for the specified calls or chats and metrics, then triggers processing. Provide exactly one of callIds or chatIds.
10
+ .SH "API"
11
+ POST /v1/metric/collection\-jobs
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-call\-ids\fR \fI<value>\fR
15
+ Call IDs to collect metrics for. Mutually exclusive with chatIds. Max 500 per request. Repeatable. Optional.
16
+ .TP
17
+ \fB\-\-chat\-ids\fR \fI<value>\fR
18
+ Chat IDs to collect metrics for. Mutually exclusive with callIds. Max 500 per request. Repeatable. Optional.
19
+ .TP
20
+ \fB\-\-metrics\fR \fI<value>\fR
21
+ Metric definitions to collect. Max 20 per request. Required.
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 metric collection\-job create \-\-metrics <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)
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-COLLECTION\-JOB\-GET" "1" "" "roark-metric-collection-job-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-collection\-job\-get \- Get metric collection job by ID
5
+ .SH "SYNOPSIS"
6
+ .B roark metric collection\-job get
7
+ \fIjob\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns a specific metric collection job with progress information.
10
+ .SH "API"
11
+ GET /v1/metric/collection\-jobs/{jobId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIjob\-id\fR
15
+ The ID of the metric collection job to retrieve
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 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)
@@ -0,0 +1,99 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-COLLECTION\-JOB\-LIST" "1" "" "roark-metric-collection-job-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-collection\-job\-list \- List metric collection jobs
5
+ .SH "SYNOPSIS"
6
+ .B roark metric collection\-job list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns a paginated list of metric collection jobs for the project.
10
+ .SH "API"
11
+ GET /v1/metric/collection\-jobs
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-limit\fR \fI<value>\fR
15
+ Maximum number of jobs to return (default: 20, max: 50) Optional.
16
+ .TP
17
+ \fB\-\-after\fR \fI<value>\fR
18
+ Cursor for pagination \- use the nextCursor value from a previous response Optional.
19
+ .TP
20
+ \fB\-\-status\fR \fI<value>\fR
21
+ Filter by job status One of: PENDING, PROCESSING, COMPLETED, FAILED, CANCELED. 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 metric collection\-job list
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)
@@ -0,0 +1,100 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-METRIC\-DEFINITION\-CREATE" "1" "" "roark-metric-definition-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-metric\-definition\-create \- Create custom metric definition
5
+ .SH "SYNOPSIS"
6
+ .B roark metric definition create
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Create a new metric definition. The `calculationType` field selects the variant: LLM_JUDGE (LLM\-evaluated), FORMULA (computed from a math expression over other metrics), or PATTERN (detects a trigger→outcome pattern within a window). To create a threshold on top of an existing metric, use `POST /metric/definitions/{idOrSlug}/thresholds` instead.
10
+ .SH "API"
11
+ POST /v1/metric/definitions
12
+ .SH "REQUEST BODY"
13
+ This endpoint accepts one of several request shapes, so the body is supplied as JSON through \e\-\e\-data or on standard input rather than as individual flags.
14
+ .TP
15
+ \fBPromptMetricInput\fR
16
+ Requires calculationType, name, outputType, analysisPackageId.
17
+ .TP
18
+ \fBFormulaMetricInput\fR
19
+ Requires calculationType, name, outputType, formula, sources, analysisPackageId.
20
+ .TP
21
+ \fBPatternMetricInput\fR
22
+ Requires calculationType, name, operation, outcome, analysisPackageId.
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 metric definition create \-\-data '{ ... }'
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)