@roarkanalytics/cli 0.4.0 → 0.6.0

package/man/roark-metric-variant-update.1

@@ -0,0 +1,121 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-METRIC\-VARIANT\-UPDATE" "1" "" "roark-metric-variant-update" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-metric\-variant\-update \- Update a metric variant
+.SH "SYNOPSIS"
+.B roark metric variant update
+\fIid\-or\-slug\fR \fIvariant\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Rename a variant, change its configuration, or both. Every configuration change creates a new immutable version and advances `versionId`; the response carries the advanced value. **Editing one of Roark’s own variants forks it for your organization.** The response carries the new variant’s `id`, which will differ from the one in the path, and `isSystem` becomes false. Roark’s variant is untouched and other organizations keep it. DELETE your fork to go back to it. Which fields are editable depends on the metric: some Roark metrics lock their prompt or output configuration, and a locked field is rejected rather than ignored.
+.SH "API"
+PUT /v1/metric/definitions/{idOrSlug}/variants/{variantId}
+.SH "ARGUMENTS"
+.TP
+\fIid\-or\-slug\fR
+Metric definition UUID or its stable slug.
+.TP
+\fIvariant\-id\fR
+Variant UUID.
+.SH "OPTIONS"
+.TP
+\fB\-\-name\fR \fI<value>\fR
+Rename the variant. Does not change its configuration, so `versionId` is unaffected. `Default` is reserved. Optional.
+.TP
+\fB\-\-llm\-prompt\fR \fI<value>\fR
+The rubric this variant applies. LLM judge metrics only. Optional.
+.TP
+\fB\-\-scale\-min\fR \fI<value>\fR
+Scale minimum. SCALE output only. Optional.
+.TP
+\fB\-\-scale\-max\fR \fI<value>\fR
+Scale maximum. SCALE output only. Optional.
+.TP
+\fB\-\-boolean\-true\-label\fR \fI<value>\fR
+What a `true` value means. Given to the judge as its polarity rule, so keep it accurate. Optional.
+.TP
+\fB\-\-boolean\-false\-label\fR \fI<value>\fR
+What a `false` value means. Given to the judge as its polarity rule, so keep it accurate. Optional.
+.TP
+\fB\-\-max\-classifications\fR \fI<value>\fR
+Maximum classifications returned. CLASSIFICATION output only. Optional.
+.TP
+\fB\-\-change\-reason\fR \fI<value>\fR
+Free\-text audit note recorded on the new version. Optional.
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-data\fR \fI<json>\fR
+Request body as JSON, or @file to read one (@\- for stdin).
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Skip confirmation prompts.
+.TP
+\fB\-\-no\-input\fR
+Never prompt; fail instead.
+.TP
+\fB\-\-base\-url\fR \fI<url>\fR
+API base URL.
+.TP
+\fB\-\-token\fR \fI<token>\fR
+Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
+.TP
+\fB\-\-timeout\fR \fI<ms>\fR
+Request timeout in milliseconds.
+.TP
+\fB\-\-max\-retries\fR \fI<count>\fR
+Retries for retryable failures.
+.TP
+\fB\-\-format\fR \fI<format>\fR
+Output format: auto, json, jsonl, plain.
+.TP
+\fB\-\-json\fR
+Shorthand for \-\-format json.
+.TP
+\fB\-\-no\-color\fR
+Disable colour.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress non\-essential output.
+.TP
+\fB\-\-allow\-project\-base\-url\fR
+Send the stored credential to a base URL set by a project .roark.json. Refused by default.
+.SH "EXAMPLES"
+.PP
+.RS 4
+.nf
+roark metric variant update <id\-or\-slug> <variant\-id>
+.fi
+.RE
+.SH "ENVIRONMENT"
+.TP
+\fBROARK_API_BEARER_TOKEN\fR
+Bearer token used when \-\-token is not given.
+.TP
+\fBROARK_BASE_URL\fR
+API base URL.
+.TP
+\fBROARK_ALLOW_PROJECT_BASE_URL\fR
+Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
+.TP
+\fBNO_COLOR\fR
+Disables colour when set to any value.
+.SH "EXIT STATUS"
+.TP
+\fB0\fR
+The command succeeded.
+.TP
+\fB1\fR
+The API rejected the request.
+.TP
+\fB2\fR
+The command line was wrong.
+.TP
+\fB3\fR
+No credential, or the credential was refused.
+.TP
+\fB4\fR
+The addressed resource does not exist.
+.TP
+\fB5\fR
+The request never completed: connection, timeout, or abort.
+.SH "SEE ALSO"
+.BR roark (1)

package/man/roark-simulation-plan-create.1

@@ -56,6 +56,9 @@ Agent endpoints to include in this run plan Required.
 \fB\-\-metrics\fR \fI<value>\fR
 Metric definitions to include in this run plan. Reference each by `id` (UUID) or `slug`. Required.
 .TP
