Skip to main content

ish iteration list

List iterations for a study Usage: ish iteration list [options]

Options

--study <id>
string
Study ID
--workspace <id>
string
Workspace ID; accepted for consistency (workspace is inferred from the study)

ish iteration create

Create a new iteration with run-time content/URL Usage: ish iteration create [options]

Options

--study <id>
string
Study ID (or set via ish study use)
--workspace <id>
string
Workspace ID; accepted for consistency (workspace is inferred from the study)
--name <name>
string
Iteration name (defaults to the next position letter A/B/C… if omitted)
--description <description>
string
Iteration description
--platform <platform>
string
Platform (browser, android, ios, figma, code) - interactive only
--url <url>
string
URL to test - interactive only (optional for ios/android native apps)
--app <id>
string
Native app bundle id (or .app/.apk path) - ios/android; supplies the iteration target so —url isn’t required
--screen-format <format>
string
Screen format (mobile_portrait, desktop) - interactive only; hyphen/underscore variants accepted. Default: desktop, or mobile_portrait for native ios/android
--locale <locale>
string
Locale code (e.g. en-US) - interactive only
--file-key <key>
string
Figma file key - required when —platform=figma
--start-node-id <id>
string
Figma start node id - required when —platform=figma
--flow-name <name>
string
Figma flow name - interactive only
--content-text <text>
string
Text content to evaluate, or @filepath to read from file - text modality
--content-html <html>
string
HTML version of the text, or @filepath to read from file - text modality
--sender-name <name>
string
Email ‘From’ display name - text modality (email rendering)
--sender-email <email>
string
Email sender address - text modality (email rendering)
Hero image URL - text modality (email rendering)
--content-url <url>
string
URL or local file path to media file - video, audio, document modalities
--image-urls <urls>
string
Comma-separated image URLs or local file paths - image modality
--title <title>
string
Content title shown to participants (the leading headline they read) - media modalities
--mime-type <type>
string
MIME type (e.g. video/mp4) - media modalities
--copy-text <text>
string
Ad copy or social post caption (or @filepath) - ads & social posts
--copy-html <html>
string
HTML version of copy text (or @filepath)
--social-platform <platform>
string
Social platform (instagram, tiktok, facebook, linkedin, x)
--copy-position <pos>
string
Copy position relative to media (before, after) Default: “after”.
--segmentation-json <json>
string
Segmentation JSON - time_based {intervals_seconds, labels?}, section_based {sections[{name,label,…}]}, or page_based {} - media modalities. section_based sections are SEMANTIC: group related paragraphs into a few coherent sections (a long article is usually 3-6 sections, not one per paragraph; paragraph_start/end just mark where each section begins and ends).
--content-config-json <json>
string
Content config JSON - {early_termination, selected_segment_indices?} - media modalities
--chat-mode <mode>
string
Chat mode: external_chatbot (default; probe a customer chatbot) or participant_pair (two AI people talk to each other)
--chat-endpoint-id <id>
string
Saved chatbot endpoint id - chat modality, external_chatbot mode (legacy; prefer —endpoint)
--chat-endpoint-json <json>
string
Inline chatbot endpoint config JSON - chat modality, external_chatbot mode (legacy; prefer —endpoint-config)
--max-turns <n>
string
Max participant turns (1-50) - chat modality (default 12)
--early-termination
boolean
End the chat session early when the participant signals stop - chat modality
--endpoint <id>
string
Saved chatbot endpoint id (alias or UUID) - chat modality, external_chatbot mode
--endpoint-config <file>
string
Raw ChatbotEndpointConfig JSON file or - for stdin - chat modality, external_chatbot mode
--group-a <ids>
string
Person IDs/aliases for side A (comma-separated or repeatable). Pass a single person and N on —group-b to broadcast (1×N rehearsal: fix side A, vary side B) - chat participant_pair mode Default: [].
--group-b <ids>
string
Person IDs/aliases for side B (comma-separated or repeatable). When both sides are explicit they must be equal length, BUT if either side is a singleton it’s auto-broadcast to match the other (1×N rehearsal) - chat participant_pair mode Default: [].
--scenario-a <text-or-@file>
string
Side-A scenario + goal text, or @filepath - chat participant_pair mode
--scenario-b <text-or-@file>
string
Side-B scenario + goal text, or @filepath - chat participant_pair mode
--initiator-side <a|b>
string
Which side speaks first (default: a) - chat participant_pair mode
--role-criteria-a <json-or-@file>
string
RoleCriteria filter for side A (inline JSON or @filepath). Keys: occupation[], min_age, max_age, gender[], country[], education_level_in[], household_in[], locale_type_in[], income_level_in[], employment_status_in[], requires_captions, uses_screen_reader, prefers_reduced_motion, prefers_high_contrast, has_any_accessibility_need. The five *_in arrays accept snake_case spec values; the five accessibility filters are booleans. Persona-first: filters the eligible profile pool without altering personas. Use INSTEAD of —group-a or alongside it (criteria then validates the explicit list). chat participant_pair mode.
--role-criteria-b <json-or-@file>
string
RoleCriteria filter for side B - same shape as —role-criteria-a. chat participant_pair mode.
--details-json <json>
string
Raw iteration details JSON (overrides individual flags)

ish iteration get

Get iteration details (accepts multiple IDs for batched lookup) Usage: ish iteration get <ids>... [options]

Arguments

ids
Iteration ID(s) - one or more aliases/UUIDs (space- or comma-separated) (required, variadic)

Options

--workspace <id>
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish iteration update

Update an iteration Usage: ish iteration update <id> [options]

Arguments

id
Iteration ID (required)

Options

--name <name>
string
Iteration name
--description <description>
string
Iteration description
--details-json <json>
string
Iteration details as JSON string
--label <label>
string
Iteration label (uppercase letters)
--workspace <id>
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish iteration delete

Delete an iteration Usage: ish iteration delete <id> [options]

Arguments

id
Iteration ID (required)

Options

-y, --yes
boolean
Skip confirmation prompt (required in —json / non-TTY)
--workspace <id>
string
Workspace ID; accepted for consistency (inferred from alias / active context)

Global flags

Every command accepts the global flags.
-V, --version
boolean
output the version number
-t, --token <token>
string
Auth token (or set ISH_TOKEN env var)
--token-file <path>
string
Read auth token from a file (preferred over —token / ISH_TOKEN)
--workspace <id>
string
Default workspace ID; per-subcommand —workspace overrides
--json
boolean
Output as JSON (auto-enabled when piped)
--get <field>
string
Extract a single field from the JSON response and print only its value (implies —json internally; supports dotted paths e.g. person.name)
--human
boolean
Force human-readable output even when stdout is piped (overrides JSON-when-piped auto-detection)
--fields <fields>
string
Comma-separated fields to include in JSON output (e.g. alias,name,status)
--verbose
boolean
Include full UUIDs and timestamps in JSON output
--no-color
boolean
Disable colored output (also honored: NO_COLOR env var)
-q, --quiet
boolean
Suppress progress messages on stderr (no-op for read commands that emit none)