@roarkanalytics/cli 0.1.0

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

@@ -0,0 +1,96 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-ENVIRONMENT\-LIST" "1" "" "roark-simulation-environment-list" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-environment\-list \- List environments
+.SH "SYNOPSIS"
+.B roark simulation environment list
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Returns a paginated list of environments: the project's own plus the environments Roark curates and shares across every project. Reference one by id when setting a customer flow variant's environment.
+.SH "API"
+GET /v1/simulation/environment
+.SH "OPTIONS"
+.TP
+\fB\-\-limit\fR \fI<value>\fR
+Optional.
+.TP
+\fB\-\-after\fR \fI<value>\fR
+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 simulation environment 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-simulation-job-get.1

@@ -0,0 +1,93 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-JOB\-GET" "1" "" "roark-simulation-job-get" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-job\-get \- Get simulation by ID
+.SH "SYNOPSIS"
+.B roark simulation job get
+\fIjob\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Get a individual simulation run directly by its ID. This is generally part of a larger simulation run plan job.
+.SH "API"
+GET /v1/simulation/job/{jobId}
+.SH "ARGUMENTS"
+.TP
+\fIjob\-id\fR
+Simulation job ID
+.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 job get <job\-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-job-lookup.1

@@ -0,0 +1,96 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-JOB\-LOOKUP" "1" "" "roark-simulation-job-lookup" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-job\-lookup \- Lookup by phone number
+.SH "SYNOPSIS"
+.B roark simulation job lookup
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Find the matching simulation using the number used by the Roark simulation agent.
+.SH "API"
+GET /v1/simulation/job/lookup
+.SH "OPTIONS"
+.TP
+\fB\-\-roark\-phone\-number\fR \fI<value>\fR
+Phone number provisioned by Roark for the simulation job in E.164 format. In the case of an inbound simulation, this is the number that calls your agent; in the case of an outbound simulation, this is the number you call from your agent. Required.
+.TP
+\fB\-\-call\-received\-at\fR \fI<value>\fR
+ISO 8601 timestamp of when the call was received. Alternatively, any time between the start and end of the call is valid. Defaults to the current time, which fetches any jobs that are currently ongoing. 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 simulation job lookup \-\-roark\-phone\-number <value>
+.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-persona-create.1

