@roarkanalytics/cli 0.41.1 → 0.43.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.
@@ -30,6 +30,9 @@ Optional.
30
30
  \fB\-\-preceded\-by\-customer\-flow\-variant\-id\fR \fI<value>\fR
31
31
  Optional.
32
32
  .TP
33
+ \fB\-\-include\-flow\-expectations\fR
34
+ Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only. Optional.
35
+ .TP
33
36
  \fB\-\-additional\-expectations\fR \fI<value>\fR
34
37
  The expectations graded on this variant only, on top of the flow's own. Sent as the complete set: it replaces whatever the variant had, so omit it to leave the set alone and send [] to clear it. Improv flows only: a scripted variant's expectations come from the agent turns on its path and are rewritten on every graph edit. Optional.
35
38
  .TP
@@ -33,6 +33,9 @@ Optional.
33
33
  \fB\-\-preceded\-by\-customer\-flow\-variant\-id\fR \fI<value>\fR
34
34
  Optional.
35
35
  .TP
36
+ \fB\-\-include\-flow\-expectations\fR
37
+ Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only. Optional.
38
+ .TP
36
39
  \fB\-\-persona\-override\-id\fR \fI<value>\fR
37
40
  The persona this runs as. Null on an edge case inherits the happy path's. Optional.
38
41
  .TP
@@ -30,6 +30,9 @@ Optional.
30
30
  \fB\-\-preceded\-by\-customer\-flow\-variant\-id\fR \fI<value>\fR
31
31
  Optional.
32
32
  .TP
33
+ \fB\-\-include\-flow\-expectations\fR
34
+ Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only. Optional.
35
+ .TP
33
36
  \fB\-\-persona\-override\-id\fR \fI<value>\fR
34
37
  The persona this runs as. Null on an edge case inherits the happy path's. Optional.
35
38
  .TP
@@ -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)
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
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.41.1",
3
+ "version": "0.43.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.41.1",
9
+ "version": "0.43.0",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
- "@roarkanalytics/sdk": "^5.3.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": "5.3.0",
25
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.3.0.tgz",
26
- "integrity": "sha512-HiYjp+Kote1emB6NAo6vvXbfSBTTYOR40agmUnEA5B7Str71OEOZY//ggwZH6ZplgIWUNyWlF27NCY1brGkIwA==",
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": {