@roarkanalytics/cli 0.59.1 → 0.61.1

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.
@@ -28,6 +28,27 @@ Text\-to\-speech provider, for example ELEVENLABS One of: CARTESIA, ELEVENLABS,
28
28
  .TP
29
29
  \fB\-\-tts.voice\-id\fR \fI<value>\fR
30
30
  The provider's id for the voice Required.
31
+ .TP
32
+ \fB\-\-tts.model\fR \fI<value>\fR
33
+ The provider's voice model, for example eleven_flash_v2_5. Its current one when omitted Optional.
34
+ .TP
35
+ \fB\-\-stt\fR \fI<value>\fR
36
+ Optional transcriber the hosted agent hears with. Roark's default when omitted Optional.
37
+ .TP
38
+ \fB\-\-stt.provider\fR \fI<value>\fR
39
+ Speech\-to\-text provider, for example DEEPGRAM One of: DEEPGRAM, OPENAI_WHISPER, SPEECHMATICS, ASSEMBLYAI, ELEVENLABS. Required.
40
+ .TP
41
+ \fB\-\-stt.model\fR \fI<value>\fR
42
+ The provider's model id, for example nova\-3 Required.
43
+ .TP
44
+ \fB\-\-llm\fR \fI<value>\fR
45
+ Optional text model the hosted agent thinks with. Roark's default when omitted Optional.
46
+ .TP
47
+ \fB\-\-llm.provider\fR \fI<value>\fR
48
+ Text model provider, for example OPENAI One of: OPENAI, ANTHROPIC, GOOGLE, XAI, ULTRAVOX, AWS, ELEVENLABS. Required.
49
+ .TP
50
+ \fB\-\-llm.model\fR \fI<value>\fR
51
+ The provider's model id, for example gpt\-4.1 Required.
31
52
  .SH "GLOBAL OPTIONS"
32
53
  .TP
33
54
  \fB\-\-data\fR \fI<json>\fR
@@ -69,7 +90,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
69
90
  .PP
70
91
  .RS 4
71
92
  .nf
72
- roark agent build \-\-name <value> \-\-job\-description <value> \-\-tts.provider <value> \-\-tts.voice\-id <value>
93
+ roark agent build \-\-name <value> \-\-job\-description <value> \-\-tts.provider <value> \-\-tts.voice\-id <value> \-\-stt.provider <value> \-\-stt.model <value> \-\-llm.provider <value> \-\-llm.model <value>
73
94
  .fi
74
95
  .RE
75
96
  .SH "ENVIRONMENT"
@@ -8,7 +8,7 @@ roark\-agent\-draft\-update \- Edit the draft
8
8
  .SH "DESCRIPTION"
9
9
  Changes settings on the draft. Omitted settings stay as they are. Pass the revision you read as expectedRevision to fail with 409 if anyone edited the draft since, instead of applying on top of their edit.
10
10
  .SH "API"
11
- PATCH /v1/agent/{agentId}/draft
11
+ PUT /v1/agent/{agentId}/draft
12
12
  .SH "ARGUMENTS"
13
13
  .TP
14
14
  \fIagent\-id\fR
@@ -19,7 +19,7 @@ The agent\-id.
19
19
  The draft's revision when you read it. When sent, the edit is refused if the draft changed since; when omitted, it applies on top of the latest edit. Optional.
20
20
  .TP
21
21
  \fB\-\-settings\fR \fI<value>\fR
22
- The settings to change. Omitted settings stay as they are; null clears one to the runtime default. subAgents replaces every speaker and must include `main`. Required.
22
+ The settings to change. Omitted settings stay as they are; null clears one to the runtime default. subAgents replaces every speaker, model configs included, and must include `main`; in a model config, omitted fields use the runtime default. Required.
23
23
  .TP
24
24
  \fB\-\-settings.modalities\fR \fI<value>\fR
25
25
  One of: call, chat. Repeatable. Optional.
@@ -36,42 +36,6 @@ Optional.
36
36
  \fB\-\-settings.first\-message\-audio\-url\fR \fI<value>\fR
