@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.
- package/LICENSE +201 -0
- package/README.md +225 -0
- package/bin.d.ts +2 -0
- package/bin.js +14 -0
- package/commands.d.ts +5 -0
- package/commands.js +3553 -0
- package/completions.d.ts +1 -0
- package/completions.js +13 -0
- package/index.d.ts +6 -0
- package/index.js +26 -0
- package/man/roark-agent-create.1 +99 -0
- package/man/roark-agent-endpoint-create.1 +108 -0
- package/man/roark-agent-endpoint-get.1 +93 -0
- package/man/roark-agent-endpoint-list.1 +102 -0
- package/man/roark-agent-endpoint-update.1 +103 -0
- package/man/roark-agent-get.1 +93 -0
- package/man/roark-agent-list.1 +99 -0
- package/man/roark-agent-update.1 +100 -0
- package/man/roark-call-create.1 +150 -0
- package/man/roark-call-get.1 +93 -0
- package/man/roark-call-list.1 +111 -0
- package/man/roark-call-metric-list.1 +100 -0
- package/man/roark-call-sentiment-run-list.1 +93 -0
- package/man/roark-call-transcript-get.1 +97 -0
- package/man/roark-config-apply.1 +96 -0
- package/man/roark-config-diff.1 +96 -0
- package/man/roark-customer-flow-create.1 +97 -0
- package/man/roark-customer-flow-delete.1 +93 -0
- package/man/roark-customer-flow-edge-case-create.1 +112 -0
- package/man/roark-customer-flow-edge-case-delete.1 +96 -0
- package/man/roark-customer-flow-edge-case-promote.1 +96 -0
- package/man/roark-customer-flow-edge-case-update.1 +118 -0
- package/man/roark-customer-flow-get.1 +93 -0
- package/man/roark-customer-flow-graph-replace.1 +100 -0
- package/man/roark-customer-flow-happy-path-update.1 +115 -0
- package/man/roark-customer-flow-list.1 +105 -0
- package/man/roark-customer-flow-update.1 +109 -0
- package/man/roark-health.1 +89 -0
- package/man/roark-http-request-definition-create.1 +108 -0
- package/man/roark-http-request-definition-get.1 +93 -0
- package/man/roark-http-request-definition-list.1 +96 -0
- package/man/roark-http-request-definition-update.1 +109 -0
- package/man/roark-metric-collection-job-create.1 +99 -0
- package/man/roark-metric-collection-job-get.1 +93 -0
- package/man/roark-metric-collection-job-list.1 +99 -0
- package/man/roark-metric-definition-create.1 +100 -0
- package/man/roark-metric-definition-list.1 +89 -0
- package/man/roark-metric-policy-create.1 +105 -0
- package/man/roark-metric-policy-delete.1 +93 -0
- package/man/roark-metric-policy-get.1 +93 -0
- package/man/roark-metric-policy-list.1 +99 -0
- package/man/roark-metric-policy-update.1 +106 -0
- package/man/roark-simulation-environment-get.1 +93 -0
- package/man/roark-simulation-environment-list.1 +96 -0
- package/man/roark-simulation-job-get.1 +93 -0
- package/man/roark-simulation-job-lookup.1 +96 -0
- package/man/roark-simulation-persona-create.1 +156 -0
- package/man/roark-simulation-persona-get.1 +93 -0
- package/man/roark-simulation-persona-list.1 +99 -0
- package/man/roark-simulation-persona-update.1 +160 -0
- package/man/roark-simulation-plan-create.1 +138 -0
- package/man/roark-simulation-plan-delete.1 +93 -0
- package/man/roark-simulation-plan-get.1 +93 -0
- package/man/roark-simulation-plan-job-get.1 +93 -0
- package/man/roark-simulation-plan-job-list.1 +108 -0
- package/man/roark-simulation-plan-job-start.1 +97 -0
- package/man/roark-simulation-plan-list.1 +102 -0
- package/man/roark-simulation-plan-update.1 +142 -0
- package/man/roark-simulation-run.1 +97 -0
- package/man/roark-webhook-create.1 +102 -0
- package/man/roark-webhook-delete.1 +93 -0
- package/man/roark-webhook-get.1 +93 -0
- package/man/roark-webhook-list.1 +96 -0
- package/man/roark.1 +287 -0
- package/package.json +102 -0
- package/runtime/commands/api.d.ts +26 -0
- package/runtime/commands/api.js +85 -0
- package/runtime/commands/auth.d.ts +9 -0
- package/runtime/commands/auth.js +111 -0
- package/runtime/commands/completion.d.ts +9 -0
- package/runtime/commands/completion.js +42 -0
- package/runtime/commands/config.d.ts +15 -0
- package/runtime/commands/config.js +125 -0
- package/runtime/config.d.ts +65 -0
- package/runtime/config.js +163 -0
- package/runtime/confirm.d.ts +16 -0
- package/runtime/confirm.js +34 -0
- package/runtime/errors.d.ts +45 -0
- package/runtime/errors.js +91 -0
- package/runtime/input.d.ts +52 -0
- package/runtime/input.js +211 -0
- package/runtime/output.d.ts +41 -0
- package/runtime/output.js +90 -0
- package/runtime/program.d.ts +45 -0
- package/runtime/program.js +305 -0
- package/runtime/types.d.ts +53 -0
- package/runtime/types.js +10 -0
- package/version.d.ts +1 -0
- package/version.js +8 -0
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-PLAN\-JOB\-START" "1" "" "roark-simulation-plan-job-start" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-plan\-job\-start \- Run a simulation plan
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation plan job start
|
|
7
|
+
\fIplan\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deprecated: use POST /v1/simulation/run, which does the same thing and can also take the plan configuration inline, so a one\-off run does not have to create a plan first. Creates and executes a job for an existing simulation run plan. Optionally provide runtime variables to override plan\-defined variables.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/simulation/plan/{planId}/job
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIplan\-id\fR
|
|
15
|
+
Simulation run plan ID
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-variables\fR \fI<value>\fR
|
|
19
|
+
Values for the {{variables}} the run resolves, overriding whatever the plan has pinned. An object applies them to the whole run: { "orderNumber": "12345", "tier": "gold" } An array applies them per flow, or to just its happy path or one of its edge cases, when a single set will not do. Each entry carries what it applies to: [ { "flowId": "550e8400\-...", "variables": { "orderNumber": "12345" } }, { "flowId": "550e8400\-...", "happyPath": true, "variables": { "orderNumber": "55555" } }, { "flowId": "550e8400\-...", "edgeCaseId": "7a3d2e1f\-...", "variables": { "orderNumber": "67890" } } ] An entry that narrows to neither covers everything that flow resolves. A flow this plan does not attach, or an edge case that does not belong to the flow, is rejected rather than ignored. A plan built on scenarios rather than customer flows targets them the same way, with `scenarioId` in place of `flowId`. That form is deprecated alongside scenarios themselves, and still accepted so runs against those plans keep working. 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 simulation plan job start <plan\-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,102 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-PLAN\-LIST" "1" "" "roark-simulation-plan-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-plan\-list \- List run plans
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation plan list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns a paginated list of simulation run plans. Optionally filter by search text or agent ID.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/simulation/plan
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-limit\fR \fI<value>\fR
|
|
15
|
+
Maximum number of run plans 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\-\-search\-text\fR \fI<value>\fR
|
|
21
|
+
Search text to filter run plans by name Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-agent\-id\fR \fI<value>\fR
|
|
24
|
+
Filter run plans by agent ID Optional.
|
|
25
|
+
.SH "GLOBAL OPTIONS"
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
28
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
31
|
+
Skip confirmation prompts.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-no\-input\fR
|
|
34
|
+
Never prompt; fail instead.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
37
|
+
API base URL.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
40
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
43
|
+
Request timeout in milliseconds.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
46
|
+
Retries for retryable failures.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
49
|
+
Output format: auto, json, jsonl, plain.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-json\fR
|
|
52
|
+
Shorthand for \-\-format json.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-no\-color\fR
|
|
55
|
+
Disable colour.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
58
|
+
Suppress non\-essential output.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
61
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
62
|
+
.SH "EXAMPLES"
|
|
63
|
+
.PP
|
|
64
|
+
.RS 4
|
|
65
|
+
.nf
|
|
66
|
+
roark simulation plan list
|
|
67
|
+
.fi
|
|
68
|
+
.RE
|
|
69
|
+
.SH "ENVIRONMENT"
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
72
|
+
Bearer token used when \-\-token is not given.
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_BASE_URL\fR
|
|
75
|
+
API base URL.
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
78
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
79
|
+
.TP
|
|
80
|
+
\fBNO_COLOR\fR
|
|
81
|
+
Disables colour when set to any value.
|
|
82
|
+
.SH "EXIT STATUS"
|
|
83
|
+
.TP
|
|
84
|
+
\fB0\fR
|
|
85
|
+
The command succeeded.
|
|
86
|
+
.TP
|
|
87
|
+
\fB1\fR
|
|
88
|
+
The API rejected the request.
|
|
89
|
+
.TP
|
|
90
|
+
\fB2\fR
|
|
91
|
+
The command line was wrong.
|
|
92
|
+
.TP
|
|
93
|
+
\fB3\fR
|
|
94
|
+
No credential, or the credential was refused.
|
|
95
|
+
.TP
|
|
96
|
+
\fB4\fR
|
|
97
|
+
The addressed resource does not exist.
|
|
98
|
+
.TP
|
|
99
|
+
\fB5\fR
|
|
100
|
+
The request never completed: connection, timeout, or abort.
|
|
101
|
+
.SH "SEE ALSO"
|
|
102
|
+
.BR roark (1)
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-PLAN\-UPDATE" "1" "" "roark-simulation-plan-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-plan\-update \- Update a run plan
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation plan update
|
|
7
|
+
\fIplan\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Updates an existing simulation run plan by its ID.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PUT /v1/simulation/plan/{planId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIplan\-id\fR
|
|
15
|
+
The ID of the run plan to update
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-is\-hidden\fR
|
|
19
|
+
Whether this plan is hidden from GET /v1/simulation/plan. A run started without `saveAsPlan` creates a hidden plan to carry it. Send `{ "name": "...", "isHidden": false }` to keep that configuration as a reusable plan, which is what the app does when you save a one\-off run. Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
22
|
+
Name of the run plan Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
25
|
+
Description of the run plan Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-direction\fR \fI<value>\fR
|
|
28
|
+
Direction of the simulation (INBOUND or OUTBOUND) One of: INBOUND, OUTBOUND. Optional.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-iteration\-count\fR \fI<value>\fR
|
|
31
|
+
Number of iterations to run for each test case (1\-10000) Optional.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-max\-concurrent\-jobs\fR \fI<value>\fR
|
|
34
|
+
Maximum number of concurrent simulation jobs Optional.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-simulation\-duration\-seconds\fR \fI<value>\fR
|
|
37
|
+
Maximum duration in seconds for each simulation Optional.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-silence\-timeout\-seconds\fR \fI<value>\fR
|
|
40
|
+
Timeout in seconds for silence detection Optional.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-end\-call\-phrases\fR \fI<value>\fR
|
|
43
|
+
Phrases that trigger end of call. Empty array disables the feature. Repeatable. Optional.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-end\-call\-reasons\fR \fI<value>\fR
|
|
46
|
+
Semantic conditions that trigger end of call. The LLM evaluates the conversation against these conditions. Empty array disables the feature. Repeatable. Optional.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-execution\-mode\fR \fI<value>\fR
|
|
49
|
+
Execution mode (PARALLEL or SEQUENTIAL) One of: PARALLEL, SEQUENTIAL_SAME_RUN_PLAN, SEQUENTIAL_PROJECT. Optional.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-scenarios\fR \fI<value>\fR
|
|
52
|
+
Deprecated: use `flows` instead. Replaces the scenarios on this run plan. Omit to leave them unchanged; send an empty array to detach them all, which is how a scenario\-based plan is moved over to flows. Optional.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-flows\fR \fI<value>\fR
|
|
55
|
+
Replaces the customer flows attached to this run plan. Omit to leave them unchanged; send an empty array to detach them all. Optional.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-personas\fR \fI<value>\fR
|
|
58
|
+
Personas to include in this run plan Optional.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-agent\-endpoints\fR \fI<value>\fR
|
|
61
|
+
Agent endpoints to include in this run plan Optional.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-metrics\fR \fI<value>\fR
|
|
64
|
+
Metric definitions to include in this run plan. Reference each by `id` (UUID) or `slug`. Optional.
|
|
65
|
+
.SH "GLOBAL OPTIONS"
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
68
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
71
|
+
Skip confirmation prompts.
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-no\-input\fR
|
|
74
|
+
Never prompt; fail instead.
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
77
|
+
API base URL.
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
80
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
81
|
+
.TP
|
|
82
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
83
|
+
Request timeout in milliseconds.
|
|
84
|
+
.TP
|
|
85
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
86
|
+
Retries for retryable failures.
|
|
87
|
+
.TP
|
|
88
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
89
|
+
Output format: auto, json, jsonl, plain.
|
|
90
|
+
.TP
|
|
91
|
+
\fB\-\-json\fR
|
|
92
|
+
Shorthand for \-\-format json.
|
|
93
|
+
.TP
|
|
94
|
+
\fB\-\-no\-color\fR
|
|
95
|
+
Disable colour.
|
|
96
|
+
.TP
|
|
97
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
98
|
+
Suppress non\-essential output.
|
|
99
|
+
.TP
|
|
100
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
101
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
102
|
+
.SH "EXAMPLES"
|
|
103
|
+
.PP
|
|
104
|
+
.RS 4
|
|
105
|
+
.nf
|
|
106
|
+
roark simulation plan update <plan\-id>
|
|
107
|
+
.fi
|
|
108
|
+
.RE
|
|
109
|
+
.SH "ENVIRONMENT"
|
|
110
|
+
.TP
|
|
111
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
112
|
+
Bearer token used when \-\-token is not given.
|
|
113
|
+
.TP
|
|
114
|
+
\fBROARK_BASE_URL\fR
|
|
115
|
+
API base URL.
|
|
116
|
+
.TP
|
|
117
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
118
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
119
|
+
.TP
|
|
120
|
+
\fBNO_COLOR\fR
|
|
121
|
+
Disables colour when set to any value.
|
|
122
|
+
.SH "EXIT STATUS"
|
|
123
|
+
.TP
|
|
124
|
+
\fB0\fR
|
|
125
|
+
The command succeeded.
|
|
126
|
+
.TP
|
|
127
|
+
\fB1\fR
|
|
128
|
+
The API rejected the request.
|
|
129
|
+
.TP
|
|
130
|
+
\fB2\fR
|
|
131
|
+
The command line was wrong.
|
|
132
|
+
.TP
|
|
133
|
+
\fB3\fR
|
|
134
|
+
No credential, or the credential was refused.
|
|
135
|
+
.TP
|
|
136
|
+
\fB4\fR
|
|
137
|
+
The addressed resource does not exist.
|
|
138
|
+
.TP
|
|
139
|
+
\fB5\fR
|
|
140
|
+
The request never completed: connection, timeout, or abort.
|
|
141
|
+
.SH "SEE ALSO"
|
|
142
|
+
.BR roark (1)
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-RUN" "1" "" "roark-simulation-run" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-run \- Run a simulation
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation run
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Starts a simulation and returns the run. Send `plan` to describe a simulation and run it once. Add `saveAsPlan` to keep that configuration as a reusable run plan. Send `planId` instead to run a plan you already have.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/simulation/run
|
|
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
|
+
\fBRunSimulationFromConfig\fR
|
|
16
|
+
Requires plan.
|
|
17
|
+
.TP
|
|
18
|
+
\fBRunSimulationFromPlanId\fR
|
|
19
|
+
Requires planId.
|
|
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 simulation run \-\-data '{ ... }'
|
|
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,102 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-WEBHOOK\-CREATE" "1" "" "roark-webhook-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-webhook\-create \- Create webhook
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark webhook create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Creates a new webhook with event subscriptions. The signing secret is only returned in this response.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/webhook
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-url\fR \fI<value>\fR
|
|
15
|
+
Webhook URL Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
18
|
+
Webhook description Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-headers\fR \fI<value>\fR
|
|
21
|
+
Request headers (e.g. authorization tokens) Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-events\fR \fI<value>\fR
|
|
24
|
+
Event types to subscribe to (at least one required) One of: CALL_ANALYSIS_COMPLETED, CALL_ANALYSIS_FAILED, CALL_ANALYSIS_CANCELLED, CALL_EVALUATION_COMPLETED, CALL_EVALUATION_FAILED, SIMULATION_RUN_PLAN_JOB_STARTED, SIMULATION_RUN_PLAN_JOB_COMPLETED, SIMULATION_RUN_PLAN_JOB_FAILED, SIMULATION_RUN_PLAN_JOB_CANCELLED, SIMULATION_JOB_STARTED, SIMULATION_JOB_COMPLETED, SIMULATION_JOB_FAILED, SIMULATION_JOB_CANCELLED, METRIC_COLLECTION_JOB_COMPLETED, METRIC_COLLECTION_JOB_FAILED, CHAT_ANALYSIS_COMPLETED, CHAT_ANALYSIS_FAILED, ISSUE_OPENED, ISSUE_RESOLVED. Repeatable. Required.
|
|
25
|
+
.SH "GLOBAL OPTIONS"
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
28
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
31
|
+
Skip confirmation prompts.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-no\-input\fR
|
|
34
|
+
Never prompt; fail instead.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
37
|
+
API base URL.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
40
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
43
|
+
Request timeout in milliseconds.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
46
|
+
Retries for retryable failures.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
49
|
+
Output format: auto, json, jsonl, plain.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-json\fR
|
|
52
|
+
Shorthand for \-\-format json.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-no\-color\fR
|
|
55
|
+
Disable colour.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
58
|
+
Suppress non\-essential output.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
61
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
62
|
+
.SH "EXAMPLES"
|
|
63
|
+
.PP
|
|
64
|
+
.RS 4
|
|
65
|
+
.nf
|
|
66
|
+
roark webhook create \-\-url <value> \-\-events <value>
|
|
67
|
+
.fi
|
|
68
|
+
.RE
|
|
69
|
+
.SH "ENVIRONMENT"
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
72
|
+
Bearer token used when \-\-token is not given.
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_BASE_URL\fR
|
|
75
|
+
API base URL.
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
78
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
79
|
+
.TP
|
|
80
|
+
\fBNO_COLOR\fR
|
|
81
|
+
Disables colour when set to any value.
|
|
82
|
+
.SH "EXIT STATUS"
|
|
83
|
+
.TP
|
|
84
|
+
\fB0\fR
|
|
85
|
+
The command succeeded.
|
|
86
|
+
.TP
|
|
87
|
+
\fB1\fR
|
|
88
|
+
The API rejected the request.
|
|
89
|
+
.TP
|
|
90
|
+
\fB2\fR
|
|
91
|
+
The command line was wrong.
|
|
92
|
+
.TP
|
|
93
|
+
\fB3\fR
|
|
94
|
+
No credential, or the credential was refused.
|
|
95
|
+
.TP
|
|
96
|
+
\fB4\fR
|
|
97
|
+
The addressed resource does not exist.
|
|
98
|
+
.TP
|
|
99
|
+
\fB5\fR
|
|
100
|
+
The request never completed: connection, timeout, or abort.
|
|
101
|
+
.SH "SEE ALSO"
|
|
102
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-WEBHOOK\-DELETE" "1" "" "roark-webhook-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-webhook\-delete \- Delete webhook
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark webhook delete
|
|
7
|
+
\fIwebhook\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deletes a webhook and all its event subscriptions.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/webhook/{webhookId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIwebhook\-id\fR
|
|
15
|
+
The ID of the webhook to delete
|
|
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 webhook delete <webhook\-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)
|