@roarkanalytics/cli 0.26.1 → 0.28.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 (16) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +5 -0
  3. package/commands.js +186 -2
  4. package/completions.js +4 -4
  5. package/man/roark-simulation-job-tool-mock-list.1 +93 -0
  6. package/man/roark-simulation-plan-create.1 +1 -1
  7. package/man/roark-simulation-plan-update.1 +1 -1
  8. package/man/roark-simulation-tool-fixture-create.1 +105 -0
  9. package/man/roark-simulation-tool-fixture-delete.1 +93 -0
  10. package/man/roark-simulation-tool-fixture-list.1 +93 -0
  11. package/man/roark-simulation-tool-fixture-update.1 +103 -0
  12. package/man/roark.1 +15 -0
  13. package/npm-shrinkwrap.json +6 -6
  14. package/package.json +7 -2
  15. package/version.d.ts +1 -1
  16. package/version.js +1 -1
package/man/roark-simulation-job-tool-mock-list.1 ADDED
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-JOB\-TOOL\-MOCK\-LIST" "1" "" "roark-simulation-job-tool-mock-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-job\-tool\-mock\-list \- List mocked tool invocations
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation job tool\-mock list
7
+ \fIjob\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Every guarded tool invocation Roark answered during this simulation: what the agent tried to call, with what arguments, and the simulated response it received. Use this to assert tool behavior in CI after a test call, with zero real side effects. Empty when the agent's tools are not guarded (see the tool guard docs).
10
+ .SH "API"
11
+ GET /v1/simulation/job/{jobId}/tool\-mock
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIjob\-id\fR
15
+ Simulation job 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 job tool\-mock list <job\-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-simulation-plan-create.1 CHANGED
@@ -66,7 +66,7 @@ Let the run add metrics by itself off the attached flows, on top of the `metrics
66
66
  The property this run plan investigates: the one thing its arms differ by. Set it and the run report compares the arms on that property, so a run answers "what did background noise cost" rather than just "what did each arm score". Every value is a field already recorded on each call, so the report can label an arm `CRYING_BABY` rather than repeating a flow variant's title. Omit it and the report still compares when it can: it detects which property varies across the arms. Setting it is what tells the written summary what you were trying to find out, which detection cannot infer. One of: ACCENT, AGE, BACKGROUND_NOISE, BACKGROUND_NOISE_VOLUME, BASE_EMOTION, CONFIRMATION_STYLE, GENDER, INTENT_CLARITY, LANGUAGE, INTERRUPTION, MEMORY_RELIABILITY, RESPONSE_TIMING, SPEECH_CLARITY, SPEECH_PACE. Optional.
67
67
  .TP
68
68
  \fB\-\-comparison\-baseline\fR \fI<value>\fR
69
- The value of `comparisonProperty` every other value is measured against, for example `NONE` for `BACKGROUND_NOISE` or `NORMAL` for `SPEECH_PACE`. Must be a value that property can take. Stored rather than assumed, so the report can say "compared against US accent" instead of implying Roark decided which value is normal. Most properties have an obvious baseline and the dashboard prefills it; `GENDER` has none, so choose the one you are testing against. Optional.
69
+ The reference value of `comparisonProperty`, for example `NONE` for `BACKGROUND_NOISE` or `NORMAL` for `SPEECH_PACE`: shown first in the results. Must be a value that property can take. Whether a value did significantly worse does not depend on it: that is decided against every other value combined (see `sweepAttribution`). Stored rather than assumed, so the report can say "compared against US accent" instead of implying Roark decided which value is normal. Most properties have an obvious baseline and the dashboard prefills it; `GENDER` has none, so choose the one you are testing against. Optional.
70
70
  .TP
71
71
  \fB\-\-comparison\-values\fR \fI<value>\fR
72
72
  Which values of `comparisonProperty` to run. This is what the plan costs: the flow is attached once per value, so ten values is ten times the calls of one. Omit it to run every value the property has, which for `ACCENT` is more than twenty. Send a subset to narrow the sweep, for example three accents you actually serve. A `comparisonBaseline` outside this set is rejected, because it would anchor every difference to an arm the run never made. Not stored as a field: the arms are the values. Reading the plan back returns them as its flow attachments. Repeatable. Optional.
package/man/roark-simulation-plan-update.1 CHANGED
@@ -76,7 +76,7 @@ Whether to let the run add metrics by itself off the attached flows. See `POST /
76
76
  The property this plan investigates. Send `null` to clear the comparison; omit the field to leave it unchanged. See `POST /v1/simulation/plan`. The pair moves together. Sending `comparisonProperty` also sets `comparisonBaseline` to whatever this request carries, or to `null` if it carries none, because a baseline is a value of one specific property and keeping the old one would store a pair that is not valid. One of: ACCENT, AGE, BACKGROUND_NOISE, BACKGROUND_NOISE_VOLUME, BASE_EMOTION, CONFIRMATION_STYLE, GENDER, INTENT_CLARITY, LANGUAGE, INTERRUPTION, MEMORY_RELIABILITY, RESPONSE_TIMING, SPEECH_CLARITY, SPEECH_PACE. Optional.
