@roarkanalytics/cli 0.23.1 → 0.25.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.
- package/CHANGELOG.md +14 -0
- package/README.md +12 -0
- package/commands.js +258 -1
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +99 -0
- package/man/roark-agent-config-get.1 +93 -0
- package/man/roark-agent-config-list.1 +89 -0
- package/man/roark-agent-config-promote.1 +93 -0
- package/man/roark-agent-config-resolve.1 +109 -0
- package/man/roark-agent-config-staging-delete.1 +93 -0
- package/man/roark-agent-config-update.1 +106 -0
- package/man/roark-autoimprove-job-create.1 +1 -1
- package/man/roark.1 +21 -0
- package/npm-shrinkwrap.json +5 -5
- package/package.json +8 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-BUILD" "1" "" "roark-agent-build" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-build \- Build a Roark\-hosted agent
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent build
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Creates a new Roark\-hosted agent from a one\-line job description. Roark authors the system prompt and hosts the config, so the agent is live and self\-improvable from creation.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/agent/build
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
15
|
+
Name of the agent Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-job\-description\fR \fI<value>\fR
|
|
18
|
+
One\-line description of what the agent should do. Roark authors the system prompt from this. Required.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-voice\fR \fI<value>\fR
|
|
21
|
+
Optional voice label for the hosted agent 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 agent build \-\-name <value> \-\-job\-description <value>
|
|
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\-AGENT\-CONFIG\-GET" "1" "" "roark-agent-config-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-config\-get \- Get a managed config
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent\-config get
|
|
7
|
+
\fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Fetch one managed config with its channel pointers and recent revisions, newest first.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/agent\-config/{key}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIkey\fR
|
|
15
|
+
The key.
|
|
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 agent\-config get <key>
|
|
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,89 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-CONFIG\-LIST" "1" "" "roark-agent-config-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-config\-list \- List managed configs
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent\-config list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
List the managed agent configs in this project, most recent first.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/agent\-config
|
|
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 agent\-config 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)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-CONFIG\-PROMOTE" "1" "" "roark-agent-config-promote" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-config\-promote \- Promote staging to production
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent\-config promote
|
|
7
|
+
\fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Point the production channel at the staging revision. Real traffic reads it from the next session onward; roll back by writing the prior revision id to production (the chain preserves every state).
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/agent\-config/{key}/promote
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIkey\fR
|
|
15
|
+
The key.
|
|
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 agent\-config promote <key>
|
|
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,109 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-CONFIG\-RESOLVE" "1" "" "roark-agent-config-resolve" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-config\-resolve \- Resolve config for a session
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent\-config resolve
|
|
7
|
+
\fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
The call your agent makes at session start. Returns the config JSON for this session, with per\-session simulation recognition built in: when the session was originated by a Roark simulation (matched by caller number against the calls Roark has in flight), the STAGING revision is served for that session only, so Autoimprove candidates are tested on your real deployment. Real traffic always resolves to production; any recognition miss degrades to production too. On the first fetch of an unknown key, pass `defaults` (your baked\-in config): the key is registered and the defaults become revision 1. That makes integration a single call. Cache the response per session; do not fetch per turn.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/agent\-config/{key}/resolve
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIkey\fR
|
|
15
|
+
The key.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-defaults\fR \fI<value>\fR
|
|
19
|
+
Your baked\-in config. On the first fetch of an unknown key this registers the config and becomes revision 1, so integration is a single call. Ignored once the key exists. Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-session\fR \fI<value>\fR
|
|
22
|
+
Session context. When the call was originated by a Roark simulation, Roark recognizes it here and serves the staging revision for this session only; real traffic always gets production. Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-session.session\-id\fR \fI<value>\fR
|
|
25
|
+
Your session or room identifier, for correlation. Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-session.caller\-number\fR \fI<value>\fR
|
|
28
|
+
The number calling your agent (E.164). Required for simulation recognition. Optional.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-session.called\-number\fR \fI<value>\fR
|
|
31
|
+
The number your agent was reached on (E.164). Optional.
|
|
32
|
+
.SH "GLOBAL OPTIONS"
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
35
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
38
|
+
Skip confirmation prompts.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-no\-input\fR
|
|
41
|
+
Never prompt; fail instead.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
44
|
+
API base URL.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
47
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
50
|
+
Request timeout in milliseconds.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
53
|
+
Retries for retryable failures.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
56
|
+
Output format: auto, json, jsonl, plain.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-json\fR
|
|
59
|
+
Shorthand for \-\-format json.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-no\-color\fR
|
|
62
|
+
Disable colour.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
65
|
+
Suppress non\-essential output.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
68
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
69
|
+
.SH "EXAMPLES"
|
|
70
|
+
.PP
|
|
71
|
+
.RS 4
|
|
72
|
+
.nf
|
|
73
|
+
roark agent\-config resolve <key>
|
|
74
|
+
.fi
|
|
75
|
+
.RE
|
|
76
|
+
.SH "ENVIRONMENT"
|
|
77
|
+
.TP
|
|
78
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
79
|
+
Bearer token used when \-\-token is not given.
|
|
80
|
+
.TP
|
|
81
|
+
\fBROARK_BASE_URL\fR
|
|
82
|
+
API base URL.
|
|
83
|
+
.TP
|
|
84
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
85
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
86
|
+
.TP
|
|
87
|
+
\fBNO_COLOR\fR
|
|
88
|
+
Disables colour when set to any value.
|
|
89
|
+
.SH "EXIT STATUS"
|
|
90
|
+
.TP
|
|
91
|
+
\fB0\fR
|
|
92
|
+
The command succeeded.
|
|
93
|
+
.TP
|
|
94
|
+
\fB1\fR
|
|
95
|
+
The API rejected the request.
|
|
96
|
+
.TP
|
|
97
|
+
\fB2\fR
|
|
98
|
+
The command line was wrong.
|
|
99
|
+
.TP
|
|
100
|
+
\fB3\fR
|
|
101
|
+
No credential, or the credential was refused.
|
|
102
|
+
.TP
|
|
103
|
+
\fB4\fR
|
|
104
|
+
The addressed resource does not exist.
|
|
105
|
+
.TP
|
|
106
|
+
\fB5\fR
|
|
107
|
+
The request never completed: connection, timeout, or abort.
|
|
108
|
+
.SH "SEE ALSO"
|
|
109
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-CONFIG\-STAGING\-DELETE" "1" "" "roark-agent-config-staging-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-config\-staging\-delete \- Discard the staging revision
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent\-config staging delete
|
|
7
|
+
\fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Clear the staging channel. Production is untouched; recognized simulation sessions go back to reading production.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/agent\-config/{key}/staging
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIkey\fR
|
|
15
|
+
The key.
|
|
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 agent\-config staging delete <key>
|
|
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,106 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-AGENT\-CONFIG\-UPDATE" "1" "" "roark-agent-config-update" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-agent\-config\-update \- Write a config revision
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark agent\-config update
|
|
7
|
+
\fIkey\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Write a new revision onto a channel. Writing production creates the key when it does not exist; writing staging stages a candidate that only Roark\-recognized simulation sessions will read. Every write is a new revision; nothing is overwritten.
|
|
10
|
+
.SH "API"
|
|
11
|
+
PUT /v1/agent\-config/{key}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIkey\fR
|
|
15
|
+
The key.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-channel\fR \fI<value>\fR
|
|
19
|
+
Which channel to write. One of: production, staging. Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-document\fR \fI<value>\fR
|
|
22
|
+
The full config JSON for the new revision. Required.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-summary\fR \fI<value>\fR
|
|
25
|
+
One\-line story of the change. Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-agent\-id\fR \fI<value>\fR
|
|
28
|
+
Link this config to a Roark agent (the one your calls report). Required before Autoimprove can run on it: the link is how a fix finds the config channel. Optional.
|
|
29
|
+
.SH "GLOBAL OPTIONS"
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
32
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
35
|
+
Skip confirmation prompts.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-no\-input\fR
|
|
38
|
+
Never prompt; fail instead.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
41
|
+
API base URL.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
44
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
47
|
+
Request timeout in milliseconds.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
50
|
+
Retries for retryable failures.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
53
|
+
Output format: auto, json, jsonl, plain.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-json\fR
|
|
56
|
+
Shorthand for \-\-format json.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-no\-color\fR
|
|
59
|
+
Disable colour.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
62
|
+
Suppress non\-essential output.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
65
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
66
|
+
.SH "EXAMPLES"
|
|
67
|
+
.PP
|
|
68
|
+
.RS 4
|
|
69
|
+
.nf
|
|
70
|
+
roark agent\-config update <key> \-\-channel <value> \-\-document <value>
|
|
71
|
+
.fi
|
|
72
|
+
.RE
|
|
73
|
+
.SH "ENVIRONMENT"
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
76
|
+
Bearer token used when \-\-token is not given.
|
|
77
|
+
.TP
|
|
78
|
+
\fBROARK_BASE_URL\fR
|
|
79
|
+
API base URL.
|
|
80
|
+
.TP
|
|
81
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
82
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
83
|
+
.TP
|
|
84
|
+
\fBNO_COLOR\fR
|
|
85
|
+
Disables colour when set to any value.
|
|
86
|
+
.SH "EXIT STATUS"
|
|
87
|
+
.TP
|
|
88
|
+
\fB0\fR
|
|
89
|
+
The command succeeded.
|
|
90
|
+
.TP
|
|
91
|
+
\fB1\fR
|
|
92
|
+
The API rejected the request.
|
|
93
|
+
.TP
|
|
94
|
+
\fB2\fR
|
|
95
|
+
The command line was wrong.
|
|
96
|
+
.TP
|
|
97
|
+
\fB3\fR
|
|
98
|
+
No credential, or the credential was refused.
|
|
99
|
+
.TP
|
|
100
|
+
\fB4\fR
|
|
101
|
+
The addressed resource does not exist.
|
|
102
|
+
.TP
|
|
103
|
+
\fB5\fR
|
|
104
|
+
The request never completed: connection, timeout, or abort.
|
|
105
|
+
.SH "SEE ALSO"
|
|
106
|
+
.BR roark (1)
|
|
@@ -6,7 +6,7 @@ roark\-autoimprove\-job\-create \- Start an Autoimprove job
|
|
|
6
6
|
.B roark autoimprove job create
|
|
7
7
|
[\fIoptions\fR]
|
|
8
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; verified changes wait for promotion. Requires an active provider integration (Vapi or
|
|
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; verified changes wait for promotion. Requires an active provider integration (Vapi, Retell, or ElevenLabs) with agent config writes enabled. One live job per agent: starting a second returns a conflict. The job runs asynchronously; poll GET /v1/autoimprove/job/{jobId} or watch it in the dashboard. When its status is NEEDS_INPUT, answer via the answer endpoint; when AWAITING_PROMOTE, promote or dismiss.
|
|
10
10
|
.SH "API"
|
|
11
11
|
POST /v1/autoimprove/job
|
|
12
12
|
.SH "OPTIONS"
|