@roarkanalytics/cli 0.39.0 → 0.42.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,108 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-GROUP\-CREATE" "1" "" "roark-simulation-group-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-group\-create \- Create a simulation group
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation group create
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Saves a named set of plans to run together, again and again. Nothing runs yet: POST /v1/simulation/group/{groupId}/run starts one run of every plan and groups them into a run group with one combined report. Slack channels need Slack connected to the project. Email is on by default.
10
+ .SH "API"
11
+ POST /v1/simulation/group
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-name\fR \fI<value>\fR
15
+ What to call the group. Required.
16
+ .TP
17
+ \fB\-\-description\fR \fI<value>\fR
18
+ What the group is for. Optional.
19
+ .TP
20
+ \fB\-\-simulation\-run\-plan\-ids\fR \fI<value>\fR
21
+ The plans to run together, in run order (2 to 20). Duplicates are dropped. Repeatable. Required.
22
+ .TP
23
+ \fB\-\-notifications\fR \fI<value>\fR
24
+ Where each run's group report announces itself once it is ready. Optional.
25
+ .TP
26
+ \fB\-\-notifications.email\fR \fI<value>\fR
27
+ Optional.
28
+ .TP
29
+ \fB\-\-notifications.slack\fR \fI<value>\fR
30
+ Channels in the project's connected Slack workspace to post the report to (at most 10). Slack must be connected to the project first. Optional.
31
+ .SH "GLOBAL OPTIONS"
32
+ .TP
33
+ \fB\-\-data\fR \fI<json>\fR
34
+ Request body as JSON, or @file to read one (@\- for stdin).
35
+ .TP
36
+ \fB\-y\fR, \fB\-\-yes\fR
37
+ Skip confirmation prompts.
38
+ .TP
39
+ \fB\-\-no\-input\fR
40
+ Never prompt; fail instead.
41
+ .TP
42
+ \fB\-\-base\-url\fR \fI<url>\fR
43
+ API base URL.
44
+ .TP
45
+ \fB\-\-token\fR \fI<token>\fR
46
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
47
+ .TP
48
+ \fB\-\-timeout\fR \fI<ms>\fR
49
+ Request timeout in milliseconds.
50
+ .TP
51
+ \fB\-\-max\-retries\fR \fI<count>\fR
52
+ Retries for retryable failures.
53
+ .TP
54
+ \fB\-\-format\fR \fI<format>\fR
55
+ Output format: auto, json, jsonl, plain.
56
+ .TP
57
+ \fB\-\-json\fR
58
+ Shorthand for \-\-format json.
59
+ .TP
60
+ \fB\-\-no\-color\fR
61
+ Disable colour.
62
+ .TP
63
+ \fB\-q\fR, \fB\-\-quiet\fR
64
+ Suppress non\-essential output.
65
+ .TP
66
+ \fB\-\-allow\-project\-base\-url\fR
67
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
68
+ .SH "EXAMPLES"
69
+ .PP
70
+ .RS 4
71
+ .nf
72
+ roark simulation group create \-\-name <value> \-\-simulation\-run\-plan\-ids <value>
73
+ .fi
74
+ .RE
75
+ .SH "ENVIRONMENT"
76
+ .TP
77
+ \fBROARK_API_BEARER_TOKEN\fR
78
+ Bearer token used when \-\-token is not given.
79
+ .TP
80
+ \fBROARK_BASE_URL\fR
81
+ API base URL.
82
+ .TP
83
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
84
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
85
+ .TP
86
+ \fBNO_COLOR\fR
87
+ Disables colour when set to any value.
88
+ .SH "EXIT STATUS"
89
+ .TP
90
+ \fB0\fR
91
+ The command succeeded.
92
+ .TP
93
+ \fB1\fR
94
+ The API rejected the request.
95
+ .TP
96
+ \fB2\fR
97
+ The command line was wrong.
98
+ .TP
99
+ \fB3\fR
100
+ No credential, or the credential was refused.
101
+ .TP
102
+ \fB4\fR
103
+ The addressed resource does not exist.
104
+ .TP
105
+ \fB5\fR
106
+ The request never completed: connection, timeout, or abort.
107
+ .SH "SEE ALSO"
108
+ .BR roark (1)
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-GROUP\-DELETE" "1" "" "roark-simulation-group-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-group\-delete \- Delete a simulation group
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation group delete
7
+ \fIgroup\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Deletes a saved simulation group and any schedules that run it. Run groups it already started, and their reports, stay. A group managed by config as code returns 409.
10
+ .SH "API"
11
+ DELETE /v1/simulation/group/{groupId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIgroup\-id\fR
15
+ The simulation group 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 simulation group delete <group\-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\-SIMULATION\-GROUP\-GET" "1" "" "roark-simulation-group-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-group\-get \- Get a simulation group
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation group get
7
+ \fIgroup\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns a saved simulation group with its plans in run order and notification settings.
10
+ .SH "API"
11
+ GET /v1/simulation/group/{groupId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIgroup\-id\fR
15
+ The simulation group 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 simulation group get <group\-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\-SIMULATION\-GROUP\-LIST" "1" "" "roark-simulation-group-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-group\-list \- List simulation groups
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation group list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns the saved simulation groups in the project, most recently edited first, each with its plans in run order and notification settings.
10
+ .SH "API"
11
+ GET /v1/simulation/group
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-limit\fR \fI<value>\fR
15
+ Maximum number of groups to return (default: 20, max: 100) Optional.
16
+ .TP
17
+ \fB\-\-offset\fR \fI<value>\fR
18
+ Pagination offset 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 simulation group 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)
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-GROUP\-RUN" "1" "" "roark-simulation-group-run" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-group\-run \- Run a simulation group
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation group run
7
+ \fIgroup\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Starts one run of every plan in the group, exactly as POST /v1/simulation/plan/{planId}/job would for each, and groups the runs into a run group whose combined report is announced through the group's notification settings once it is ready. This places real calls. Config\-managed groups can be run here too. Returns the run group. Poll GET /v1/simulation/run\-group/{groupId} until `latestReport.status` is READY. If a plan cannot start after others did, the runs that started are still grouped and the 400 names the run group id.
10
+ .SH "API"
11
+ POST /v1/simulation/group/{groupId}/run
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIgroup\-id\fR
15
+ The simulation group 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 simulation group run <group\-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,112 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-GROUP\-UPDATE" "1" "" "roark-simulation-group-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-group\-update \- Update a simulation group
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation group update
7
+ \fIgroup\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Edits a saved simulation group. Omitted fields keep their current value; `notifications`, when sent, replaces the settings as a whole. Run groups it already started keep theirs. A group managed by config as code (`configManaged: true`) returns 409: change it in the config file.
10
+ .SH "API"
11
+ PUT /v1/simulation/group/{groupId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIgroup\-id\fR
15
+ The simulation group 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
+ Send null to clear it. Optional.
23
+ .TP
24
+ \fB\-\-simulation\-run\-plan\-ids\fR \fI<value>\fR
25
+ Replaces the plans, in run order. Repeatable. Optional.
26
+ .TP
27
+ \fB\-\-notifications\fR \fI<value>\fR
28
+ Where each run's group report announces itself once it is ready. Optional.
29
+ .TP
30
+ \fB\-\-notifications.email\fR \fI<value>\fR
31
+ Optional.
32
+ .TP
33
+ \fB\-\-notifications.slack\fR \fI<value>\fR
34
+ Channels in the project's connected Slack workspace to post the report to (at most 10). Slack must be connected to the project first. Optional.
35
+ .SH "GLOBAL OPTIONS"
36
+ .TP
37
+ \fB\-\-data\fR \fI<json>\fR
38
+ Request body as JSON, or @file to read one (@\- for stdin).
39
+ .TP
40
+ \fB\-y\fR, \fB\-\-yes\fR
41
+ Skip confirmation prompts.
42
+ .TP
43
+ \fB\-\-no\-input\fR
44
+ Never prompt; fail instead.
45
+ .TP
46
+ \fB\-\-base\-url\fR \fI<url>\fR
47
+ API base URL.
48
+ .TP
49
+ \fB\-\-token\fR \fI<token>\fR
50
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
51
+ .TP
52
+ \fB\-\-timeout\fR \fI<ms>\fR
53
+ Request timeout in milliseconds.
54
+ .TP
55
+ \fB\-\-max\-retries\fR \fI<count>\fR
56
+ Retries for retryable failures.
57
+ .TP
58
+ \fB\-\-format\fR \fI<format>\fR
59
+ Output format: auto, json, jsonl, plain.
60
+ .TP
61
+ \fB\-\-json\fR
62
+ Shorthand for \-\-format json.
63
+ .TP
64
+ \fB\-\-no\-color\fR
65
+ Disable colour.
66
+ .TP
67
+ \fB\-q\fR, \fB\-\-quiet\fR
68
+ Suppress non\-essential output.
69
+ .TP
70
+ \fB\-\-allow\-project\-base\-url\fR
71
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
72
+ .SH "EXAMPLES"
73
+ .PP
74
+ .RS 4
75
+ .nf
76
+ roark simulation group update <group\-id>
77
+ .fi
78
+ .RE
79
+ .SH "ENVIRONMENT"
80
+ .TP
81
+ \fBROARK_API_BEARER_TOKEN\fR
82
+ Bearer token used when \-\-token is not given.
83
+ .TP
84
+ \fBROARK_BASE_URL\fR
85
+ API base URL.
86
+ .TP
87
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
88
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
89
+ .TP
90
+ \fBNO_COLOR\fR
91
+ Disables colour when set to any value.
92
+ .SH "EXIT STATUS"
93
+ .TP
94
+ \fB0\fR
95
+ The command succeeded.
96
+ .TP
97
+ \fB1\fR
98
+ The API rejected the request.
99
+ .TP
100
+ \fB2\fR
101
+ The command line was wrong.
102
+ .TP
103
+ \fB3\fR
104
+ No credential, or the credential was refused.
105
+ .TP
106
+ \fB4\fR
107
+ The addressed resource does not exist.
108
+ .TP
109
+ \fB5\fR
110
+ The request never completed: connection, timeout, or abort.
111
+ .SH "SEE ALSO"
112
+ .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\-PLAN\-JOB\-DEBRIEF\-CREATE" "1" "" "roark-simulation-plan-job-debrief-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-plan\-job\-debrief\-create \- Generate simulation run debrief
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation plan job debrief create
7
+ \fIjob\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Request the written debrief for a settled run: executive summary, failure themes and recommendations. Runs with graded calls get one automatically, so this is for regenerating one (`regenerate: true`) or retrying one that failed. Returns immediately. Generation takes a few minutes: poll GET /v1/simulation/plan/job/{jobId}/results until `debrief.status` is READY or FAILED. Without `regenerate`, a debrief that is ready or already being written is returned as\-is.
10
+ .SH "API"
11
+ POST /v1/simulation/plan/job/{jobId}/debrief
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIjob\-id\fR
15
+ The job\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-regenerate\fR
19
+ Generate a new debrief even when a ready one exists. Without it, an existing ready or in\-progress debrief is returned as\-is. 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 debrief create <job\-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)