@roarkanalytics/cli 0.1.0

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

@@ -0,0 +1,160 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-PERSONA\-UPDATE" "1" "" "roark-simulation-persona-update" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-persona\-update \- Update a persona
+.SH "SYNOPSIS"
+.B roark simulation persona update
+\fIpersona\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Updates an existing persona by its ID.
+.SH "API"
+PUT /v1/persona/{personaId}
+.SH "ARGUMENTS"
+.TP
+\fIpersona\-id\fR
+The ID of the persona to update
+.SH "OPTIONS"
+.TP
+\fB\-\-name\fR \fI<value>\fR
+The name the agent will identify as during conversations Optional.
+.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. Optional.
+.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. Multilingual combinations are limited by multilingual speech recognition support. 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. Optional.
+.TP
+\fB\-\-gender\fR \fI<value>\fR
+Gender of the persona One of: MALE, FEMALE. Optional.
+.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. null = "Automatic": language\-appropriate defaults are used at call time. 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 update <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-plan-create.1

@@ -0,0 +1,138 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-PLAN\-CREATE" "1" "" "roark-simulation-plan-create" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-plan\-create \- Create a run plan
+.SH "SYNOPSIS"
+.B roark simulation plan create
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Creates a new simulation run plan. To run a simulation, use POST /v1/simulation/run instead: it starts a run from a plan or from an inline configuration, and takes runtime variables. Create a plan here when you want a reusable, named one to run later.
+.SH "API"
+POST /v1/simulation/plan
+.SH "OPTIONS"
+.TP
+\fB\-\-name\fR \fI<value>\fR
+Name of the run plan Required.
+.TP
+\fB\-\-description\fR \fI<value>\fR
+Description of the run plan Optional.
+.TP
+\fB\-\-direction\fR \fI<value>\fR
+Direction of the simulation (INBOUND or OUTBOUND) One of: INBOUND, OUTBOUND. Required.
+.TP
+\fB\-\-iteration\-count\fR \fI<value>\fR
+Number of iterations to run for each test case (1\-10000) Optional.
+.TP
+\fB\-\-max\-concurrent\-jobs\fR \fI<value>\fR
+Maximum number of concurrent simulation jobs Optional.
+.TP
+\fB\-\-max\-simulation\-duration\-seconds\fR \fI<value>\fR
+Maximum duration in seconds for each simulation Required.
+.TP
+\fB\-\-silence\-timeout\-seconds\fR \fI<value>\fR
+Timeout in seconds for silence detection Optional.
+.TP
+\fB\-\-end\-call\-phrases\fR \fI<value>\fR
+Phrases that trigger end of call. Empty array disables the feature. Repeatable. Optional.
+.TP
+\fB\-\-end\-call\-reasons\fR \fI<value>\fR
+Semantic conditions that trigger end of call. The LLM evaluates the conversation against these conditions. Empty array disables the feature. Repeatable. Optional.
+.TP
+\fB\-\-execution\-mode\fR \fI<value>\fR
+Execution mode (PARALLEL or SEQUENTIAL) One of: PARALLEL, SEQUENTIAL_SAME_RUN_PLAN, SEQUENTIAL_PROJECT. Optional.
+.TP
+\fB\-\-scenarios\fR \fI<value>\fR
+Deprecated: use `flows` instead. Scenarios to include in this run plan. The same scenario ID can appear multiple times with different variables. Optional.
+.TP
+\fB\-\-flows\fR \fI<value>\fR
+Customer flows to include in this run plan. The same flow can appear more than once with a different persona override or different variables. Optional.
+.TP
+\fB\-\-personas\fR \fI<value>\fR
+Personas to include in this run plan. Required with `scenarios`; ignored with `flows`, where each variant carries its own persona. Optional.
+.TP
+\fB\-\-agent\-endpoints\fR \fI<value>\fR
+Agent endpoints to include in this run plan Required.
+.TP
+\fB\-\-metrics\fR \fI<value>\fR
+Metric definitions to include in this run plan. Reference each by `id` (UUID) or `slug`. Required.
+.TP
+\fB\-\-auto\-run\fR
+Deprecated: use POST /v1/simulation/run, which starts a run and accepts runtime `variables` as well. This flag runs the plan with only the values pinned on it. 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 plan create \-\-name <value> \-\-direction <value> \-\-max\-simulation\-duration\-seconds <value> \-\-agent\-endpoints <value> \-\-metrics <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-plan-delete.1

@@ -0,0 +1,93 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-PLAN\-DELETE" "1" "" "roark-simulation-plan-delete" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-plan\-delete \- Delete a run plan
+.SH "SYNOPSIS"
+.B roark simulation plan delete
+\fIplan\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Soft\-deletes a simulation run plan by its ID.
+.SH "API"
+DELETE /v1/simulation/plan/{planId}
+.SH "ARGUMENTS"
+.TP
+\fIplan\-id\fR
+The ID of the run plan to delete
+.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 plan delete <plan\-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-get.1

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

@@ -0,0 +1,93 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-PLAN\-JOB\-GET" "1" "" "roark-simulation-plan-job-get" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-plan\-job\-get \- Get simulation plan job
+.SH "SYNOPSIS"
+.B roark simulation plan job get
+\fIjob\-id\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+Retrieve details of a simulation plan job including all associated simulation jobs (calls)
+.SH "API"
+GET /v1/simulation/plan/job/{jobId}
+.SH "ARGUMENTS"
+.TP
+\fIjob\-id\fR
+Simulation run plan 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 plan 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-plan-job-list.1

@@ -0,0 +1,108 @@
+.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
+.TH "ROARK\-SIMULATION\-PLAN\-JOB\-LIST" "1" "" "roark-simulation-plan-job-list" "Roark Analytics API Manual"
+.SH "NAME"
+roark\-simulation\-plan\-job\-list \- List simulation plan jobs
+.SH "SYNOPSIS"
+.B roark simulation plan job list
+[\fIoptions\fR]
+.SH "DESCRIPTION"
+Returns a paginated list of simulation run plan jobs. Filter by status, plan ID, or label to find specific simulation batches.
+.SH "API"
+GET /v1/simulation/plan/jobs
+.SH "OPTIONS"
+.TP
+\fB\-\-limit\fR \fI<value>\fR
+Maximum number of plan jobs to return (default: 20, max: 50) Optional.
+.TP
+\fB\-\-after\fR \fI<value>\fR
+Cursor for pagination \- use the nextCursor value from a previous response Optional.
+.TP
+\fB\-\-status\fR \fI<value>\fR
+Filter by plan job status (PENDING, QUEUED, CREATING_SNAPSHOTS, CREATING_SIMULATIONS, PREPARING_CAPACITY, RUNNING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING, ENDING_SIMULATIONS) One of: PENDING, QUEUED, CREATING_SNAPSHOTS, CREATING_SIMULATIONS, PREPARING_CAPACITY, RUNNING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING, ENDING_SIMULATIONS. Optional.
+.TP
+\fB\-\-simulation\-run\-plan\-id\fR \fI<value>\fR
+Filter by simulation run plan ID Optional.
+.TP
+\fB\-\-label\-id\fR \fI<value>\fR
+Filter by label ID attached to the plan job. Use this if you know the label ID. Optional.
+.TP
+\fB\-\-label\-name\fR \fI<value>\fR
+Filter by label name attached to the plan job. More user\-friendly alternative to labelId. Case\-insensitive. 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 plan job 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)