37
37
  Optional.
38
38
  .TP
39
- \fB\-\-settings.llm\-provider\fR \fI<value>\fR
40
- One of: OPENAI, ANTHROPIC, GOOGLE, XAI, ULTRAVOX, AWS, ELEVENLABS. Optional.
41
- .TP
42
- \fB\-\-settings.llm\-model\fR \fI<value>\fR
43
- Optional.
44
- .TP
45
- \fB\-\-settings.llm\-temperature\fR \fI<value>\fR
46
- Optional.
47
- .TP
48
- \fB\-\-settings.llm\-max\-tokens\fR \fI<value>\fR
49
- Optional.
50
- .TP
51
- \fB\-\-settings.llm\-backend\-model\fR \fI<value>\fR
52
- Optional.
53
- .TP
54
- \fB\-\-settings.llm\-voice\fR \fI<value>\fR
55
- Optional.
56
- .TP
57
- \fB\-\-settings.stt\-provider\fR \fI<value>\fR
58
- One of: DEEPGRAM, OPENAI_WHISPER, SPEECHMATICS, ASSEMBLYAI, ELEVENLABS. Optional.
59
- .TP
60
- \fB\-\-settings.stt\-model\fR \fI<value>\fR
61
- Optional.
62
- .TP
63
- \fB\-\-settings.stt\-keyterms\fR \fI<value>\fR
64
- Repeatable. Optional.
65
- .TP
66
- \fB\-\-settings.stt\-smart\-format\fR
67
- Optional.
68
- .TP
69
- \fB\-\-settings.stt\-endpointing\-ms\fR \fI<value>\fR
70
- Optional.
71
- .TP
72
- \fB\-\-settings.stt\-turn\-detection\fR \fI<value>\fR
73
- One of: pipeline, provider. Optional.
74
- .TP
75
39
  \fB\-\-settings.interruption\-mode\fR \fI<value>\fR
76
40
  One of: ALLOW, BLOCK. Optional.
77
41
  .TP
@@ -1,14 +1,14 @@
1
1
  .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
- .TH "ROARK\-AGENT\-VERSION\-RESTORE" "1" "" "roark-agent-version-restore" "Roark Analytics API Manual"
2
+ .TH "ROARK\-AGENT\-VERSION\-ROLLBACK" "1" "" "roark-agent-version-rollback" "Roark Analytics API Manual"
3
3
  .SH "NAME"
4
- roark\-agent\-version\-restore \- Restore an agent version
4
+ roark\-agent\-version\-rollback \- Roll an agent back to a version
5
5
  .SH "SYNOPSIS"