77
77
  .TP
78
78
  \fB\-\-comparison\-baseline\fR \fI<value>\fR
79
- The value every other value is measured against. See `POST /v1/simulation/plan`. A real value cannot be sent on its own: the property it belongs to decides which values are legal, and an omitted property means "leave unchanged", which this endpoint cannot check a baseline against. Send `comparisonProperty` with it, or get a `400`. `null` on its own IS allowed, and clears just the baseline while leaving the property set. Nothing needs validating when clearing, and a property with no baseline is a real state: the report falls back to that property's own norm, and `GENDER` has no norm to fall back to. Optional.
79
+ The reference value, shown first in the results. See `POST /v1/simulation/plan`. A real value cannot be sent on its own: the property it belongs to decides which values are legal, and an omitted property means "leave unchanged", which this endpoint cannot check a baseline against. Send `comparisonProperty` with it, or get a `400`. `null` on its own IS allowed, and clears just the baseline while leaving the property set. Nothing needs validating when clearing, and a property with no baseline is a real state: the report falls back to that property's own norm, and `GENDER` has no norm to fall back to. Optional.
80
80
  .TP
81
81
  \fB\-\-comparison\-values\fR \fI<value>\fR
82
82
  Which values of `comparisonProperty` to run. See `POST /v1/simulation/plan`. Omitting it keeps the arms the plan already has, so an edit that only renames the plan never widens a sweep you deliberately narrowed, and never multiplies what it costs. Repeatable. Optional.
