@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\-CALL\-GET" "1" "" "roark-call-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-call\-get \- Get a call by ID
5
+ .SH "SYNOPSIS"
6
+ .B roark call get
7
+ \fIcall\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Retrieve an existing call by its unique identifier
10
+ .SH "API"
11
+ GET /v1/call/{callId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIcall\-id\fR
15
+ The call\-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 call get <call\-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,111 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CALL\-LIST" "1" "" "roark-call-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-call\-list \- List calls
5
+ .SH "SYNOPSIS"
6
+ .B roark call list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns a paginated list of calls for the authenticated project.
10
+ .SH "API"
11
+ GET /v1/call
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-limit\fR \fI<value>\fR
15
+ Maximum number of calls to return (default: 20, max: 100) 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\-\-sort\-by\fR \fI<value>\fR
21
+ Field to sort by (default: createdAt) One of: createdAt, startedAt, endedAt, duration, title, status. Optional.
22
+ .TP
23
+ \fB\-\-sort\-direction\fR \fI<value>\fR
24
+ Sort direction (default: desc) One of: asc, desc. Optional.
25
+ .TP
26
+ \fB\-\-status\fR \fI<value>\fR
27
+ Filter by call status One of: RINGING, IN_PROGRESS, ENDED. Optional.
28
+ .TP
29
+ \fB\-\-search\-text\fR \fI<value>\fR
30
+ Search text to filter calls by title, summary, or transcript Optional.
31
+ .TP
32
+ \fB\-\-simulation\-run\-plan\-job\-id\fR \fI<value>\fR
33
+ Filter by simulation run plan job ID to get all calls from a specific simulation batch Optional.
34
+ .SH "GLOBAL OPTIONS"
35
+ .TP
36
+ \fB\-\-data\fR \fI<json>\fR
37
+ Request body as JSON, or @file to read one (@\- for stdin).
38
+ .TP
39
+ \fB\-y\fR, \fB\-\-yes\fR
40
+ Skip confirmation prompts.
41
+ .TP
42
+ \fB\-\-no\-input\fR
43
+ Never prompt; fail instead.
44
+ .TP
45
+ \fB\-\-base\-url\fR \fI<url>\fR
46
+ API base URL.
47
+ .TP
48
+ \fB\-\-token\fR \fI<token>\fR
49
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
50
+ .TP
51
+ \fB\-\-timeout\fR \fI<ms>\fR
52
+ Request timeout in milliseconds.
53
+ .TP
54
+ \fB\-\-max\-retries\fR \fI<count>\fR
55
+ Retries for retryable failures.
56
+ .TP
57
+ \fB\-\-format\fR \fI<format>\fR
58
+ Output format: auto, json, jsonl, plain.
59
+ .TP
60
+ \fB\-\-json\fR
61
+ Shorthand for \-\-format json.
62
+ .TP
63
+ \fB\-\-no\-color\fR
64
+ Disable colour.
65
+ .TP
66
+ \fB\-q\fR, \fB\-\-quiet\fR
67
+ Suppress non\-essential output.
68
+ .TP
69
+ \fB\-\-allow\-project\-base\-url\fR
70
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
71
+ .SH "EXAMPLES"
72
+ .PP
73
+ .RS 4
74
+ .nf
75
+ roark call list
76
+ .fi
77
+ .RE
78
+ .SH "ENVIRONMENT"
79
+ .TP
80
+ \fBROARK_API_BEARER_TOKEN\fR
81
+ Bearer token used when \-\-token is not given.
82
+ .TP
83
+ \fBROARK_BASE_URL\fR
84
+ API base URL.
85
+ .TP
86
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
87
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
88
+ .TP
89
+ \fBNO_COLOR\fR
90
+ Disables colour when set to any value.
91
+ .SH "EXIT STATUS"
92
+ .TP
93
+ \fB0\fR
94
+ The command succeeded.
95
+ .TP
96
+ \fB1\fR
97
+ The API rejected the request.
98
+ .TP
99
+ \fB2\fR
100
+ The command line was wrong.
101
+ .TP
102
+ \fB3\fR
103
+ No credential, or the credential was refused.
104
+ .TP
105
+ \fB4\fR
106
+ The addressed resource does not exist.
107
+ .TP
108
+ \fB5\fR
109
+ The request never completed: connection, timeout, or abort.
110
+ .SH "SEE ALSO"
111
+ .BR roark (1)
@@ -0,0 +1,100 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CALL\-METRIC\-LIST" "1" "" "roark-call-metric-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-call\-metric\-list \- List call metrics
5
+ .SH "SYNOPSIS"
6
+ .B roark call metric list
7
+ \fIcall\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Fetch all call\-level metrics for a specific call, including both system\-generated and custom metrics. Only returns rows from the **latest** metric\-collection job per metric — if the same metric has been recomputed, prior runs are excluded and remain in the metric history. By default returns only successfully computed metrics; pass `?status=all` to also include rows that resolved as NOT_APPLICABLE / DATA_MISSING / ERROR (the `value` field is omitted on those entries — check `captureStatus`).
10
+ .SH "API"
11
+ GET /v1/call/{callId}/metrics
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIcall\-id\fR
15
+ The call\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-flatten\fR \fI<value>\fR
19
+ Whether to return a flat list instead of grouped by metric definition (default: false) Optional.
20
+ .TP
21
+ \fB\-\-status\fR \fI<value>\fR
22
+ Filter metrics by capture status. `success` (default) returns only successfully computed metrics — backwards\-compatible with the historical behavior. `all` also returns NOT_APPLICABLE / DATA_MISSING / ERROR rows (with `value` omitted), so clients can distinguish "still computing" from "computed but no value" and exit retry loops correctly. One of: success, all. 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 metric list <call\-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,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CALL\-SENTIMENT\-RUN\-LIST" "1" "" "roark-call-sentiment-run-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-call\-sentiment\-run\-list \- List call sentiment runs
5
+ .SH "SYNOPSIS"
6
+ .B roark call sentiment\-run list
7
+ \fIcall\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Fetch detailed sentiment analysis results for a specific call, including emotional tone, key phrases, and sentiment scores.
10
+ .SH "API"
11
+ GET /v1/call/{callId}/sentiment\-run
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIcall\-id\fR
15
+ The call\-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 call sentiment\-run list <call\-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,97 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CALL\-TRANSCRIPT\-GET" "1" "" "roark-call-transcript-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-call\-transcript\-get \- Get call transcript
5
+ .SH "SYNOPSIS"
6
+ .B roark call transcript get
7
+ \fIcall\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Fetch the full transcript for a specific call. Optionally specify a transcription source; otherwise the best available source is used automatically.
10
+ .SH "API"
11
+ GET /v1/call/{callId}/transcript
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIcall\-id\fR
15
+ The call\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-source\fR \fI<value>\fR
19
+ Transcription source to fetch. When omitted, uses the preferred source based on availability: CUSTOMER_AGENT_REALTIME > SIMULATION_AGENT_REALTIME > ROARK_POST_CALL One of: ROARK_POST_CALL, SIMULATION_AGENT_REALTIME, CUSTOMER_AGENT_REALTIME. Optional.
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 call transcript get <call\-id>
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)
@@ -0,0 +1,96 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CONFIG\-APPLY" "1" "" "roark-config-apply" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-config\-apply \- Apply a config bundle
5
+ .SH "SYNOPSIS"
6
+ .B roark config apply
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Reconcile a config\-as\-code bundle into the project. Submit the full desired set of resources; resources already managed by config are updated, new ones created, and (unless prune is false) config\-managed resources absent from the bundle are deleted. Identity is by name — no ids in the bundle.
10
+ .SH "API"
11
+ POST /v1/config/apply
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-resources\fR \fI<value>\fR
15
+ Required.
16
+ .TP
17
+ \fB\-\-prune\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 config apply \-\-resources <value>
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,96 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-CONFIG\-DIFF" "1" "" "roark-config-diff" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-config\-diff \- Diff a config bundle
5
+ .SH "SYNOPSIS"
6
+ .B roark config diff
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Dry run: returns the changes reconcile a config\-as\-code bundle into the project. Submit the full desired set of resources; resources already managed by config are updated, new ones created, and (unless prune is false) config\-managed resources absent from the bundle are deleted. Identity is by name — no ids in the bundle. No writes are performed.
10
+ .SH "API"
11
+ POST /v1/config/diff
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-resources\fR \fI<value>\fR
15
+ Required.
16
+ .TP
17
+ \fB\-\-prune\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 config diff \-\-resources <value>
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)