@roarkanalytics/cli 0.24.0 → 0.26.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 +26 -24
- package/commands.js +109 -0
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +99 -0
- package/man/roark-simulation-tool-mock.1 +105 -0
- package/man/roark.1 +6 -0
- package/npm-shrinkwrap.json +5 -5
- package/package.json +3 -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,105 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-SIMULATION\-TOOL\-MOCK" "1" "" "roark-simulation-tool-mock" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-simulation\-tool\-mock \- Mock a tool call during a test call
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark simulation tool mock
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
The server half of the tool guard for code\-first agents. When a guarded tool fires during a Roark test call, send the invocation here instead of executing it: Roark answers with a simulated backend response that is valid JSON, shaped by the tool contract you pass, consistent with the test scenario, and consistent with earlier mocked responses in the same call. Real callers are never affected: the guard only diverts when the agent\-config resolve response identified the session as a Roark simulation, and this endpoint independently re\-validates the simulation before answering. Failure contract for your wrapper: `404` means the simulation id is unknown to this project (treat the session as real). `409` means the simulation has already ended (stale session state: do NOT execute the real tool; return your static fallback). `5xx` means generation failed (return your static fallback). Identical retries (same tool, same arguments) within a few minutes return the stored response, so double\-fired handlers stay consistent.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/simulation/tool\-mock
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-simulation\-job\-id\fR \fI<value>\fR
|
|
15
|
+
The simulation this session belongs to, from the agent\-config resolve response (`simulationJobId`). Roark re\-validates it against the live simulation before answering. Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-session\-id\fR \fI<value>\fR
|
|
18
|
+
Your session or room identifier, echoed back in logs for correlation. Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-tool\-name\fR \fI<value>\fR
|
|
21
|
+
The tool the agent invoked. Required.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-tool\-description\fR \fI<value>\fR
|
|
24
|
+
The tool's contract: its description and, ideally, its parameter and return shape. The more contract you pass, the more faithful the simulated response. Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-arguments\fR \fI<value>\fR
|
|
27
|
+
The arguments the agent called the tool with, verbatim. Optional.
|
|
28
|
+
.SH "GLOBAL OPTIONS"
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
31
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
34
|
+
Skip confirmation prompts.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-no\-input\fR
|
|
37
|
+
Never prompt; fail instead.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
40
|
+
API base URL.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
43
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
46
|
+
Request timeout in milliseconds.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
49
|
+
Retries for retryable failures.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
52
|
+
Output format: auto, json, jsonl, plain.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-json\fR
|
|
55
|
+
Shorthand for \-\-format json.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-no\-color\fR
|
|
58
|
+
Disable colour.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
61
|
+
Suppress non\-essential output.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
64
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
65
|
+
.SH "EXAMPLES"
|
|
66
|
+
.PP
|
|
67
|
+
.RS 4
|
|
68
|
+
.nf
|
|
69
|
+
roark simulation tool mock \-\-simulation\-job\-id <value> \-\-tool\-name <value>
|
|
70
|
+
.fi
|
|
71
|
+
.RE
|
|
72
|
+
.SH "ENVIRONMENT"
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
75
|
+
Bearer token used when \-\-token is not given.
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_BASE_URL\fR
|
|
78
|
+
API base URL.
|
|
79
|
+
.TP
|
|
80
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
81
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
82
|
+
.TP
|
|
83
|
+
\fBNO_COLOR\fR
|
|
84
|
+
Disables colour when set to any value.
|
|
85
|
+
.SH "EXIT STATUS"
|
|
86
|
+
.TP
|
|
87
|
+
\fB0\fR
|
|
88
|
+
The command succeeded.
|
|
89
|
+
.TP
|
|
90
|
+
\fB1\fR
|
|
91
|
+
The API rejected the request.
|
|
92
|
+
.TP
|
|
93
|
+
\fB2\fR
|
|
94
|
+
The command line was wrong.
|
|
95
|
+
.TP
|
|
96
|
+
\fB3\fR
|
|
97
|
+
No credential, or the credential was refused.
|
|
98
|
+
.TP
|
|
99
|
+
\fB4\fR
|
|
100
|
+
The addressed resource does not exist.
|
|
101
|
+
.TP
|
|
102
|
+
\fB5\fR
|
|
103
|
+
The request never completed: connection, timeout, or abort.
|
|
104
|
+
.SH "SEE ALSO"
|
|
105
|
+
.BR roark (1)
|
package/man/roark.1
CHANGED
|
@@ -60,6 +60,9 @@ Call any endpoint directly, including ones without a generated command.
|
|
|
60
60
|
\fBroark completion\fR
|
|
61
61
|
Print a shell completion script.
|
|
62
62
|
.TP
|
|
63
|
+
\fBroark agent build\fR
|
|
64
|
+
Build a Roark\-hosted agent See roark\-agent\-build(1).
|
|
65
|
+
.TP
|
|
63
66
|
\fBroark agent create\fR
|
|
64
67
|
Create a new agent See roark\-agent\-create(1).
|
|
65
68
|
.TP
|
|
@@ -345,6 +348,9 @@ Run a simulation See roark\-simulation\-run(1).
|
|
|
345
348
|
\fBroark simulation template list\fR
|
|
346
349
|
List simulation templates See roark\-simulation\-template\-list(1).
|
|
347
350
|
.TP
|
|
351
|
+
\fBroark simulation tool mock\fR
|
|
352
|
+
Mock a tool call during a test call See roark\-simulation\-tool\-mock(1).
|
|
353
|
+
.TP
|
|
348
354
|
\fBroark webhook create\fR
|
|
349
355
|
Create webhook See roark\-webhook\-create(1).
|
|
350
356
|
.TP
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.26.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@roarkanalytics/cli",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.26.0",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@roarkanalytics/sdk": "^4.0.0",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
}
|
|
22
22
|
},
|
|
23
23
|
"node_modules/@roarkanalytics/sdk": {
|
|
24
|
-
"version": "4.
|
|
25
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.
|
|
26
|
-
"integrity": "sha512-
|
|
24
|
+
"version": "4.3.0",
|
|
25
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.3.0.tgz",
|
|
26
|
+
"integrity": "sha512-dFHaa9MYG37x3oGj0u3/+tzGVcup6ABaCw3A3IbEAlUadx//Cacf1Rd0GW8ZRUUze+kMV+nn+0vwU9tvq3TPZA==",
|
|
27
27
|
"license": "Apache-2.0"
|
|
28
28
|
},
|
|
29
29
|
"node_modules/commander": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.26.0",
|
|
4
4
|
"description": "The official command line interface for the Roark API",
|
|
5
5
|
"author": "Roark <james@roark.ai>",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -35,6 +35,7 @@
|
|
|
35
35
|
},
|
|
36
36
|
"man": [
|
|
37
37
|
"./man/roark.1",
|
|
38
|
+
"./man/roark-agent-build.1",
|
|
38
39
|
"./man/roark-agent-create.1",
|
|
39
40
|
"./man/roark-agent-endpoint-create.1",
|
|
40
41
|
"./man/roark-agent-endpoint-get.1",
|
|
@@ -130,6 +131,7 @@
|
|
|
130
131
|
"./man/roark-simulation-plan-update.1",
|
|
131
132
|
"./man/roark-simulation-run.1",
|
|
132
133
|
"./man/roark-simulation-template-list.1",
|
|
134
|
+
"./man/roark-simulation-tool-mock.1",
|
|
133
135
|
"./man/roark-webhook-create.1",
|
|
134
136
|
"./man/roark-webhook-delete.1",
|
|
135
137
|
"./man/roark-webhook-get.1",
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.26.0";
|
package/version.js
CHANGED