package/man/roark-simulation-tool-fixture-create.1 ADDED
@@ -0,0 +1,105 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-TOOL\-FIXTURE\-CREATE" "1" "" "roark-simulation-tool-fixture-create" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-tool\-fixture\-create \- Set a tool fixture
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation tool\-fixture create
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Create\-or\-replace by scope: one fixture per tool project\-wide, plus one per (tool, flow variant). Setting the same scope twice replaces the response, so CI can apply fixtures idempotently. During Roark test calls the tool guard answers with the fixture verbatim instead of generating a response; real callers are never affected.
10
+ .SH "API"
11
+ POST /v1/simulation/tool\-fixture
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-tool\-name\fR \fI<value>\fR
15
+ The tool this fixture answers for. Required.
16
+ .TP
17
+ \fB\-\-response\fR \fI<value>\fR
18
+ The exact JSON to return. Optional.
19
+ .TP
20
+ \fB\-\-customer\-flow\-variant\-id\fR \fI<value>\fR
21
+ Pin the fixture to one flow variant (scenario). Omit for a project\-wide fixture. A variant\-pinned fixture beats the project\-wide one. Optional.
22
+ .TP
23
+ \fB\-\-description\fR \fI<value>\fR
24
+ Why this fixture exists. Optional.
25
+ .TP
26
+ \fB\-\-enabled\fR
27
+ Defaults to true. 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\-fixture create \-\-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-simulation-tool-fixture-delete.1 ADDED
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-TOOL\-FIXTURE\-DELETE" "1" "" "roark-simulation-tool-fixture-delete" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-tool\-fixture\-delete \- Delete a tool fixture
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation tool\-fixture delete
7
+ \fIfixture\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ The tool goes back to scenario\-aware generated responses in test calls.
10
+ .SH "API"
11
+ DELETE /v1/simulation/tool\-fixture/{fixtureId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfixture\-id\fR
15
+ The fixture\-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 tool\-fixture delete <fixture\-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-simulation-tool-fixture-list.1 ADDED
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-TOOL\-FIXTURE\-LIST" "1" "" "roark-simulation-tool-fixture-list" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-tool\-fixture\-list \- List tool fixtures
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation tool\-fixture list
7
+ [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ All deterministic tool responses configured for this project, optionally filtered by tool.
10
+ .SH "API"
11
+ GET /v1/simulation/tool\-fixture
12
+ .SH "OPTIONS"
13
+ .TP
14
+ \fB\-\-tool\-name\fR \fI<value>\fR
15
+ Only fixtures for this tool. Optional.
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 tool\-fixture list
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-simulation-tool-fixture-update.1 ADDED
@@ -0,0 +1,103 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-SIMULATION\-TOOL\-FIXTURE\-UPDATE" "1" "" "roark-simulation-tool-fixture-update" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-simulation\-tool\-fixture\-update \- Update a tool fixture
5
+ .SH "SYNOPSIS"
6
+ .B roark simulation tool\-fixture update
7
+ \fIfixture\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Change the response, description, or enabled state of an existing fixture.
10
+ .SH "API"
11
+ PUT /v1/simulation/tool\-fixture/{fixtureId}
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfixture\-id\fR
15
+ The fixture\-id.
16
+ .SH "OPTIONS"
17
+ .TP
18
+ \fB\-\-response\fR \fI<value>\fR
19
+ Optional.
20
+ .TP
21
+ \fB\-\-description\fR \fI<value>\fR
22
+ Optional.
23
+ .TP
24
+ \fB\-\-enabled\fR
25
+ Optional.
26
+ .SH "GLOBAL OPTIONS"
27
+ .TP
28
+ \fB\-\-data\fR \fI<json>\fR
29
+ Request body as JSON, or @file to read one (@\- for stdin).
30
+ .TP
31
+ \fB\-y\fR, \fB\-\-yes\fR
32
+ Skip confirmation prompts.
33
+ .TP
34
+ \fB\-\-no\-input\fR
35
+ Never prompt; fail instead.
36
+ .TP
37
+ \fB\-\-base\-url\fR \fI<url>\fR
38
+ API base URL.
39
+ .TP
40
+ \fB\-\-token\fR \fI<token>\fR
41
+ Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
42
+ .TP
43
+ \fB\-\-timeout\fR \fI<ms>\fR
44
+ Request timeout in milliseconds.
45
+ .TP
46
+ \fB\-\-max\-retries\fR \fI<count>\fR
47
+ Retries for retryable failures.
48
+ .TP
49
+ \fB\-\-format\fR \fI<format>\fR
50
+ Output format: auto, json, jsonl, plain.
51
+ .TP
52
+ \fB\-\-json\fR
53
+ Shorthand for \-\-format json.
54
+ .TP
55
+ \fB\-\-no\-color\fR
56
+ Disable colour.
57
+ .TP
58
+ \fB\-q\fR, \fB\-\-quiet\fR
59
+ Suppress non\-essential output.
60
+ .TP
61
+ \fB\-\-allow\-project\-base\-url\fR
62
+ Send the stored credential to a base URL set by a project .roark.json. Refused by default.
63
+ .SH "EXAMPLES"
64
+ .PP
65
+ .RS 4
66
+ .nf
67
+ roark simulation tool\-fixture update <fixture\-id>
68
+ .fi
69
+ .RE
70
+ .SH "ENVIRONMENT"
71
+ .TP
72
+ \fBROARK_API_BEARER_TOKEN\fR
73
+ Bearer token used when \-\-token is not given.
74
+ .TP
75
+ \fBROARK_BASE_URL\fR
76
+ API base URL.
77
+ .TP
78
+ \fBROARK_ALLOW_PROJECT_BASE_URL\fR
79
+ Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
80
+ .TP
81
+ \fBNO_COLOR\fR
82
+ Disables colour when set to any value.
83
+ .SH "EXIT STATUS"
84
+ .TP
85
+ \fB0\fR
86
+ The command succeeded.
87
+ .TP
88
+ \fB1\fR
89
+ The API rejected the request.
90
+ .TP
91
+ \fB2\fR
92
+ The command line was wrong.
93
+ .TP
94
+ \fB3\fR
95
+ No credential, or the credential was refused.
96
+ .TP
97
+ \fB4\fR
98
+ The addressed resource does not exist.
99
+ .TP
100
+ \fB5\fR
101
+ The request never completed: connection, timeout, or abort.
102
+ .SH "SEE ALSO"
103
+ .BR roark (1)
package/man/roark.1 CHANGED
@@ -303,6 +303,9 @@ Get simulation by ID See roark\-simulation\-job\-get(1).
303
303
  \fBroark simulation job lookup\fR
304
304
  Lookup by phone number See roark\-simulation\-job\-lookup(1).
305
305
  .TP
306
+ \fBroark simulation job tool\-mock list\fR
307
+ List mocked tool invocations See roark\-simulation\-job\-tool\-mock\-list(1).
308
+ .TP
306
309
  \fBroark simulation persona create\fR
307
310
  Create a new persona See roark\-simulation\-persona\-create(1).
308
311
  .TP
@@ -351,6 +354,18 @@ List simulation templates See roark\-simulation\-template\-list(1).
351
354
  \fBroark simulation tool mock\fR
352
355
  Mock a tool call during a test call See roark\-simulation\-tool\-mock(1).
353
356
  .TP
357
+ \fBroark simulation tool\-fixture create\fR
358
+ Set a tool fixture See roark\-simulation\-tool\-fixture\-create(1).
359
+ .TP
360
+ \fBroark simulation tool\-fixture delete\fR
361
+ Delete a tool fixture See roark\-simulation\-tool\-fixture\-delete(1).
362
+ .TP
363
+ \fBroark simulation tool\-fixture list\fR
364
+ List tool fixtures See roark\-simulation\-tool\-fixture\-list(1).
365
+ .TP
366
+ \fBroark simulation tool\-fixture update\fR
367
+ Update a tool fixture See roark\-simulation\-tool\-fixture\-update(1).
368
+ .TP
354
369
  \fBroark webhook create\fR
355
370
  Create webhook See roark\-webhook\-create(1).
356
371
  .TP
package/npm-shrinkwrap.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.26.1",
3
+ "version": "0.28.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.26.1",
9
+ "version": "0.28.0",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
- "@roarkanalytics/sdk": "^4.3.0",
12
+ "@roarkanalytics/sdk": "^4.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.3.0",
25
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.3.0.tgz",
26
- "integrity": "sha512-dFHaa9MYG37x3oGj0u3/+tzGVcup6ABaCw3A3IbEAlUadx//Cacf1Rd0GW8ZRUUze+kMV+nn+0vwU9tvq3TPZA==",
24
+ "version": "4.8.0",
25
+ "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.8.0.tgz",
26
+ "integrity": "sha512-j7awV7Fq8zJgZOYBoU+I7HOoBzQbWMsZFpmN601j1lt6j50vC1g3Lz7FKmrvP4X31EZBOvFDrGktnfRNQANIew==",
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.26.1",
3
+ "version": "0.28.0",
4
4
  "description": "The official command line interface for the Roark API",
5
5
  "author": "Roark <james@roark.ai>",
6
6
  "type": "commonjs",
@@ -29,7 +29,7 @@
29
29
  "fix": "eslint --fix . && prettier --write ."
30
30
  },
31
31
  "dependencies": {
32
- "@roarkanalytics/sdk": "^4.3.0",
32
+ "@roarkanalytics/sdk": "^4.4.0",
33
33
  "commander": "^14.0.3",
34
34
  "yaml": "^2.9.0"
35
35
  },
@@ -116,6 +116,7 @@
116
116
  "./man/roark-simulation-environment-update.1",
117
117
  "./man/roark-simulation-job-get.1",
118
118
  "./man/roark-simulation-job-lookup.1",
119
+ "./man/roark-simulation-job-tool-mock-list.1",
119
120
  "./man/roark-simulation-persona-create.1",
120
121
  "./man/roark-simulation-persona-get.1",
121
122
  "./man/roark-simulation-persona-list.1",
@@ -132,6 +133,10 @@
132
133
  "./man/roark-simulation-run.1",
133
134
  "./man/roark-simulation-template-list.1",
134
135
  "./man/roark-simulation-tool-mock.1",
136
+ "./man/roark-simulation-tool-fixture-create.1",
137
+ "./man/roark-simulation-tool-fixture-delete.1",
138
+ "./man/roark-simulation-tool-fixture-list.1",
139
+ "./man/roark-simulation-tool-fixture-update.1",
135
140
  "./man/roark-webhook-create.1",
136
141
  "./man/roark-webhook-delete.1",
137
142
  "./man/roark-webhook-get.1",
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "0.26.1";
1
+ export declare const version = "0.28.0";
package/version.js CHANGED
@@ -10,4 +10,4 @@ exports.version = void 0;
10
10
  //
11
11
  // Do not edit: an edit here is overwritten, and the published number is whatever
12
12
  // package.json says.
13
- exports.version = '0.26.1'; // x-release-please-version
13
+ exports.version = '0.28.0'; // x-release-please-version