@roarkanalytics/cli 0.73.1 → 0.75.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/CHANGELOG.md +18 -0
- package/README.md +191 -148
- package/commands.js +2883 -941
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +3 -3
- package/man/roark-agent-conversation-create.1 +106 -0
- package/man/roark-agent-create.1 +27 -3
- package/man/roark-agent-draft-update.1 +4 -1
- package/man/roark-agent-endpoint-create.1 +5 -5
- package/man/roark-agent-endpoint-get.1 +1 -1
- package/man/roark-agent-get.1 +1 -1
- package/man/roark-autoimprove-job-cancel.1 +1 -1
- package/man/roark-autoimprove-job-dismiss.1 +1 -1
- package/man/roark-autoimprove-job-guidance-send.1 +1 -1
- package/man/roark-autoimprove-job-promote.1 +1 -1
- package/man/roark-benchmark-target-history-list.1 +1 -1
- package/man/roark-call-get.1 +1 -1
- package/man/roark-connections-agent-backfill-cancel.1 +96 -0
- package/man/roark-connections-agent-backfill-create.1 +97 -0
- package/man/roark-connections-agent-backfill-list.1 +93 -0
- package/man/roark-connections-agent-create.1 +124 -0
- package/man/roark-connections-agent-delete.1 +93 -0
- package/man/roark-connections-agent-discover.1 +96 -0
- package/man/roark-connections-agent-get.1 +93 -0
- package/man/roark-connections-agent-list.1 +93 -0
- package/man/roark-connections-agent-provider-list.1 +89 -0
- package/man/roark-connections-agent-update.1 +128 -0
- package/man/roark-connections-calendar-calendar-list.1 +93 -0
- package/man/roark-connections-calendar-calendly-oauth-start.1 +99 -0
- package/man/{roark-calendar-connection-check.1 → roark-connections-calendar-check.1} +5 -5
- package/man/{roark-calendar-connection-create.1 → roark-connections-calendar-create.1} +7 -7
- package/man/{roark-calendar-connection-delete.1 → roark-connections-calendar-delete.1} +5 -5
- package/man/{roark-calendar-connection-get.1 → roark-connections-calendar-get.1} +5 -5
- package/man/roark-connections-calendar-google-oauth-start.1 +102 -0
- package/man/{roark-calendar-connection-list.1 → roark-connections-calendar-list.1} +6 -6
- package/man/roark-connections-calendar-target-create.1 +124 -0
- package/man/roark-connections-calendar-target-delete.1 +96 -0
- package/man/{roark-calendar-connection-target-get.1 → roark-connections-calendar-target-get.1} +5 -5
- package/man/{roark-calendar-connection-target-list.1 → roark-connections-calendar-target-list.1} +5 -5
- package/man/roark-connections-calendar-target-update.1 +124 -0
- package/man/{roark-calendar-connection-update.1 → roark-connections-calendar-update.1} +5 -5
- package/man/roark-connections-mcp-server-create.1 +105 -0
- package/man/roark-connections-mcp-server-delete.1 +93 -0
- package/man/roark-connections-mcp-server-discover.1 +99 -0
- package/man/roark-connections-mcp-server-get.1 +93 -0
- package/man/roark-connections-mcp-server-list.1 +89 -0
- package/man/roark-connections-mcp-server-refresh.1 +93 -0
- package/man/roark-connections-mcp-server-update.1 +100 -0
- package/man/roark-conversation-get.1 +93 -0
- package/man/roark-credential-create.1 +2 -2
- package/man/roark-credential-list.1 +2 -2
- package/man/roark-credential-revoke.1 +2 -2
- package/man/{roark-customer-profile-attribute-delete.1 → roark-customer-attribute-delete.1} +5 -5
- package/man/{roark-customer-profile-attribute-unlock.1 → roark-customer-attribute-unlock.1} +5 -5
- package/man/{roark-customer-profile-attribute-update.1 → roark-customer-attribute-update.1} +5 -5
- package/man/{roark-customer-profile-conversation-list.1 → roark-customer-conversation-list.1} +5 -5
- package/man/{roark-customer-profile-delete.1 → roark-customer-delete.1} +6 -6
- package/man/roark-customer-field-create.1 +105 -0
- package/man/roark-customer-field-delete.1 +93 -0
- package/man/roark-customer-field-list.1 +89 -0
- package/man/roark-customer-field-update.1 +106 -0
- package/man/roark-customer-flow-edge-case-create.1 +1 -1
- package/man/roark-customer-flow-edge-case-update.1 +1 -1
- package/man/roark-customer-flow-folder-create.1 +99 -0
- package/man/roark-customer-flow-folder-delete.1 +93 -0
- package/man/roark-customer-flow-folder-list.1 +89 -0
- package/man/roark-customer-flow-get.1 +1 -1
- package/man/roark-customer-flow-happy-path-update.1 +1 -1
- package/man/roark-customer-flow-list.1 +3 -0
- package/man/roark-customer-flow-update.1 +4 -1
- package/man/{roark-customer-profile-get.1 → roark-customer-get.1} +6 -6
- package/man/{roark-customer-profile-list.1 → roark-customer-list.1} +8 -8
- package/man/{roark-customer-profile-notes-update.1 → roark-customer-notes-update.1} +5 -5
- package/man/roark-dashboard-list.1 +1 -1
- package/man/roark-dashboard-update.1 +1 -1
- package/man/roark-http-request-definition-create.1 +1 -1
- package/man/roark-http-request-definition-get.1 +1 -1
- package/man/roark-http-request-definition-update.1 +1 -1
- package/man/roark-metric-collection-job-get.1 +1 -1
- package/man/roark-metric-definition-create.1 +1 -1
- package/man/roark-metric-definition-update.1 +1 -1
- package/man/roark-metric-policy-create.1 +1 -1
- package/man/roark-metric-policy-get.1 +1 -1
- package/man/roark-metric-variant-list.1 +1 -1
- package/man/roark-metric-variant-update.1 +1 -1
- package/man/roark-project-list.1 +1 -1
- package/man/roark-simulation-environment-create.1 +12 -0
- package/man/roark-simulation-environment-get.1 +1 -1
- package/man/roark-simulation-environment-update.1 +12 -0
- package/man/roark-simulation-group-create.1 +2 -2
- package/man/roark-simulation-group-delete.1 +1 -1
- package/man/roark-simulation-group-get.1 +1 -1
- package/man/roark-simulation-group-list.1 +1 -1
- package/man/roark-simulation-group-run.1 +2 -2
- package/man/roark-simulation-group-update.1 +1 -1
- package/man/roark-simulation-job-get.1 +1 -1
- package/man/roark-simulation-job-lookup.1 +1 -1
- package/man/roark-simulation-persona-create.1 +1 -1
- package/man/roark-simulation-persona-get.1 +1 -1
- package/man/roark-simulation-persona-update.1 +1 -1
- package/man/roark-simulation-plan-get.1 +1 -1
- package/man/roark-simulation-plan-job-cancel.1 +1 -1
- package/man/roark-simulation-plan-job-cost-get.1 +1 -1
- package/man/roark-simulation-plan-job-debrief-create.1 +1 -1
- package/man/roark-simulation-plan-job-delete.1 +1 -1
- package/man/roark-simulation-plan-job-get.1 +1 -1
- package/man/roark-simulation-plan-job-list.1 +1 -1
- package/man/roark-simulation-plan-job-result-get.1 +1 -1
- package/man/roark-simulation-plan-update.1 +7 -1
- package/man/roark-simulation-resource-generate.1 +120 -0
- package/man/roark-simulation-resource-generation-answer.1 +97 -0
- package/man/roark-simulation-resource-generation-cancel.1 +93 -0
- package/man/roark-simulation-resource-generation-get.1 +93 -0
- package/man/roark-simulation-resource-generation-guidance-send.1 +97 -0
- package/man/roark-simulation-resource-generation-list.1 +96 -0
- package/man/roark-simulation-run-group-list.1 +1 -1
- package/man/roark-tool-create.1 +32 -2
- package/man/roark-tool-update.1 +32 -2
- package/man/roark-usage-get.1 +1 -1
- package/man/roark-webhook-create.1 +2 -2
- package/man/roark-webhook-delete.1 +1 -1
- package/man/roark-webhook-get.1 +1 -1
- package/man/roark-whoami.1 +1 -1
- package/man/roark.1 +208 -94
- package/npm-shrinkwrap.json +6 -6
- package/package.json +56 -18
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-CREATE" "1" "" "roark-connections-agent-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-create \- Connect an agent
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Connects the platform a project’s agents run on. The body is shaped by `provider`; `GET /v1/connections/agent/providers` lists what each needs. Retell, Vapi, ElevenLabs and Bland keys are checked by listing agents first, so a refused key returns 400 and nothing is stored. Platforms that pull agents start syncing straight away. For LIVEKIT_SELF_HOSTED and the Pipecat providers, the response carries `observerApiKey`, shown once, for your SDK to report calls with. Most platforms connect once per project, and a second create returns 409; LiveKit Cloud may connect several accounts.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/connections/agent
|
|
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
|
+
\fBAgentConnectionCreateRetell\fR
|
|
16
|
+
Requires provider, name, apiKey.
|
|
17
|
+
.TP
|
|
18
|
+
\fBAgentConnectionCreateVapi\fR
|
|
19
|
+
Requires provider, name, apiKey.
|
|
20
|
+
.TP
|
|
21
|
+
\fBAgentConnectionCreateElevenLabs\fR
|
|
22
|
+
Requires provider, name, apiKey.
|
|
23
|
+
.TP
|
|
24
|
+
\fBAgentConnectionCreateBland\fR
|
|
25
|
+
Requires provider, name, apiKey.
|
|
26
|
+
.TP
|
|
27
|
+
\fBAgentConnectionCreateLeaping\fR
|
|
28
|
+
Requires provider, name, apiKey, agentIds.
|
|
29
|
+
.TP
|
|
30
|
+
\fBAgentConnectionCreateLivekit\fR
|
|
31
|
+
Requires provider, name, url, apiKey, apiSecret.
|
|
32
|
+
.TP
|
|
33
|
+
\fBAgentConnectionCreateLivekitSelfHosted\fR
|
|
34
|
+
Requires provider, name.
|
|
35
|
+
.TP
|
|
36
|
+
\fBAgentConnectionCreatePipecatSelfHosted\fR
|
|
37
|
+
Requires provider, name.
|
|
38
|
+
.TP
|
|
39
|
+
\fBAgentConnectionCreatePipecatCloud\fR
|
|
40
|
+
Requires provider, name.
|
|
41
|
+
.TP
|
|
42
|
+
\fBAgentConnectionCreateKore\fR
|
|
43
|
+
Requires provider, name, apiKey, appId, envName.
|
|
44
|
+
.TP
|
|
45
|
+
\fBAgentConnectionCreateGoogleCes\fR
|
|
46
|
+
Requires provider, name, wifConfig, location, appId, deploymentId.
|
|
47
|
+
.SH "GLOBAL OPTIONS"
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
50
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
53
|
+
Skip confirmation prompts.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-no\-input\fR
|
|
56
|
+
Never prompt; fail instead.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
59
|
+
API base URL.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
62
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
65
|
+
Request timeout in milliseconds.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
68
|
+
Retries for retryable failures.
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
71
|
+
Output format: auto, json, jsonl, plain.
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-json\fR
|
|
74
|
+
Shorthand for \-\-format json.
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-no\-color\fR
|
|
77
|
+
Disable colour.
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
80
|
+
Suppress non\-essential output.
|
|
81
|
+
.TP
|
|
82
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
83
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
84
|
+
.SH "EXAMPLES"
|
|
85
|
+
.PP
|
|
86
|
+
.RS 4
|
|
87
|
+
.nf
|
|
88
|
+
roark connections agent create \-\-data '{ ... }'
|
|
89
|
+
.fi
|
|
90
|
+
.RE
|
|
91
|
+
.SH "ENVIRONMENT"
|
|
92
|
+
.TP
|
|
93
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
94
|
+
Bearer token used when \-\-token is not given.
|
|
95
|
+
.TP
|
|
96
|
+
\fBROARK_BASE_URL\fR
|
|
97
|
+
API base URL.
|
|
98
|
+
.TP
|
|
99
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
100
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
101
|
+
.TP
|
|
102
|
+
\fBNO_COLOR\fR
|
|
103
|
+
Disables colour when set to any value.
|
|
104
|
+
.SH "EXIT STATUS"
|
|
105
|
+
.TP
|
|
106
|
+
\fB0\fR
|
|
107
|
+
The command succeeded.
|
|
108
|
+
.TP
|
|
109
|
+
\fB1\fR
|
|
110
|
+
The API rejected the request.
|
|
111
|
+
.TP
|
|
112
|
+
\fB2\fR
|
|
113
|
+
The command line was wrong.
|
|
114
|
+
.TP
|
|
115
|
+
\fB3\fR
|
|
116
|
+
No credential, or the credential was refused.
|
|
117
|
+
.TP
|
|
118
|
+
\fB4\fR
|
|
119
|
+
The addressed resource does not exist.
|
|
120
|
+
.TP
|
|
121
|
+
\fB5\fR
|
|
122
|
+
The request never completed: connection, timeout, or abort.
|
|
123
|
+
.SH "SEE ALSO"
|
|
124
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-DELETE" "1" "" "roark-connections-agent-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-delete \- Disconnect an agent connection
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent delete
|
|
7
|
+
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deletes the connection and its stored credential, and stops syncing. Agents and calls it already brought in stay in the project. Alerts that notify through it stop notifying.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/connections/agent/{connectionId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
The connection\-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 connections agent delete <connection\-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\-CONNECTIONS\-AGENT\-DISCOVER" "1" "" "roark-connections-agent-discover" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-discover \- Discover agents with a platform API key
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent discover
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Lists the agents a Retell, Vapi, ElevenLabs or Bland API key can see, without storing anything. Use it to check a key and to pick `agentIds` before connecting. A key the platform refuses returns 400.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/connections/agent/discover
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-provider\fR \fI<value>\fR
|
|
15
|
+
Platforms whose agents can be listed with a key. One of: RETELL, VAPI, ELEVEN_LABS, BLAND. Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-api\-key\fR \fI<value>\fR
|
|
18
|
+
The platform API key to list agents with. Stored nowhere. Required.
|
|
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 connections agent discover \-\-provider <value> \-\-api\-key <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,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-GET" "1" "" "roark-connections-agent-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-get \- Get an agent connection
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent get
|
|
7
|
+
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
One connection, with its settings and latest sync. Credentials are never returned.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/connections/agent/{connectionId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
The connection\-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 connections agent get <connection\-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,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-LIST" "1" "" "roark-connections-agent-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-list \- List agent connections
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
The project's connections to the platforms its agents run on (Retell, Vapi, LiveKit, Pipecat and others), each with its settings and latest sync. Credentials are never returned.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/connections/agent
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-provider\fR \fI<value>\fR
|
|
15
|
+
The platform the agents run on. LIVEKIT is LiveKit Cloud; LIVEKIT_SELF_HOSTED is the LiveKit Agents SDK reporting through the Roark plugin. PIPECAT_CLOUD_INTEGRATION and PIPECAT_SELF_HOSTED_INTEGRATION are Pipecat Cloud and a self\-hosted Pipecat bot. `GET /v1/connections/agent/providers` describes what each one needs. One of: RETELL, VAPI, ELEVEN_LABS, BLAND, LEAPING, LIVEKIT, LIVEKIT_SELF_HOSTED, PIPECAT_CLOUD_INTEGRATION, PIPECAT_SELF_HOSTED_INTEGRATION, KORE, GOOGLE_CES. Optional.
|
|
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 connections agent list
|
|
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,89 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-PROVIDER\-LIST" "1" "" "roark-connections-agent-provider-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-provider\-list \- List agent connection providers
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent provider list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Every platform a project can connect, with the fields its create body needs, how its calls reach Roark, and which settings apply. Read this before connecting one.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/connections/agent/providers
|
|
12
|
+
.SH "GLOBAL OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
15
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
18
|
+
Skip confirmation prompts.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-no\-input\fR
|
|
21
|
+
Never prompt; fail instead.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
24
|
+
API base URL.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
27
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
30
|
+
Request timeout in milliseconds.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
33
|
+
Retries for retryable failures.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
36
|
+
Output format: auto, json, jsonl, plain.
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-json\fR
|
|
39
|
+
Shorthand for \-\-format json.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-no\-color\fR
|
|
42
|
+
Disable colour.
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
45
|
+
Suppress non\-essential output.
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
48
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
49
|
+
.SH "EXAMPLES"
|
|
50
|
+
.PP
|
|
51
|
+
.RS 4
|
|
52
|
+
.nf
|
|
53
|
+
roark connections agent provider list
|
|
54
|
+
.fi
|
|
55
|
+
.RE
|
|
56
|
+
.SH "ENVIRONMENT"
|
|
57
|
+
.TP
|
|
58
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
59
|
+
Bearer token used when \-\-token is not given.
|
|
60
|
+
.TP
|
|
61
|
+
\fBROARK_BASE_URL\fR
|
|
62
|
+
API base URL.
|
|
63
|
+
.TP
|
|
64
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
65
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
66
|
+
.TP
|
|
67
|
+
\fBNO_COLOR\fR
|
|
68
|
+
Disables colour when set to any value.
|
|
69
|
+
.SH "EXIT STATUS"
|
|
70
|
+
.TP
|
|
71
|
+
\fB0\fR
|
|
72
|
+
The command succeeded.
|
|
73
|
+
.TP
|
|
74
|
+
\fB1\fR
|
|
75
|
+
The API rejected the request.
|
|
76
|
+
.TP
|
|
77
|
+
\fB2\fR
|
|
78
|
+
The command line was wrong.
|
|
79
|
+
.TP
|
|
80
|
+
\fB3\fR
|
|
81
|
+
No credential, or the credential was refused.
|
|
82
|
+
.TP
|
|
83
|
+
\fB4\fR
|
|
84
|
+
The addressed resource does not exist.
|
|
85
|
+
.TP
|
|
86
|
+
\fB5\fR
|
|
87
|
+
The request never completed: connection, timeout, or abort.
|
|
88
|
+
.SH "SEE ALSO"
|
|
89
|
+
.BR roark (1)
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CONNECTIONS\-AGENT\-UPDATE" "1" "" "roark-connections-agent-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-connections\-agent\-update \- Update an agent connection
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark connections agent update
|
|
7
|
+
\fIconnection\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Changes a connection’s settings or rotates its credential. Send `provider` (it must match the connection’s) and only the fields to change; the rest keep their stored values. A new Retell, Vapi, ElevenLabs or Bland key is checked by listing agents first. Set `status` to INACTIVE to pause syncing without deleting anything.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PATCH /v1/connections/agent/{connectionId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIconnection\-id\fR
|
|
15
|
+
The connection\-id.
|
|
16
|
+
.SH "REQUEST BODY"
|
|
17
|
+
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.
|
|
18
|
+
.TP
|
|
19
|
+
\fBAgentConnectionUpdateRetell\fR
|
|
20
|
+
Requires provider.
|
|
21
|
+
.TP
|
|
22
|
+
\fBAgentConnectionUpdateVapi\fR
|
|
23
|
+
Requires provider.
|
|
24
|
+
.TP
|
|
25
|
+
\fBAgentConnectionUpdateElevenLabs\fR
|
|
26
|
+
Requires provider.
|
|
27
|
+
.TP
|
|
28
|
+
\fBAgentConnectionUpdateBland\fR
|
|
29
|
+
Requires provider.
|
|
30
|
+
.TP
|
|
31
|
+
\fBAgentConnectionUpdateLeaping\fR
|
|
32
|
+
Requires provider.
|
|
33
|
+
.TP
|
|
34
|
+
\fBAgentConnectionUpdateLivekit\fR
|
|
35
|
+
Requires provider.
|
|
36
|
+
.TP
|
|
37
|
+
\fBAgentConnectionUpdateLivekitSelfHosted\fR
|
|
38
|
+
Requires provider.
|
|
39
|
+
.TP
|
|
40
|
+
\fBAgentConnectionUpdatePipecatSelfHosted\fR
|
|
41
|
+
Requires provider.
|
|
42
|
+
.TP
|
|
43
|
+
\fBAgentConnectionUpdatePipecatCloud\fR
|
|
44
|
+
Requires provider.
|
|
45
|
+
.TP
|
|
46
|
+
\fBAgentConnectionUpdateKore\fR
|
|
47
|
+
Requires provider.
|
|
48
|
+
.TP
|
|
49
|
+
\fBAgentConnectionUpdateGoogleCes\fR
|
|
50
|
+
Requires provider.
|
|
51
|
+
.SH "GLOBAL OPTIONS"
|
|
52
|
+
.TP
|
|
53
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
54
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
55
|
+
.TP
|
|
56
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
57
|
+
Skip confirmation prompts.
|
|
58
|
+
.TP
|
|
59
|
+
\fB\-\-no\-input\fR
|
|
60
|
+
Never prompt; fail instead.
|
|
61
|
+
.TP
|
|
62
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
63
|
+
API base URL.
|
|
64
|
+
.TP
|
|
65
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
66
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
67
|
+
.TP
|
|
68
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
69
|
+
Request timeout in milliseconds.
|
|
70
|
+
.TP
|
|
71
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
72
|
+
Retries for retryable failures.
|
|
73
|
+
.TP
|
|
74
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
75
|
+
Output format: auto, json, jsonl, plain.
|
|
76
|
+
.TP
|
|
77
|
+
\fB\-\-json\fR
|
|
78
|
+
Shorthand for \-\-format json.
|
|
79
|
+
.TP
|
|
80
|
+
\fB\-\-no\-color\fR
|
|
81
|
+
Disable colour.
|
|
82
|
+
.TP
|
|
83
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
84
|
+
Suppress non\-essential output.
|
|
85
|
+
.TP
|
|
86
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
87
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
88
|
+
.SH "EXAMPLES"
|
|
89
|
+
.PP
|
|
90
|
+
.RS 4
|
|
91
|
+
.nf
|
|
92
|
+
roark connections agent update <connection\-id> \-\-data '{ ... }'
|
|
93
|
+
.fi
|
|
94
|
+
.RE
|
|
95
|
+
.SH "ENVIRONMENT"
|
|
96
|
+
.TP
|
|
97
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
98
|
+
Bearer token used when \-\-token is not given.
|
|
99
|
+
.TP
|
|
100
|
+
\fBROARK_BASE_URL\fR
|
|
101
|
+
API base URL.
|
|
102
|
+
.TP
|
|
103
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
104
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
105
|
+
.TP
|
|
106
|
+
\fBNO_COLOR\fR
|
|
107
|
+
Disables colour when set to any value.
|
|
108
|
+
.SH "EXIT STATUS"
|
|
109
|
+
.TP
|
|
110
|
+
\fB0\fR
|
|
111
|
+
The command succeeded.
|
|
112
|
+
.TP
|
|
113
|
+
\fB1\fR
|
|
114
|
+
The API rejected the request.
|
|
115
|
+
.TP
|
|
116
|
+
\fB2\fR
|
|
117
|
+
The command line was wrong.
|
|
118
|
+
.TP
|
|
119
|
+
\fB3\fR
|
|
120
|
+
No credential, or the credential was refused.
|
|
121
|
+
.TP
|
|
122
|
+
\fB4\fR
|
|
123
|
+
The addressed resource does not exist.
|
|
124
|
+
.TP
|
|
125
|
+
\fB5\fR
|
|
126
|
+
The request never completed: connection, timeout, or abort.
|
|
127
|
+
.SH "SEE ALSO"
|
|
128
|
+
.BR roark (1)
|