@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,97 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-PLAN\-JOB\-RESULT\-GET" "1" "" "roark-simulation-plan-job-result-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-plan\-job\-result\-get \- Get simulation run results
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation plan job result get
7
+ \fIjob\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Everything the run report shows, in one request: the summary and score, the pass/fail verdict, per\-metric aggregates, every simulation with its check results, breakdowns by agent and persona, the comparison against the previous run (or `compareToJobId`), the sweep attribution, and the written debrief with its executive summary, failure themes and recommendations. Safe to call while the run is in progress: counts reflect what has landed so far. `verdict` and `sweepAttribution` stay null until the run ends. The debrief is generated automatically a few minutes after a run with graded calls settles; poll until `debrief.status` is READY, or request one with POST /v1/simulation/plan/job/{jobId}/debrief.
10
+ .SH "API"
11
+ GET /v1/simulation/plan/job/{jobId}/results
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIjob\-id\fR
15
+ The job\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-compare\-to\-job\-id\fR \fI<value>\fR
19
+ Simulation run plan job to compare this run against, e.g. the last run on your main branch. Defaults to the plan's previous settled run. Any run in the project works, including another plan's: checks are matched by metric, and a check only one run graded reads null on the other side. 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 result get <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)
@@ -0,0 +1,99 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-RUN\-GROUP\-CREATE" "1" "" "roark-simulation-run-group-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-run\-group\-create \- Create a run group
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation run\-group create
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Groups several simulation runs so they read as one, and starts generating the group report: one document across every run, with a scorecard summed across them and the issues found, each merged from the per\-run debriefs. Send `simulationRunPlanJobIds` to group runs that already exist (runs still in progress are fine: the report waits for them). Send `simulationRunPlanIds` to start one run of each plan and group those; this places real calls, exactly as starting each plan would. Poll GET /v1/simulation/run\-group/{groupId} until `latestReport.status` is READY.
10
+ .SH "API"
11
+ POST /v1/simulation/run\-group
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-name\fR \fI<value>\fR
15
+ What to call the group. Defaults to the plans' names when starting plans, and to the runs' plan names when grouping existing runs. Optional.
16
+ .TP
17
+ \fB\-\-simulation\-run\-plan\-job\-ids\fR \fI<value>\fR
18
+ Runs that already exist, in display order (2 to 20). Runs still in progress are fine: the group report waits for them. Send this or `simulationRunPlanIds`, not both. Repeatable. Optional.
19
+ .TP
20
+ \fB\-\-simulation\-run\-plan\-ids\fR \fI<value>\fR
21
+ Plans to run once each, in display order (2 to 20). Each plan starts a run, exactly as POST /v1/simulation/plan/{planId}/job would. Send this or `simulationRunPlanJobIds`, not both. Repeatable. Optional.
22
+ .SH "GLOBAL OPTIONS"
23
+ .TP
24
+ \fB\-\-data\fR \fI<json>\fR
25
+ Request body as JSON, or @file to read one (@\- for stdin).
26
+ .TP
27
+ \fB\-y\fR, \fB\-\-yes\fR
28
+ Skip confirmation prompts.
29
+ .TP
30
+ \fB\-\-no\-input\fR
31
+ Never prompt; fail instead.
32
+ .TP
33
+ \fB\-\-base\-url\fR \fI<url>\fR
34
+ API base URL.
35
+ .TP
36
+ \fB\-\-token\fR \fI<token>\fR
37
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
38
+ .TP
39
+ \fB\-\-timeout\fR \fI<ms>\fR
40
+ Request timeout in milliseconds.
41
+ .TP
42
+ \fB\-\-max\-retries\fR \fI<count>\fR
43
+ Retries for retryable failures.
44
+ .TP
45
+ \fB\-\-format\fR \fI<format>\fR
46
+ Output format: auto, json, jsonl, plain.
47
+ .TP
48
+ \fB\-\-json\fR
49
+ Shorthand for \-\-format json.
50
+ .TP
51
+ \fB\-\-no\-color\fR
52
+ Disable colour.
53
+ .TP
54
+ \fB\-q\fR, \fB\-\-quiet\fR
55
+ Suppress non\-essential output.
56
+ .TP
57
+ \fB\-\-allow\-project\-base\-url\fR
58
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
59
+ .SH "EXAMPLES"
60
+ .PP
61
+ .RS 4
62
+ .nf
63
+ roark simulation run\-group create
64
+ .fi
65
+ .RE
66
+ .SH "ENVIRONMENT"
67
+ .TP
68
+ \fBROARK_API_BEARER_TOKEN\fR
69
+ Bearer token used when \-\-token is not given.
70
+ .TP
71
+ \fBROARK_BASE_URL\fR
72
+ API base URL.
73
+ .TP
74
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
75
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
76
+ .TP
77
+ \fBNO_COLOR\fR
78
+ Disables colour when set to any value.
79
+ .SH "EXIT STATUS"
80
+ .TP
81
+ \fB0\fR
82
+ The command succeeded.
83
+ .TP
84
+ \fB1\fR
85
+ The API rejected the request.
86
+ .TP
87
+ \fB2\fR
88
+ The command line was wrong.
89
+ .TP
90
+ \fB3\fR
91
+ No credential, or the credential was refused.
92
+ .TP
93
+ \fB4\fR
94
+ The addressed resource does not exist.
95
+ .TP
96
+ \fB5\fR
97
+ The request never completed: connection, timeout, or abort.
98
+ .SH "SEE ALSO"
99
+ .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\-RUN\-GROUP\-DELETE" "1" "" "roark-simulation-run-group-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-run\-group\-delete \- Delete a run group
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation run\-group delete
7
+ \fIgroup\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Deletes a run group. Its runs, and their results, are untouched.
10
+ .SH "API"
11
+ DELETE /v1/simulation/run\-group/{groupId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIgroup\-id\fR
15
+ The run 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 run\-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\-RUN\-GROUP\-GET" "1" "" "roark-simulation-run-group-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-run\-group\-get \- Get a run group
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation run\-group get
7
+ \fIgroup\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns a run group with its runs in group order and its latest group report, including the report document once READY.
10
+ .SH "API"
11
+ GET /v1/simulation/run\-group/{groupId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIgroup\-id\fR
15
+ The run 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 run\-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\-RUN\-GROUP\-LIST" "1" "" "roark-simulation-run-group-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-run\-group\-list \- List run groups
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation run\-group list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Returns the run groups in the project, newest first, with their runs and where each group report stands. Read a report document from GET /v1/simulation/run\-group/{groupId}.
10
+ .SH "API"
11
+ GET /v1/simulation/run\-group
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-limit\fR \fI<value>\fR
15
+ Maximum number of run 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 run\-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\-RUN\-GROUP\-REPORT\-REGENERATE" "1" "" "roark-simulation-run-group-report-regenerate" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-run\-group\-report\-regenerate \- Regenerate a run group report
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation run\-group report regenerate
7
+ \fIgroup\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Generates the group report again over the latest state of its runs. Returns the report generation; if one is already in flight it is returned instead of starting another. Poll GET /v1/simulation/run\-group/{groupId} until `latestReport.status` is READY.
10
+ .SH "API"
11
+ POST /v1/simulation/run\-group/{groupId}/report
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIgroup\-id\fR
15
+ The run 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 run\-group report regenerate <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)
package/man/roark.1 CHANGED
@@ -309,6 +309,24 @@ List environments See roark\-simulation\-environment\-list(1).
309
309
  \fBroark simulation environment update\fR
310
310
  Update an environment See roark\-simulation\-environment\-update(1).
311
311
  .TP
312
+ \fBroark simulation group create\fR
313
+ Create a simulation group See roark\-simulation\-group\-create(1).
314
+ .TP
315
+ \fBroark simulation group delete\fR
316
+ Delete a simulation group See roark\-simulation\-group\-delete(1).
317
+ .TP
318
+ \fBroark simulation group get\fR
319
+ Get a simulation group See roark\-simulation\-group\-get(1).
320
+ .TP
321
+ \fBroark simulation group list\fR
322
+ List simulation groups See roark\-simulation\-group\-list(1).
323
+ .TP
324
+ \fBroark simulation group run\fR
325
+ Run a simulation group See roark\-simulation\-group\-run(1).
326
+ .TP
327
+ \fBroark simulation group update\fR
328
+ Update a simulation group See roark\-simulation\-group\-update(1).
329
+ .TP
312
330
  \fBroark simulation job get\fR
313
331
  Get simulation by ID See roark\-simulation\-job\-get(1).
314
332
  .TP
@@ -342,12 +360,18 @@ Get run plan by ID See roark\-simulation\-plan\-get(1).
342
360
  \fBroark simulation plan job cancel\fR
343
361
  Cancel a simulation plan job See roark\-simulation\-plan\-job\-cancel(1).
344
362
  .TP
363
+ \fBroark simulation plan job debrief create\fR
364
+ Generate simulation run debrief See roark\-simulation\-plan\-job\-debrief\-create(1).
365
+ .TP
345
366
  \fBroark simulation plan job get\fR
346
367
  Get simulation plan job See roark\-simulation\-plan\-job\-get(1).
347
368
  .TP
348
369
  \fBroark simulation plan job list\fR
349
370
  List simulation plan jobs See roark\-simulation\-plan\-job\-list(1).
350
371
  .TP
372
+ \fBroark simulation plan job result get\fR
373
+ Get simulation run results See roark\-simulation\-plan\-job\-result\-get(1).
374
+ .TP
351
375
  \fBroark simulation plan job start\fR
352
376
  Run a simulation plan See roark\-simulation\-plan\-job\-start(1).
353
377
  .TP
@@ -360,6 +384,21 @@ Update a run plan See roark\-simulation\-plan\-update(1).
360
384
  \fBroark simulation run\fR
361
385
  Run a simulation See roark\-simulation\-run(1).
362
386
  .TP
387
+ \fBroark simulation run\-group create\fR
388
+ Create a run group See roark\-simulation\-run\-group\-create(1).
389
+ .TP
390
+ \fBroark simulation run\-group delete\fR
391
+ Delete a run group See roark\-simulation\-run\-group\-delete(1).
392
+ .TP
393
+ \fBroark simulation run\-group get\fR
394
+ Get a run group See roark\-simulation\-run\-group\-get(1).
395
+ .TP
396
+ \fBroark simulation run\-group list\fR
397
+ List run groups See roark\-simulation\-run\-group\-list(1).
398
+ .TP
399
+ \fBroark simulation run\-group report regenerate\fR
400
+ Regenerate a run group report See roark\-simulation\-run\-group\-report\-regenerate(1).
401
+ .TP
363
402
  \fBroark simulation template list\fR
364
403
  List simulation templates See roark\-simulation\-template\-list(1).
365
404
  .TP
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.39.0",
3
+ "version": "0.42.1",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.39.0",
9
+ "version": "0.42.1",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
- "@roarkanalytics/sdk": "^4.23.0",
12
+ "@roarkanalytics/sdk": "^5.4.0",
13
13
  "commander": "^14.0.3",
14
14
  "yaml": "^2.9.0"
15
15
  },
@@ -21,9 +21,9 @@
21
21
  }
22
22
  },
23
23
  "node_modules/@roarkanalytics/sdk": {
24
- "version": "4.23.0",
25
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.23.0.tgz",
26
- "integrity": "sha512-2UFFMYoUvIp44e1NG8Jk8DiJIa06gqMwygp1nMn3fhegQqSRUE9tsLkQC74SdfDSKtvvpykWX1bsrHf3DGlo6Q==",
24
+ "version": "5.4.0",
25
+ "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.4.0.tgz",
26
+ "integrity": "sha512-RUjr6qV7HMsIdO11cp/+qcXRGCdzuTIs4bE4Vz0EDm2aqM/pAtUl5ussad64c6yp+bDGLb2ecJQZDeVRuUEZbQ==",
27
27
  "license": "Apache-2.0"
28
28
  },
29
29
  "node_modules/commander": {