+\fB\-\-include\-flow\-metrics\fR
+Also collect each attached flow's own metrics, on top of the `metrics` named here. Default true, which is what you want when you brought your own flows and their graders. Set false for a run whose metric list is meant to be exhaustive: a template like Load Testing or Voicemail deliberately grades a narrow set, and inheriting every flow metric on top multiplies analysis cost across the volume without adding signal. GET /v1/simulation/template returns the value each template expects. Optional.
+.TP
 \fB\-\-enrich\-with\-live\-conversation\fR
 Merge the customer's own recording of the real call into each simulation, so metrics can be scored against the live leg as well as the simulated one. This is the API equivalent of the dashboard's live\-enrichment toggle. With this on, the run provisions a phone number and holds each call open for up to 15 minutes waiting for a matching call to be posted to POST /v1/call. A call matches on the provisioned number (`roarkPhoneNumber` on the job) with a start time inside the simulation window. If nothing arrives, the simulation still completes and any `LIVE`\-sourced metric produces no value. Required by any metric whose `requiresLiveConversation` is true: without it that metric is silently skipped. Optional.
 .TP

package/man/roark-simulation-plan-update.1

@@ -65,6 +65,9 @@ Metric definitions to include in this run plan. Reference each by `id` (UUID) or
 .TP
 \fB\-\-enrich\-with\-live\-conversation\fR
 Whether to merge the customer's own live recording into each simulation of this plan. Optional.
+.TP
+\fB\-\-include\-flow\-metrics\fR
+Whether to also collect each attached flow's own metrics, on top of this plan's list. Optional.
 .SH "GLOBAL OPTIONS"
 .TP
 \fB\-\-data\fR \fI<json>\fR

package/man/roark-simulation-template-list.1

@@ -0,0 +1,89 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-TEMPLATE\-LIST" "1" "" "roark-simulation-template-list" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-template\-list \- List simulation templates
+.SH "SYNOPSIS"
+.B roark simulation template list
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Returns the built\-in simulation templates, each resolved against this project: the metric and check definitions it collects, and the flows it runs with the variants it covers. A template is a preset rather than a stored object, so building a run from one produces an ordinary run plan you own and can edit afterwards. Pass a `slug` as `template` to POST /v1/simulation/run. Every entry is complete, so there is no per\-template endpoint to follow up with, and the list is a fixed catalogue rather than a paginated one. Only templates a request can actually run are listed.
+.SH "API"
+GET /v1/simulation/template
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-data\fR \fI<json>\fR
+Request body as JSON, or @file to read one (@\- for stdin).
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Skip confirmation prompts.
+.TP
+\fB\-\-no\-input\fR
+Never prompt; fail instead.
+.TP
+\fB\-\-base\-url\fR \fI<url>\fR
+API base URL.
+.TP
+\fB\-\-token\fR \fI<token>\fR
+Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
+.TP
+\fB\-\-timeout\fR \fI<ms>\fR
+Request timeout in milliseconds.
+.TP
+\fB\-\-max\-retries\fR \fI<count>\fR
+Retries for retryable failures.
+.TP
+\fB\-\-format\fR \fI<format>\fR
+Output format: auto, json, jsonl, plain.
+.TP
+\fB\-\-json\fR
+Shorthand for \-\-format json.
+.TP
+\fB\-\-no\-color\fR
+Disable colour.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress non\-essential output.
+.TP
+\fB\-\-allow\-project\-base\-url\fR
+Send the stored credential to a base URL set by a project .roark.json. Refused by default.
+.SH "EXAMPLES"
+.PP
+.RS 4
+.nf
+roark simulation template list
+.fi
+.RE
+.SH "ENVIRONMENT"
+.TP
+\fBROARK_API_BEARER_TOKEN\fR
+Bearer token used when \-\-token is not given.
+.TP
+\fBROARK_BASE_URL\fR
+API base URL.
+.TP
+\fBROARK_ALLOW_PROJECT_BASE_URL\fR
+Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
+.TP
+\fBNO_COLOR\fR
+Disables colour when set to any value.
+.SH "EXIT STATUS"
+.TP
+\fB0\fR
+The command succeeded.
+.TP
+\fB1\fR
+The API rejected the request.
+.TP
+\fB2\fR
+The command line was wrong.
+.TP
+\fB3\fR
+No credential, or the credential was refused.
+.TP
+\fB4\fR
+The addressed resource does not exist.
+.TP
+\fB5\fR
+The request never completed: connection, timeout, or abort.
+.SH "SEE ALSO"
+.BR roark (1)

package/man/roark.1

@@ -99,6 +99,9 @@ List call metrics See roark\-call\-metric\-list(1).
 \fBroark call sentiment\-run list\fR
 List call sentiment runs See roark\-call\-sentiment\-run\-list(1).
 .TP
+\fBroark call tool\-invocation append\fR
+Append tool invocations to a call See roark\-call\-tool\-invocation\-append(1).
+.TP
 \fBroark call transcript get\fR
 Get call transcript See roark\-call\-transcript\-get(1).
 .TP
