ish study participant
Inspect or manage participants (low-level; usually created via study run)
Usage: ish study participant [id] [options]
Arguments
Participant ID - pass directly to view participant details and results (optional)
Options
string
Workspace ID; accepted for consistency (workspace is inferred from the participant)
boolean
Lean projection: alias + status + sentiment + comment + error_message. Drops the action timeline / interactions array.
ish study participant create
Create a participant (low-level)
Usage: ish study participant create [options]
Options
string
Iteration ID (or use —study to pick the latest iteration on a study)
string
Study ID; resolves to the latest iteration on that study (alternative to —iteration)
string
Participant profile ID Required.
string
Language code (e.g. en, sv)
string
Platform (browser, android, ios, figma, code)
string
Participant type (ai, human) Default: “ai”.
string
Workspace ID; accepted for consistency (inferred from alias / active context)
ish study participant batch-create
Create multiple participants (low-level)
Usage: ish study participant batch-create [options]
Options
string
Iteration ID Required.
string
JSON file with participants array (alternative to —persons)
string
Comma-separated profile IDs/aliases; shortcut for —file with one participant per profile (mutually exclusive with —file)
string
Workspace ID; accepted for consistency (inferred from alias / active context)
ish study participant delete
Delete a participant
Usage: ish study participant delete <id> [options]
Arguments
Participant ID (required)
Options
string
Workspace ID; accepted for consistency (inferred from alias / active context)
ish study analyze
Trigger an AI summary + key-insights analysis for a study. First analysis per study is included; subsequent runs draw 10 credits.
Usage: ish study analyze [id] [options]
Arguments
Study ID (defaults to active study) (optional)
Options
string
Workspace ID; accepted for consistency (workspace is inferred from the study)
boolean
Poll until the run reaches completed or failed
string
Wait timeout in seconds (default 300; only with —wait)
boolean
Skip the credit-spend confirmation (required in —json / non-TTY to proceed)
ish study insights
Read AI-generated insights from prior ish study analyze runs (newest first).
Usage: ish study insights [id] [options]
Arguments
Study ID (defaults to active study) (optional)
Options
string
Workspace ID; accepted for consistency (workspace is inferred from the study)
boolean
Show every prior run as a compact table (default: latest only)
string
Fetch a specific result by id rather than the latest
ish study screenshots
List or download screenshots produced by an interactive study run.
Usage: ish study screenshots
ish study screenshots list
List screenshots for a study (frame-grouped).
Usage: ish study screenshots list [id] [options]
Arguments
Study ID (defaults to active study) (optional)
Options
string
Workspace ID; accepted for consistency (workspace is inferred from the study)
ish study screenshots download
Download screenshot bytes to disk. Pass —id for one, or —all for every screenshot on the study.
Usage: ish study screenshots download [id] [options]
Arguments
Study ID (defaults to active study) (optional)
Options
string
Workspace ID; accepted for consistency (workspace is inferred from the study)
string
Single screenshot ID (mutually exclusive with —all).
boolean
Download every screenshot on the study into —out (treated as a directory).
string
Output path. With —id: a file path (defaults to ./<screenshot-id>.<ext>). With —all: a directory (defaults to ./screenshots/).
ish study share
Create a public, no-login link to a study’s results (summary, frames, journeys, segments). Anyone with the link can view it - share with prospects.
Usage: ish study share [id] [options]
Arguments
Study ID (defaults to active study) (optional)
Options
string
Workspace ID; accepted for consistency (workspace is inferred from the study)
string
Link expires after N days (default: never)
boolean
List all your study share links instead of creating one
ish study unshare
Revoke a study share link by its token. The public URL stops working immediately.
Usage: ish study unshare <token> [options]
Arguments
Share link token (from
ish study share or ish study share --list) (required)Options
string
Workspace ID; accepted for consistency
boolean
Skip the confirmation prompt
Global flags
Every command accepts the global flags.boolean
output the version number
string
Auth token (or set ISH_TOKEN env var)
string
Read auth token from a file (preferred over —token / ISH_TOKEN)
string
Default workspace ID; per-subcommand —workspace overrides
boolean
Output as JSON (auto-enabled when piped)
string
Extract a single field from the JSON response and print only its value (implies —json internally; supports dotted paths e.g. person.name)
boolean
Force human-readable output even when stdout is piped (overrides JSON-when-piped auto-detection)
string
Comma-separated fields to include in JSON output (e.g. alias,name,status)
boolean
Include full UUIDs and timestamps in JSON output
boolean
Disable colored output (also honored: NO_COLOR env var)
boolean
Suppress progress messages on stderr (no-op for read commands that emit none)