6
- .B roark agent version restore
6
+ .B roark agent version rollback
7
7
  \fIagent\-id\fR \fIversion\-id\fR [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Roll back: publishes a new version, numbered after the latest, with this version's settings and makes it live. History stays append\-only. An open draft started before this is kept but can no longer be published (409 `agent_draft_base_changed`); discard it or start a new one. Pass `expectedLiveVersionId` to be refused (409 `agent_live_version_changed`) if another version went live since you read it.
9
+ Publishes a new version, numbered after the latest, with this version's settings and makes it live. History stays append\-only. An open draft started before this is kept but can no longer be published (409 `agent_draft_base_changed`); discard it or start a new one. Pass `expectedLiveVersionId` to be refused (409 `agent_live_version_changed`) if another version went live since you read it.
10
10
  .SH "API"
11
- POST /v1/agent/{agentId}/versions/{versionId}/restore
11
+ POST /v1/agent/{agentId}/versions/{versionId}/rollback
12
12
  .SH "ARGUMENTS"
13
13
  .TP
14
14
  \fIagent\-id\fR
@@ -22,7 +22,7 @@ The version\-id.
22
22
  Optional.
23
23
  .TP
24
24
  \fB\-\-expected\-live\-version\-id\fR \fI<value>\fR
25
- The live version when you decided to restore. When sent, the restore is refused with 409 if another version went live since. Optional.
25
+ The live version when you decided to roll back. When sent, the rollback is refused with 409 if another version went live since. Optional.
26
26
  .SH "GLOBAL OPTIONS"
27
27
  .TP
28
28
  \fB\-\-data\fR \fI<json>\fR
@@ -64,7 +64,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
64
64
  .PP
65
65
  .RS 4
66
66
  .nf
67
- roark agent version restore <agent\-id> <version\-id>
67
+ roark agent version rollback <agent\-id> <version\-id>
68
68
  .fi
69
69
  .RE
70
70
  .SH "ENVIRONMENT"
@@ -6,7 +6,7 @@ roark\-call\-list \- List calls
6
6
  .B roark call list
7
7
  [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Returns a paginated list of calls for the authenticated project.
9
+ Returns a paginated list of calls for the authenticated project. Pass agentId to keep calls for specific agents, or properties[agent_name][eq] when you only have the agent name. sortBy and sortDirection apply together with those filters.
10
10
  .SH "API"
11
11
  GET /v1/call
12
12
  .SH "OPTIONS"
@@ -29,6 +29,9 @@ Filter by call status One of: RINGING, IN_PROGRESS, ENDED. Optional.
29
29
  \fB\-\-search\-text\fR \fI<value>\fR
30
30
  Search text to filter calls by title, summary, or transcript Optional.
31
31
  .TP
32
+ \fB\-\-agent\-id\fR \fI<value>\fR
33
+ Calls that include any of these agents. One id, or several separated by commas, at most 100. A call with more than one agent matches when any of them is listed. An id that is not an agent on a call in this project matches nothing. Combines with the other filters, including sortBy and sortDirection. Optional.
34
+ .TP
32
35
  \fB\-\-simulation\-run\-plan\-job\-id\fR \fI<value>\fR
33
36
  Filter by simulation run plan job ID to get all calls from a specific simulation batch Optional.
34
37
  .TP
@@ -45,7 +48,7 @@ true: only simulated calls their run's results count (not invalidated, for examp
45
48
  true: leave out calls from runs hidden from the runs list. Live calls stay in. false is the same as leaving it out. One of: true, false. Optional.
46
49
  .TP
47
50
  \fB\-\-properties\fR \fI<value>\fR
48
- Filter on custom properties, one entry per property name: properties[<name>][exists]=true keeps calls that have the property set (whatever the value), properties[<name>][exists]=false keeps calls missing it (never sent, sent as null, or removed). A property the project has never seen is missing on every call. Names match the way properties are stored, so planTier and plan_tier are one property. At most 20 properties; a name taken by a built\-in call filter, such as status, is rejected with 400. Optional.
51
+ Filter on properties, one entry per property name. properties[<name>][exists]=true keeps calls that have the property set (whatever the value), properties[<name>][exists]=false keeps calls missing it (never sent, sent as null, or removed). properties[<name>][eq]=<value> keeps calls whose value equals it, ignoring case. agent_name and agent_id are built in and read the agents linked to the call, not a stored snapshot: agent_name matches an agent name, agent_id matches an agent id (a UUID). A call with several agents matches when any of them does. A custom property the project has never stored matches no calls under eq. Names match the way properties are stored, so planTier and plan_tier are one property, and agentName is agent_name. At most 20 properties. A name taken by a built\-in call filter, such as status, is rejected with 400. One operator per property. Optional.
49
52
  .SH "GLOBAL OPTIONS"
50
53
  .TP
51
54
  \fB\-\-data\fR \fI<json>\fR
@@ -0,0 +1,135 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-LIVE\-REPORT\-CREATE" "1" "" "roark-live-report-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-create \- Create a live report
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report create
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Saves a report on the project's live calls. Simulations are never included. Targets are analytics measures held to a bar: a threshold metric is read as its pass rate (`value` is a percentage, 0\-100, held AT_LEAST by default); a numeric metric as its average (held AT_MOST by default). Every target is read for the period and the period before it, so the report says whether each was met and how it moved. Scheduled reports are written `deliveryHour` hours into the day after each period ends in `timezone` (a week runs Monday to Sunday), then emailed and posted per `notifications`. With `generateNow` (the default) the report for the latest closed period is written right away and not sent.
10
+ .SH "API"
11
+ POST /v1/live\-report
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-name\fR \fI<value>\fR
15
+ Required.
16
+ .TP
17
+ \fB\-\-description\fR \fI<value>\fR
18
+ Optional.
19
+ .TP
20
+ \fB\-\-agent\-id\fR \fI<value>\fR
21
+ Optional.
22
+ .TP
23
+ \fB\-\-filters\fR \fI<value>\fR
24
+ Optional.
25
+ .TP
26
+ \fB\-\-targets\fR \fI<value>\fR
27
+ Optional.
28
+ .TP
29
+ \fB\-\-dashboard\-id\fR \fI<value>\fR
30
+ Optional.
31
+ .TP
32
+ \fB\-\-cadence\fR \fI<value>\fR
33
+ One of: DAILY, WEEKLY, MONTHLY. Optional.
34
+ .TP
35
+ \fB\-\-timezone\fR \fI<value>\fR
36
+ Optional.
37
+ .TP
38
+ \fB\-\-delivery\-hour\fR \fI<value>\fR
39
+ Optional.
40
+ .TP
41
+ \fB\-\-status\fR \fI<value>\fR
42
+ One of: ACTIVE, PAUSED. Optional.
43
+ .TP
44
+ \fB\-\-notifications\fR \fI<value>\fR
45
+ Optional.
46
+ .TP
47
+ \fB\-\-notifications.email\fR \fI<value>\fR
48
+ Required.
49
+ .TP
50
+ \fB\-\-notifications.slack\fR \fI<value>\fR
51
+ Required.
52
+ .TP
53
+ \fB\-\-include\-transcript\-excerpts\fR
54
+ Optional.
55
+ .TP
56
+ \fB\-\-generate\-now\fR
57
+ Write the report for the latest closed period right away. Default true. Optional.
58
+ .SH "GLOBAL OPTIONS"
59
+ .TP
60
+ \fB\-\-data\fR \fI<json>\fR
61
+ Request body as JSON, or @file to read one (@\- for stdin).
62
+ .TP
63
+ \fB\-y\fR, \fB\-\-yes\fR
64
+ Skip confirmation prompts.
65
+ .TP
66
+ \fB\-\-no\-input\fR
67
+ Never prompt; fail instead.
68
+ .TP
69
+ \fB\-\-base\-url\fR \fI<url>\fR
70
+ API base URL.
71
+ .TP
72
+ \fB\-\-token\fR \fI<token>\fR
73
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
74
+ .TP
75
+ \fB\-\-timeout\fR \fI<ms>\fR
76
+ Request timeout in milliseconds.
77
+ .TP
78
+ \fB\-\-max\-retries\fR \fI<count>\fR
79
+ Retries for retryable failures.
80
+ .TP
81
+ \fB\-\-format\fR \fI<format>\fR
82
+ Output format: auto, json, jsonl, plain.
83
+ .TP
84
+ \fB\-\-json\fR
85
+ Shorthand for \-\-format json.
86
+ .TP
87
+ \fB\-\-no\-color\fR
88
+ Disable colour.
89
+ .TP
90
+ \fB\-q\fR, \fB\-\-quiet\fR
91
+ Suppress non\-essential output.
92
+ .TP
93
+ \fB\-\-allow\-project\-base\-url\fR
94
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
95
+ .SH "EXAMPLES"
96
+ .PP
97
+ .RS 4
98
+ .nf
99
+ roark live\-report create \-\-name <value> \-\-notifications.email <value> \-\-notifications.slack <value>
100
+ .fi
101
+ .RE
102
+ .SH "ENVIRONMENT"
103
+ .TP
104
+ \fBROARK_API_BEARER_TOKEN\fR
105
+ Bearer token used when \-\-token is not given.
106
+ .TP
107
+ \fBROARK_BASE_URL\fR
108
+ API base URL.
109
+ .TP
110
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
111
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
112
+ .TP
113
+ \fBNO_COLOR\fR
114
+ Disables colour when set to any value.
115
+ .SH "EXIT STATUS"
116
+ .TP
117
+ \fB0\fR
118
+ The command succeeded.
119
+ .TP
120
+ \fB1\fR
121
+ The API rejected the request.
122
+ .TP
123
+ \fB2\fR
124
+ The command line was wrong.
125
+ .TP
126
+ \fB3\fR
127
+ No credential, or the credential was refused.
128
+ .TP
129
+ \fB4\fR
130
+ The addressed resource does not exist.
131
+ .TP
132
+ \fB5\fR
133
+ The request never completed: connection, timeout, or abort.
134
+ .SH "SEE ALSO"
135
+ .BR roark (1)
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-LIVE\-REPORT\-DELETE" "1" "" "roark-live-report-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-delete \- Delete a live report
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report delete
7
+ \fIreport\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Deletes the report and stops its scheduled reports.
10
+ .SH "API"
11
+ DELETE /v1/live\-report/{reportId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIreport\-id\fR
15
+ The live report 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 live\-report delete <report\-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\-LIVE\-REPORT\-DOCUMENT\-GET" "1" "" "roark-live-report-document-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-document\-get \- Get a report document
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report document get
7
+ \fIreport\-id\fR \fIdocument\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns one written report. `document` is null until `status` is READY. Theme excerpts and grader quotes (call transcript text) are included only for keys with transcript:read.
10
+ .SH "API"
11
+ GET /v1/live\-report/{reportId}/document/{documentId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIreport\-id\fR
15
+ The live report ID
16
+ .TP
17
+ \fIdocument\-id\fR
18
+ The report document ID
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 live\-report document get <report\-id> <document\-id>
61
+ .fi
62
+ .RE
63
+ .SH "ENVIRONMENT"
64
+ .TP
65
+ \fBROARK_API_BEARER_TOKEN\fR
66
+ Bearer token used when \-\-token is not given.
67
+ .TP
68
+ \fBROARK_BASE_URL\fR
69
+ API base URL.
70
+ .TP
71
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
72
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
73
+ .TP
74
+ \fBNO_COLOR\fR
75
+ Disables colour when set to any value.
76
+ .SH "EXIT STATUS"
77
+ .TP
78
+ \fB0\fR
79
+ The command succeeded.
80
+ .TP
81
+ \fB1\fR
82
+ The API rejected the request.
83
+ .TP
84
+ \fB2\fR
85
+ The command line was wrong.
86
+ .TP
87
+ \fB3\fR
88
+ No credential, or the credential was refused.
89
+ .TP
90
+ \fB4\fR
91
+ The addressed resource does not exist.
92
+ .TP
93
+ \fB5\fR
94
+ The request never completed: connection, timeout, or abort.
95
+ .SH "SEE ALSO"
96
+ .BR roark (1)
@@ -0,0 +1,100 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-LIVE\-REPORT\-DOCUMENT\-LIST" "1" "" "roark-live-report-document-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-document\-list \- List report documents
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report document list
7
+ \fIreport\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Lists a report's documents, newest period first.
10
+ .SH "API"
11
+ GET /v1/live\-report/{reportId}/document
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIreport\-id\fR
15
+ The report\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-limit\fR \fI<value>\fR
19
+ Page size, at most 100. Optional.
20
+ .TP
21
+ \fB\-\-offset\fR \fI<value>\fR
22
+ 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 live\-report document list <report\-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\-LIVE\-REPORT\-GET" "1" "" "roark-live-report-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-get \- Get a live report
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report get
7
+ \fIreport\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Get a live report
10
+ .SH "API"
11
+ GET /v1/live\-report/{reportId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIreport\-id\fR
15
+ The live report 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 live\-report get <report\-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)