@@ -171,6 +174,9 @@ Create custom metric definition See roark\-metric\-definition\-create(1).
 \fBroark metric definition list\fR
 List metric definitions See roark\-metric\-definition\-list(1).
 .TP
+\fBroark metric definition update\fR
+Update a metric definition See roark\-metric\-definition\-update(1).
+.TP
 \fBroark metric policy create\fR
 Create a metric policy See roark\-metric\-policy\-create(1).
 .TP
@@ -186,6 +192,21 @@ List metric policies See roark\-metric\-policy\-list(1).
 \fBroark metric policy update\fR
 Update a metric policy See roark\-metric\-policy\-update(1).
 .TP
+\fBroark metric variant create\fR
+Create a metric variant See roark\-metric\-variant\-create(1).
+.TP
+\fBroark metric variant delete\fR
+Delete a metric variant See roark\-metric\-variant\-delete(1).
+.TP
+\fBroark metric variant get\fR
+Get a metric variant See roark\-metric\-variant\-get(1).
+.TP
+\fBroark metric variant list\fR
+List a metric’s variants See roark\-metric\-variant\-list(1).
+.TP
+\fBroark metric variant update\fR
+Update a metric variant See roark\-metric\-variant\-update(1).
+.TP
 \fBroark simulation environment get\fR
 Get environment by ID See roark\-simulation\-environment\-get(1).
 .TP
@@ -237,6 +258,9 @@ Update a run plan See roark\-simulation\-plan\-update(1).
 \fBroark simulation run\fR
 Run a simulation See roark\-simulation\-run(1).
 .TP
+\fBroark simulation template list\fR
+List simulation templates See roark\-simulation\-template\-list(1).
+.TP
 \fBroark webhook create\fR
 Create webhook See roark\-webhook\-create(1).
 .TP

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@roarkanalytics/cli",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@roarkanalytics/cli",
-      "version": "0.4.0",
+      "version": "0.6.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@roarkanalytics/sdk": "^3.2.1",
@@ -21,9 +21,9 @@
       }
     },
     "node_modules/@roarkanalytics/sdk": {
-      "version": "3.4.0",
-      "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-3.4.0.tgz",
-      "integrity": "sha512-PZZSBfg80KBdp/2kgNVX4uMJ7fQ/Jp2EYL6BaIZDGLgL8kY/BSmgIg7NqBF8ctCY44bwpYWg9CJqZMGtEprG5Q==",
+      "version": "3.10.0",
+      "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-3.10.0.tgz",
+      "integrity": "sha512-VFoJ4HSJmOnZuVQ+IIOcndxrAYcE+u0svOxBYkSUi0k7Bco1yMMTatDG0LWceJqgS/pTdkWprqe56KGzXYpT9A==",
       "license": "Apache-2.0"
     },
     "node_modules/commander": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roarkanalytics/cli",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "The official command line interface for the Roark API",
   "author": "Roark <james@roark.ai>",
   "type": "commonjs",
@@ -48,6 +48,7 @@
     "./man/roark-call-list.1",
     "./man/roark-call-metric-list.1",
     "./man/roark-call-sentiment-run-list.1",
+    "./man/roark-call-tool-invocation-append.1",
     "./man/roark-call-transcript-get.1",
     "./man/roark-config-apply.1",
     "./man/roark-config-diff.1",
@@ -72,11 +73,17 @@
     "./man/roark-metric-collection-job-list.1",
     "./man/roark-metric-definition-create.1",
     "./man/roark-metric-definition-list.1",
+    "./man/roark-metric-definition-update.1",
     "./man/roark-metric-policy-create.1",
     "./man/roark-metric-policy-delete.1",
     "./man/roark-metric-policy-get.1",
     "./man/roark-metric-policy-list.1",
     "./man/roark-metric-policy-update.1",
+    "./man/roark-metric-variant-create.1",
+    "./man/roark-metric-variant-delete.1",
+    "./man/roark-metric-variant-get.1",
+    "./man/roark-metric-variant-list.1",
+    "./man/roark-metric-variant-update.1",
     "./man/roark-simulation-environment-get.1",
     "./man/roark-simulation-environment-list.1",
     "./man/roark-simulation-job-get.1",
@@ -94,6 +101,7 @@
     "./man/roark-simulation-plan-list.1",
     "./man/roark-simulation-plan-update.1",
     "./man/roark-simulation-run.1",
+    "./man/roark-simulation-template-list.1",
     "./man/roark-webhook-create.1",
     "./man/roark-webhook-delete.1",
     "./man/roark-webhook-get.1",

package/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.4.0";
+export declare const version = "0.6.0";

package/version.js

@@ -10,4 +10,4 @@ exports.version = void 0;
 //
 // Do not edit: an edit here is overwritten, and the published number is whatever
 // package.json says.
-exports.version = '0.4.0'; // x-release-please-version
+exports.version = '0.6.0'; // x-release-please-version