@roarkanalytics/cli 0.60.0 → 0.67.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.
@@ -0,0 +1,100 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-LIVE\-REPORT\-RUN" "1" "" "roark-live-report-run" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-run \- Generate a live report document
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report run
7
+ \fIreport\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Writes the report now, for its latest closed period or a custom window (`periodStart` + `periodEnd`, at most 92 days, ended). Returns 202 with the document in PENDING; poll GET /v1/live\-report/{reportId}/document/{documentId} until `status` is READY or FAILED (typically a few minutes). An identical request already in flight is returned as\-is. A generated document is not emailed.
10
+ .SH "API"
11
+ POST /v1/live\-report/{reportId}/generate
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIreport\-id\fR
15
+ The live report ID
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-period\-start\fR \fI<value>\fR
19
+ ISO 8601 start of a custom window. Omit both for the latest closed period. Optional.
20
+ .TP
21
+ \fB\-\-period\-end\fR \fI<value>\fR
22
+ ISO 8601 end (exclusive) of a custom window. Requires periodStart. 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 run <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,136 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-LIVE\-REPORT\-UPDATE" "1" "" "roark-live-report-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-live\-report\-update \- Update a live report
5
+ .SH "SYNOPSIS"
6
+ .B roark live\-report update
7
+ \fIreport\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Changes the fields sent. Set `status` to PAUSED to stop scheduled reports.
10
+ .SH "API"
11
+ PATCH /v1/live\-report/{reportId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIreport\-id\fR
15
+ The live report ID
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-name\fR \fI<value>\fR
19
+ Optional.
20
+ .TP
21
+ \fB\-\-description\fR \fI<value>\fR
22
+ Optional.
23
+ .TP
24
+ \fB\-\-agent\-id\fR \fI<value>\fR
25
+ Optional.
26
+ .TP
27
+ \fB\-\-filters\fR \fI<value>\fR
28
+ Optional.
29
+ .TP
30
+ \fB\-\-targets\fR \fI<value>\fR
31
+ Optional.
32
+ .TP
33
+ \fB\-\-dashboard\-id\fR \fI<value>\fR
34
+ Optional.
35
+ .TP
36
+ \fB\-\-cadence\fR \fI<value>\fR
37
+ One of: DAILY, WEEKLY, MONTHLY. Optional.
38
+ .TP
39
+ \fB\-\-timezone\fR \fI<value>\fR
40
+ Optional.
41
+ .TP
42
+ \fB\-\-delivery\-hour\fR \fI<value>\fR
43
+ Optional.
44
+ .TP
45
+ \fB\-\-status\fR \fI<value>\fR
46
+ One of: ACTIVE, PAUSED. Optional.
47
+ .TP
48
+ \fB\-\-notifications\fR \fI<value>\fR
49
+ Optional.
50
+ .TP
51
+ \fB\-\-notifications.email\fR \fI<value>\fR
52
+ Required.
53
+ .TP
54
+ \fB\-\-notifications.slack\fR \fI<value>\fR
55
+ Required.
56
+ .TP
57
+ \fB\-\-include\-transcript\-excerpts\fR
58
+ Optional.
59
+ .SH "GLOBAL OPTIONS"
60
+ .TP
61
+ \fB\-\-data\fR \fI<json>\fR
62
+ Request body as JSON, or @file to read one (@\- for stdin).
63
+ .TP
64
+ \fB\-y\fR, \fB\-\-yes\fR
65
+ Skip confirmation prompts.
66
+ .TP
67
+ \fB\-\-no\-input\fR
68
+ Never prompt; fail instead.
69
+ .TP
70
+ \fB\-\-base\-url\fR \fI<url>\fR
71
+ API base URL.
72
+ .TP
73
+ \fB\-\-token\fR \fI<token>\fR
74
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
75
+ .TP
76
+ \fB\-\-timeout\fR \fI<ms>\fR
77
+ Request timeout in milliseconds.
78
+ .TP
79
+ \fB\-\-max\-retries\fR \fI<count>\fR
80
+ Retries for retryable failures.
81
+ .TP
82
+ \fB\-\-format\fR \fI<format>\fR
83
+ Output format: auto, json, jsonl, plain.
84
+ .TP
85
+ \fB\-\-json\fR
86
+ Shorthand for \-\-format json.
87
+ .TP
88
+ \fB\-\-no\-color\fR
89
+ Disable colour.
90
+ .TP
91
+ \fB\-q\fR, \fB\-\-quiet\fR
92
+ Suppress non\-essential output.
93
+ .TP
94
+ \fB\-\-allow\-project\-base\-url\fR
95
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
96
+ .SH "EXAMPLES"
97
+ .PP
98
+ .RS 4
99
+ .nf
100
+ roark live\-report update <report\-id> \-\-notifications.email <value> \-\-notifications.slack <value>
101
+ .fi
102
+ .RE
103
+ .SH "ENVIRONMENT"
104
+ .TP
105
+ \fBROARK_API_BEARER_TOKEN\fR
106
+ Bearer token used when \-\-token is not given.
107
+ .TP
108
+ \fBROARK_BASE_URL\fR
109
+ API base URL.
110
+ .TP
111
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
112
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
113
+ .TP
114
+ \fBNO_COLOR\fR
115
+ Disables colour when set to any value.
116
+ .SH "EXIT STATUS"
117
+ .TP
118
+ \fB0\fR
119
+ The command succeeded.
120
+ .TP
121
+ \fB1\fR
122
+ The API rejected the request.
123
+ .TP
124
+ \fB2\fR
125
+ The command line was wrong.
126
+ .TP
127
+ \fB3\fR
128
+ No credential, or the credential was refused.
129
+ .TP
130
+ \fB4\fR
131
+ The addressed resource does not exist.
132
+ .TP
133
+ \fB5\fR
134
+ The request never completed: connection, timeout, or abort.
135
+ .SH "SEE ALSO"
136
+ .BR roark (1)
@@ -36,6 +36,9 @@ New label for the true case (BOOLEAN output only) Optional.
36
36
  \fB\-\-boolean\-false\-label\fR \fI<value>\fR
37
37
  New label for the false case (BOOLEAN output only) Optional.
38
38
  .TP
39
+ \fB\-\-grades\-short\-calls\fR
40
+ Score this metric on a simulated call with fewer than 4 transcript lines. Such calls skip every other metric. Default false. Optional.
41
+ .TP
39
42
  \fB\-\-classification\-options\fR \fI<value>\fR
40
43
  Replacement set of classification options (CLASSIFICATION output only) Optional.
41
44
  .TP
@@ -36,6 +36,9 @@ What a `true` value means. Given to the judge as its polarity rule, so keep it a
36
36
  \fB\-\-boolean\-false\-label\fR \fI<value>\fR
37
37
  What a `false` value means. Given to the judge as its polarity rule, so keep it accurate. Optional.
38
38
  .TP
39
+ \fB\-\-grades\-short\-calls\fR
40
+ Score this metric on a simulated call with fewer than 4 transcript lines. Such calls skip every other metric. Default false. Optional.
41
+ .TP
39
42
  \fB\-\-max\-classifications\fR \fI<value>\fR
40
43
  Maximum classifications returned. CLASSIFICATION output only. Optional.
41
44
  .TP
@@ -0,0 +1,123 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-TOOL\-CREATE" "1" "" "roark-tool-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-tool\-create \- Create a tool
5
+ .SH "SYNOPSIS"
6
+ .B roark tool create
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Creates a tool and declares its first version. A tool only recorded from calls under the same name is adopted; one already declared returns 409. Give it a `runtime` for a hosted agent to call your endpoint. Header values are returned on read, so keep secrets out of them.
10
+ .SH "API"
11
+ POST /v1/tool
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-name\fR \fI<value>\fR
15
+ Required.
16
+ .TP
17
+ \fB\-\-description\fR \fI<value>\fR
18
+ When the agent should use the tool Required.
19
+ .TP
20
+ \fB\-\-agent\-id\fR \fI<value>\fR
21
+ Optional.
22
+ .TP
23
+ \fB\-\-inputs\fR \fI<value>\fR
24
+ Optional.
25
+ .TP
26
+ \fB\-\-invocation\-criteria\fR \fI<value>\fR
27
+ Optional.
28
+ .TP
29
+ \fB\-\-expected\-result\fR \fI<value>\fR
30
+ Optional.
31
+ .TP
32
+ \fB\-\-runtime\fR \fI<value>\fR
33
+ Omit or null for a tool that is only graded Optional.
34
+ .TP
35
+ \fB\-\-runtime.request\fR \fI<value>\fR
36
+ Required.
37
+ .TP
38
+ \fB\-\-runtime.changes\-data\fR
39
+ Optional.
40
+ .TP
41
+ \fB\-\-runtime.response\-fields\fR \fI<value>\fR
42
+ Repeatable. Optional.
43
+ .TP
44
+ \fB\-\-runtime.messages\fR \fI<value>\fR
45
+ Optional.
46
+ .SH "GLOBAL OPTIONS"
47
+ .TP
48
+ \fB\-\-data\fR \fI<json>\fR
49
+ Request body as JSON, or @file to read one (@\- for stdin).
50
+ .TP
51
+ \fB\-y\fR, \fB\-\-yes\fR
52
+ Skip confirmation prompts.
53
+ .TP
54
+ \fB\-\-no\-input\fR
55
+ Never prompt; fail instead.
56
+ .TP
57
+ \fB\-\-base\-url\fR \fI<url>\fR
58
+ API base URL.
59
+ .TP
60
+ \fB\-\-token\fR \fI<token>\fR
61
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
62
+ .TP
63
+ \fB\-\-timeout\fR \fI<ms>\fR
64
+ Request timeout in milliseconds.
65
+ .TP
66
+ \fB\-\-max\-retries\fR \fI<count>\fR
67
+ Retries for retryable failures.
68
+ .TP
69
+ \fB\-\-format\fR \fI<format>\fR
70
+ Output format: auto, json, jsonl, plain.
71
+ .TP
72
+ \fB\-\-json\fR
73
+ Shorthand for \-\-format json.
74
+ .TP
75
+ \fB\-\-no\-color\fR
76
+ Disable colour.
77
+ .TP
78
+ \fB\-q\fR, \fB\-\-quiet\fR
79
+ Suppress non\-essential output.
80
+ .TP
81
+ \fB\-\-allow\-project\-base\-url\fR
82
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
83
+ .SH "EXAMPLES"
84
+ .PP
85
+ .RS 4
86
+ .nf
87
+ roark tool create \-\-name <value> \-\-description <value> \-\-runtime.request <value>
88
+ .fi
89
+ .RE
90
+ .SH "ENVIRONMENT"
91
+ .TP
92
+ \fBROARK_API_BEARER_TOKEN\fR
93
+ Bearer token used when \-\-token is not given.
94
+ .TP
95
+ \fBROARK_BASE_URL\fR
96
+ API base URL.
97
+ .TP
98
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
99
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
100
+ .TP
101
+ \fBNO_COLOR\fR
102
+ Disables colour when set to any value.
103
+ .SH "EXIT STATUS"
104
+ .TP
105
+ \fB0\fR
106
+ The command succeeded.
107
+ .TP
108
+ \fB1\fR
109
+ The API rejected the request.
110
+ .TP
111
+ \fB2\fR
112
+ The command line was wrong.
113
+ .TP
114
+ \fB3\fR
115
+ No credential, or the credential was refused.
116
+ .TP
117
+ \fB4\fR
118
+ The addressed resource does not exist.
119
+ .TP
120
+ \fB5\fR
121
+ The request never completed: connection, timeout, or abort.
122
+ .SH "SEE ALSO"
123
+ .BR roark (1)
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-TOOL\-DELETE" "1" "" "roark-tool-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-tool\-delete \- Delete a tool
5
+ .SH "SYNOPSIS"
6
+ .B roark tool delete
7
+ \fItool\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Deletes a tool no agent version uses. A tool an agent version uses returns 409.
10
+ .SH "API"
11
+ DELETE /v1/tool/{toolId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fItool\-id\fR
15
+ The tool\-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 tool delete <tool\-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\-TOOL\-GET" "1" "" "roark-tool-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-tool\-get \- Get a tool
5
+ .SH "SYNOPSIS"
6
+ .B roark tool get
7
+ \fItool\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Get a tool
10
+ .SH "API"
11
+ GET /v1/tool/{toolId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fItool\-id\fR
15
+ The tool\-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 tool get <tool\-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\-TOOL\-LIST" "1" "" "roark-tool-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-tool\-list \- List tools
5
+ .SH "SYNOPSIS"
6
+ .B roark tool list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ The project's tools and the built\-in ones, each with its latest version: inputs, description and, for a tool a hosted agent runs, its request. Attach one to an agent draft by id.
10
+ .SH "API"
11
+ GET /v1/tool
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-agent\-id\fR \fI<value>\fR
15
+ Only tools scoped to this agent Optional.
16
+ .TP
17
+ \fB\-\-include\-built\-in\fR \fI<value>\fR
18
+ Include the built\-in tools (default true) One of: true, false. 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 tool list
61
+ .fi
62
+ .RE
63
+ .SH "ENVIRONMENT"
64
+ .TP
65
+ \fBROARK_API_BEARER_TOKEN\fR
66
+ Bearer token used when \-\-token is not given.
67
+ .TP
68
+ \fBROARK_BASE_URL\fR
69
+ API base URL.
70
+ .TP
71
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
72
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
73
+ .TP
74
+ \fBNO_COLOR\fR
75
+ Disables colour when set to any value.
76
+ .SH "EXIT STATUS"
77
+ .TP
78
+ \fB0\fR
79
+ The command succeeded.
80
+ .TP
81
+ \fB1\fR
82
+ The API rejected the request.
83
+ .TP
84
+ \fB2\fR
85
+ The command line was wrong.
86
+ .TP
87
+ \fB3\fR
88
+ No credential, or the credential was refused.
89
+ .TP
90
+ \fB4\fR
91
+ The addressed resource does not exist.
92
+ .TP
93
+ \fB5\fR
94
+ The request never completed: connection, timeout, or abort.
95
+ .SH "SEE ALSO"
96
+ .BR roark (1)