@@ -0,0 +1,156 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-PERSONA\-CREATE" "1" "" "roark-simulation-persona-create" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-persona\-create \- Create a new persona
+.SH "SYNOPSIS"
+.B roark simulation persona create
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Creates a new persona for the authenticated project.
+.SH "API"
+POST /v1/persona
+.SH "OPTIONS"
+.TP
+\fB\-\-name\fR \fI<value>\fR
+The name the agent will identify as during conversations Required.
+.TP
+\fB\-\-description\fR \fI<value>\fR
+Human\-readable description of the persona Optional.
+.TP
+\fB\-\-language\fR \fI<value>\fR
+Primary language ISO 639\-1 code for the persona One of: EN, ES, DE, HI, FR, NL, AR, EL, IT, ID, TH, JA, TL, MS, ZH, TR, PT, HE. Required.
+.TP
+\fB\-\-secondary\-language\fR \fI<value>\fR
+Secondary language ISO 639\-1 code for code\-switching (e.g., Hinglish, Spanglish) One of: EN. Optional.
+.TP
+\fB\-\-understood\-languages\fR \fI<value>\fR
+Languages the persona can understand. Defaults to the languages the persona speaks. One of: EN, ES, DE, HI, FR, NL, AR, EL, IT, ID, TH, JA, TL, MS, ZH, TR, PT, HE. Repeatable. Optional.
+.TP
+\fB\-\-accent\fR \fI<value>\fR
+Accent of the persona, defined using ISO 3166\-1 alpha\-2 country codes with optional variants One of: US, US_X_SOUTH, GB, ES, DE, IN, FR, NL, SA, GR, AU, IT, ID, TH, JP, NZ, PH, SG, MY, HK, TR, PT, IL. Required.
+.TP
+\fB\-\-gender\fR \fI<value>\fR
+Gender of the persona One of: MALE, FEMALE. Required.
+.TP
+\fB\-\-background\-noise\fR \fI<value>\fR
+Background noise setting One of: NONE, AIRPORT, CHILDREN_PLAYING, CITY, COFFEE_SHOP, DRIVING, OFFICE, THUNDERSTORM. Optional.
+.TP
+\fB\-\-speech\-pace\fR \fI<value>\fR
+Speech pace of the persona One of: SUPER_SLOW, SLOW, NORMAL, FAST, SUPER_FAST. Optional.
+.TP
+\fB\-\-speech\-clarity\fR \fI<value>\fR
+Speech clarity of the persona One of: CLEAR, VAGUE, RAMBLING. Optional.
+.TP
+\fB\-\-has\-disfluencies\fR
+Whether the persona uses filler words like "um" and "uh" Optional.
+.TP
+\fB\-\-base\-emotion\fR \fI<value>\fR
+Base emotional state of the persona One of: NEUTRAL, CHEERFUL, CONFUSED, FRUSTRATED, SKEPTICAL, RUSHED, DISTRACTED. Optional.
+.TP
+\fB\-\-intent\-clarity\fR \fI<value>\fR
+How clearly the persona expresses their intentions One of: CLEAR, INDIRECT, VAGUE. Optional.
+.TP
+\fB\-\-confirmation\-style\fR \fI<value>\fR
+How the persona confirms information One of: EXPLICIT, VAGUE. Optional.
+.TP
+\fB\-\-memory\-reliability\fR \fI<value>\fR
+How reliable the persona's memory is One of: HIGH, LOW. Optional.
+.TP
+\fB\-\-response\-timing\fR \fI<value>\fR
+Controls how quickly the persona responds to pauses in conversation (QUICK, NORMAL, RELAXED) One of: RELAXED, NORMAL, QUICK. Optional.
+.TP
+\fB\-\-backstory\-prompt\fR \fI<value>\fR
+Background story and behavioral patterns for the persona Optional.
+.TP
+\fB\-\-idle\-messages\fR \fI<value>\fR
+Messages the persona will say when the agent goes silent during a call. Defaults to language\-appropriate phrases when omitted or sent as null. Repeatable. Optional.
+.TP
+\fB\-\-idle\-timeout\-seconds\fR \fI<value>\fR
+Seconds of silence before the persona sends an idle message Optional.
+.TP
+\fB\-\-idle\-message\-max\-spoken\-count\fR \fI<value>\fR
+Maximum number of idle messages the persona will send before giving up Optional.
+.TP
+\fB\-\-idle\-message\-reset\-count\-on\-user\-speech\-enabled\fR
+Whether the idle message counter resets when the agent speaks Optional.
+.TP
+\fB\-\-properties\fR \fI<value>\fR
+Additional custom properties about the persona 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 simulation persona create \-\-name <value> \-\-language <value> \-\-accent <value> \-\-gender <value>
+.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-persona-get.1

@@ -0,0 +1,93 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-PERSONA\-GET" "1" "" "roark-simulation-persona-get" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-persona\-get \- Get persona by ID
+.SH "SYNOPSIS"
+.B roark simulation persona get
+\fIpersona\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Returns a specific persona by its ID.
+.SH "API"
+GET /v1/persona/{personaId}
+.SH "ARGUMENTS"
+.TP
+\fIpersona\-id\fR
+The ID of the persona to retrieve
+.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 persona get <persona\-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-persona-list.1

@@ -0,0 +1,99 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-PERSONA\-LIST" "1" "" "roark-simulation-persona-list" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-persona\-list \- List personas
+.SH "SYNOPSIS"
+.B roark simulation persona list
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Returns a paginated list of personas for the authenticated project.
+.SH "API"
+GET /v1/persona
+.SH "OPTIONS"
+.TP
+\fB\-\-limit\fR \fI<value>\fR
+Optional.
+.TP
+\fB\-\-after\fR \fI<value>\fR
+Optional.
+.TP
+\fB\-\-search\-text\fR \fI<value>\fR
+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 simulation persona 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)