@roarkanalytics/cli 0.20.0 → 0.22.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.
Files changed (21) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +13 -0
  3. package/commands.js +296 -3
  4. package/completions.js +4 -4
  5. package/man/roark-autoimprove-fix-answer.1 +97 -0
  6. package/man/roark-autoimprove-fix-cancel.1 +93 -0
  7. package/man/roark-autoimprove-fix-create.1 +117 -0
  8. package/man/roark-autoimprove-fix-dismiss.1 +93 -0
  9. package/man/roark-autoimprove-fix-get.1 +93 -0
  10. package/man/roark-autoimprove-fix-guidance-send.1 +97 -0
  11. package/man/roark-autoimprove-fix-list.1 +89 -0
  12. package/man/roark-autoimprove-fix-promote.1 +93 -0
  13. package/man/roark-simulation-persona-create.1 +4 -1
  14. package/man/roark-simulation-persona-update.1 +4 -1
  15. package/man/roark-simulation-plan-create.1 +2 -2
  16. package/man/roark-simulation-plan-update.1 +1 -1
  17. package/man/roark.1 +24 -0
  18. package/npm-shrinkwrap.json +5 -5
  19. package/package.json +9 -1
  20. package/version.d.ts +1 -1
  21. package/version.js +1 -1
package/man/roark-autoimprove-fix-answer.1 ADDED
@@ -0,0 +1,97 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AUTOIMPROVE\-FIX\-ANSWER" "1" "" "roark-autoimprove-fix-answer" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-autoimprove\-fix\-answer \- Answer Roark's question
5
+ .SH "SYNOPSIS"
6
+ .B roark autoimprove fix answer
7
+ \fIfix\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Answer the question a fix is blocked on. Only meaningful while the fix status is NEEDS_INPUT (the open QUESTION entry carries the offered options; free text is also accepted). Otherwise returns a conflict.
10
+ .SH "API"
11
+ POST /v1/autoimprove/fix/{fixId}/answer
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfix\-id\fR
15
+ The fix\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-text\fR \fI<value>\fR
19
+ The message for Roark. Required.
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 autoimprove fix answer <fix\-id> \-\-text <value>
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)
package/man/roark-autoimprove-fix-cancel.1 ADDED
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AUTOIMPROVE\-FIX\-CANCEL" "1" "" "roark-autoimprove-fix-cancel" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-autoimprove\-fix\-cancel \- Cancel a fix
5
+ .SH "SYNOPSIS"
6
+ .B roark autoimprove fix cancel
7
+ \fIfix\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Stop a live fix. Production is never changed by a cancel; everything the fix set up (the shadow agent, its phone number, authored test flows and run plan) is cleaned up automatically.
10
+ .SH "API"
11
+ POST /v1/autoimprove/fix/{fixId}/cancel
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfix\-id\fR
15
+ The fix\-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 autoimprove fix cancel <fix\-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-autoimprove-fix-create.1 ADDED
@@ -0,0 +1,117 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AUTOIMPROVE\-FIX\-CREATE" "1" "" "roark-autoimprove-fix-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-autoimprove\-fix\-create \- Start an Autoimprove fix
5
+ .SH "SYNOPSIS"
6
+ .B roark autoimprove fix create
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Commission Roark on an objective. It clones the agent into a staging shadow (or uses your designated staging agent), authors a validation suite of simulated callers, measures a baseline, changes the staging configuration, and re\-tests until the objective metric passes its target. Production is never touched by the loop; a verified fix waits for promotion. Requires an active provider integration (Vapi or Retell) with agent config writes enabled. One live fix per agent: starting a second returns a conflict. The fix runs asynchronously; poll GET /v1/autoimprove/fix/{fixId} or watch it in the dashboard. When its status is NEEDS_INPUT, answer via the answer endpoint; when AWAITING_PROMOTE, promote or dismiss.
10
+ .SH "API"
11
+ POST /v1/autoimprove/fix
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-agent\-id\fR \fI<value>\fR
15
+ The production agent to improve. It is never modified until you promote. Required.
16
+ .TP
17
+ \fB\-\-objective\-metric\-definition\-id\fR \fI<value>\fR
18
+ The metric that defines success: a pass/fail metric, or a threshold variant of a scale metric (for example "PII Handling >= 4"). Roark measures the pass rate of this metric across simulated calls. Required.
19
+ .TP
20
+ \fB\-\-objective\-label\fR \fI<value>\fR
21
+ Human\-readable label for the objective, shown everywhere the fix appears. Required.
22
+ .TP
23
+ \fB\-\-target\-value\fR \fI<value>\fR
24
+ The pass\-rate percentage that counts as fixed. Defaults to 90. Optional.
25
+ .TP
26
+ \fB\-\-staging\-agent\-id\fR \fI<value>\fR
27
+ An existing agent to stage changes on instead of the default shadow clone. Must be a different agent from agentId, on the same provider. Optional.
28
+ .TP
29
+ \fB\-\-customer\-integration\-id\fR \fI<value>\fR
30
+ The provider integration whose credentials Roark uses. Omit to use the project's active integration for the agent's provider. The integration must have agent config writes enabled. Optional.
31
+ .TP
32
+ \fB\-\-validation\-run\-plan\-id\fR \fI<value>\fR
33
+ An existing simulation run plan to validate with. Omit to let Roark author its own suite. Optional.
34
+ .TP
35
+ \fB\-\-max\-iterations\fR \fI<value>\fR
36
+ Cap on decision turns. Defaults to 10. Optional.
37
+ .TP
38
+ \fB\-\-max\-sim\-calls\fR \fI<value>\fR
39
+ Cap on simulated calls dialed. Defaults to 200. Optional.
40
+ .SH "GLOBAL OPTIONS"
41
+ .TP
42
+ \fB\-\-data\fR \fI<json>\fR
43
+ Request body as JSON, or @file to read one (@\- for stdin).
44
+ .TP
45
+ \fB\-y\fR, \fB\-\-yes\fR
46
+ Skip confirmation prompts.
47
+ .TP
48
+ \fB\-\-no\-input\fR
49
+ Never prompt; fail instead.
50
+ .TP
51
+ \fB\-\-base\-url\fR \fI<url>\fR
52
+ API base URL.
53
+ .TP
54
+ \fB\-\-token\fR \fI<token>\fR
55
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
56
+ .TP
57
+ \fB\-\-timeout\fR \fI<ms>\fR
58
+ Request timeout in milliseconds.
59
+ .TP
60
+ \fB\-\-max\-retries\fR \fI<count>\fR
61
+ Retries for retryable failures.
62
+ .TP
63
+ \fB\-\-format\fR \fI<format>\fR
64
+ Output format: auto, json, jsonl, plain.
65
+ .TP
66
+ \fB\-\-json\fR
67
+ Shorthand for \-\-format json.
68
+ .TP
69
+ \fB\-\-no\-color\fR
70
+ Disable colour.
71
+ .TP
72
+ \fB\-q\fR, \fB\-\-quiet\fR
73
+ Suppress non\-essential output.
74
+ .TP
75
+ \fB\-\-allow\-project\-base\-url\fR
76
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
77
+ .SH "EXAMPLES"
78
+ .PP
79
+ .RS 4
80
+ .nf
81
+ roark autoimprove fix create \-\-agent\-id <value> \-\-objective\-metric\-definition\-id <value> \-\-objective\-label <value>
82
+ .fi
83
+ .RE
84
+ .SH "ENVIRONMENT"
85
+ .TP
86
+ \fBROARK_API_BEARER_TOKEN\fR
87
+ Bearer token used when \-\-token is not given.
88
+ .TP
89
+ \fBROARK_BASE_URL\fR
90
+ API base URL.
91
+ .TP
92
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
93
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
94
+ .TP
95
+ \fBNO_COLOR\fR
96
+ Disables colour when set to any value.
97
+ .SH "EXIT STATUS"
98
+ .TP
99
+ \fB0\fR
100
+ The command succeeded.
101
+ .TP
102
+ \fB1\fR
103
+ The API rejected the request.
104
+ .TP
105
+ \fB2\fR
106
+ The command line was wrong.
107
+ .TP
108
+ \fB3\fR
109
+ No credential, or the credential was refused.
110
+ .TP
111
+ \fB4\fR
112
+ The addressed resource does not exist.
113
+ .TP
114
+ \fB5\fR
115
+ The request never completed: connection, timeout, or abort.
116
+ .SH "SEE ALSO"
117
+ .BR roark (1)
package/man/roark-autoimprove-fix-dismiss.1 ADDED
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AUTOIMPROVE\-FIX\-DISMISS" "1" "" "roark-autoimprove-fix-dismiss" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-autoimprove\-fix\-dismiss \- Dismiss a verified fix
5
+ .SH "SYNOPSIS"
6
+ .B roark autoimprove fix dismiss
7
+ \fIfix\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Discard a verified fix without promoting: production stays untouched and the staging resources are cleaned up. Only a fix in AWAITING_PROMOTE can be dismissed.
10
+ .SH "API"
11
+ POST /v1/autoimprove/fix/{fixId}/dismiss
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfix\-id\fR
15
+ The fix\-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 autoimprove fix dismiss <fix\-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-autoimprove-fix-get.1 ADDED
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AUTOIMPROVE\-FIX\-GET" "1" "" "roark-autoimprove-fix-get" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-autoimprove\-fix\-get \- Get an Autoimprove fix
5
+ .SH "SYNOPSIS"
6
+ .B roark autoimprove fix get
7
+ \fIfix\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Fetch one fix with its full worklog: every step Roark took, the validation batches with their pass\-rate movement, any question it is waiting on, and its final report once concluded.
10
+ .SH "API"
11
+ GET /v1/autoimprove/fix/{fixId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfix\-id\fR
15
+ The fix\-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 autoimprove fix get <fix\-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-autoimprove-fix-guidance-send.1 ADDED
@@ -0,0 +1,97 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AUTOIMPROVE\-FIX\-GUIDANCE\-SEND" "1" "" "roark-autoimprove-fix-guidance-send" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-autoimprove\-fix\-guidance\-send \- Send guidance to a running fix
5
+ .SH "SYNOPSIS"
6
+ .B roark autoimprove fix guidance send
7
+ \fIfix\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Steer Roark mid\-fix. The message is folded into its next decision and is binding. Accepted while the fix is live (RUNNING, NEEDS_INPUT, or PAUSED); a concluded fix returns a conflict.
10
+ .SH "API"
11
+ POST /v1/autoimprove/fix/{fixId}/guidance
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfix\-id\fR
15
+ The fix\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-text\fR \fI<value>\fR
19
+ The message for Roark. Required.
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 autoimprove fix guidance send <fix\-id> \-\-text <value>
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)
package/man/roark-autoimprove-fix-list.1 ADDED
@@ -0,0 +1,89 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AUTOIMPROVE\-FIX\-LIST" "1" "" "roark-autoimprove-fix-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-autoimprove\-fix\-list \- List Autoimprove fixes
5
+ .SH "SYNOPSIS"
6
+ .B roark autoimprove fix list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ List the Autoimprove fixes in this project, most recent first, capped at 100. A fix is one autonomous engagement: Roark improving one agent toward one objective metric on a staging copy, with a human\-gated promote to production at the end.
10
+ .SH "API"
11
+ GET /v1/autoimprove/fix
12
+ .SH "GLOBAL OPTIONS"
13
+ .TP
14
+ \fB\-\-data\fR \fI<json>\fR
15
+ Request body as JSON, or @file to read one (@\- for stdin).
16
+ .TP
17
+ \fB\-y\fR, \fB\-\-yes\fR
18
+ Skip confirmation prompts.
19
+ .TP
20
+ \fB\-\-no\-input\fR
21
+ Never prompt; fail instead.
22
+ .TP
23
+ \fB\-\-base\-url\fR \fI<url>\fR
24
+ API base URL.
25
+ .TP
26
+ \fB\-\-token\fR \fI<token>\fR
27
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
28
+ .TP
29
+ \fB\-\-timeout\fR \fI<ms>\fR
30
+ Request timeout in milliseconds.
31
+ .TP
32
+ \fB\-\-max\-retries\fR \fI<count>\fR
33
+ Retries for retryable failures.
34
+ .TP
35
+ \fB\-\-format\fR \fI<format>\fR
36
+ Output format: auto, json, jsonl, plain.
37
+ .TP
38
+ \fB\-\-json\fR
39
+ Shorthand for \-\-format json.
40
+ .TP
41
+ \fB\-\-no\-color\fR
42
+ Disable colour.
43
+ .TP
44
+ \fB\-q\fR, \fB\-\-quiet\fR
45
+ Suppress non\-essential output.
46
+ .TP
47
+ \fB\-\-allow\-project\-base\-url\fR
48
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
49
+ .SH "EXAMPLES"
50
+ .PP
51
+ .RS 4
52
+ .nf
53
+ roark autoimprove fix list
54
+ .fi
55
+ .RE
56
+ .SH "ENVIRONMENT"
57
+ .TP
58
+ \fBROARK_API_BEARER_TOKEN\fR
59
+ Bearer token used when \-\-token is not given.
60
+ .TP
61
+ \fBROARK_BASE_URL\fR
62
+ API base URL.
63
+ .TP
64
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
65
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
66
+ .TP
67
+ \fBNO_COLOR\fR
68
+ Disables colour when set to any value.
69
+ .SH "EXIT STATUS"
70
+ .TP
71
+ \fB0\fR
72
+ The command succeeded.
73
+ .TP
74
+ \fB1\fR
75
+ The API rejected the request.
76
+ .TP
77
+ \fB2\fR
78
+ The command line was wrong.
79
+ .TP
80
+ \fB3\fR
81
+ No credential, or the credential was refused.
82
+ .TP
83
+ \fB4\fR
84
+ The addressed resource does not exist.
85
+ .TP
86
+ \fB5\fR
87
+ The request never completed: connection, timeout, or abort.
88
+ .SH "SEE ALSO"
89
+ .BR roark (1)