Skip to main content

ish study list

List studies for a workspace Usage: ish study list [options]

Options

--workspace <id>
string
Workspace ID

ish study generate

Generate a study from a problem description using AI Usage: ish study generate [options]

Options

--workspace <id>
string
Workspace ID
--problem <description>
string
Problem description (what you want to understand) Required.
--target-url <url>
string
URL of the product to test

ish study get

Get the full study payload - iterations (with run details), assignments, interview questions, sentiment + status counts. Accepts multiple IDs for batched lookup. NOTE: this is the full payload, not a roll-up - for a compact cross-study comparison view use study results &lt;id&gt; --summary. Usage: ish study get <ids>... [options]

Arguments

ids
Study 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 study update

Update a study Usage: ish study update <id> [options]

Arguments

id
Study ID (required)

Options

--name <name>
string
Study name
--description <description>
string
Study description
--status <status>
string
Study status (draft, running, completed)
--modality <modality>
string
Study modality (interactive, video, audio, text, image, document, chat)
--content-type <type>
string
Content type
--assignment <name:instructions>
string
Replace all assignments with these (repeatable) Default: [].
--assignments-file <path>
string
JSON file with assignments array
--assignments <json>
string
Inline JSON array of assignments (escape hatch)
--question <text>
string
Replace the questionnaire with these text questions (repeatable) Default: [].
--questionnaire <json|@file|path>
string
Replace the questionnaire from inline JSON, @file, or a JSON file path (full InterviewQuestion shape)
--workspace <id>
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish study delete

Delete a study Usage: ish study delete <id> [options]

Arguments

id
Study ID (required)

Options

--workspace <id>
string
Workspace ID; accepted for consistency (workspace is inferred from the study)
-y, --yes
boolean
Skip confirmation prompt (required in —json or non-TTY contexts)

ish study use

Set the active study (saved to ~/.ish/config.json) Usage: ish study use [id] [options]

Arguments

id
Study alias or UUID (optional)

Options

--clear
boolean
Remove the active study from config
--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)